@connectrpc/connect-web
TypeScript icon, indicating that this package has built-in type declarations

1.4.0 • Public • Published

@connectrpc/connect-web

Connect is a family of libraries for building and consuming APIs on different languages and platforms. @connectrpc/connect brings type-safe APIs with Protobuf to TypeScript.

@connectrpc/connect-web provides the following adapters for web browsers, and any other platform that has the fetch API on board:

createConnectTransport()

Lets your clients running in the web browser talk to a server with the Connect protocol:

import { createPromiseClient } from "@connectrpc/connect";
+ import { createConnectTransport } from "@connectrpc/connect-web";
import { ElizaService } from "./gen/eliza_connect.js";

+ // A transport for clients using the Connect protocol with fetch()
+ const transport = createConnectTransport({
+   baseUrl: "https://demo.connectrpc.com",
+ });

const client = createPromiseClient(ElizaService, transport);
const { sentence } = await client.say({ sentence: "I feel happy." });
console.log(sentence) // you said: I feel happy.

createGrpcWebTransport()

Lets your clients running in the web browser talk to a server with the gRPC-web protocol:

import { createPromiseClient } from "@connectrpc/connect";
+ import { createGrpcWebTransport } from "@connectrpc/connect-web";
import { ElizaService } from "./gen/eliza_connect.js";

+ // A transport for clients using the Connect protocol with fetch()
+ const transport = createGrpcWebTransport({
+   baseUrl: "https://demo.connectrpc.com",
+ });

const client = createPromiseClient(ElizaService, transport);
const { sentence } = await client.say({ sentence: "I feel happy." });
console.log(sentence) // you said: I feel happy.

Getting started

To get started with Connect, head over to the docs for a tutorial, or take a look at our example.

Connect plays nice with Vue, Svelte, Remix, Next.js, Angular and many others. Take a look at our examples for various frameworks.

Readme

Keywords

none

Package Sidebar

Install

npm i @connectrpc/connect-web

Weekly Downloads

37,369

Version

1.4.0

License

Apache-2.0

Unpacked Size

62.3 kB

Total Files

19

Last publish

Collaborators

  • srikrsna-buf
  • psachs-buf
  • jchadwick-buf
  • dfyock-buf
  • tstamm-buf
  • jdailey_buf
  • sayers-buf