Skip to content

document rpcTransport #188

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 2, 2022
Merged

document rpcTransport #188

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 21 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -206,11 +206,12 @@ Clients can be configured globally, at the RPC callsite, or with [middleware](ht

##### Configuration Options

| Name | Description | Type | Example |
| ------- | -------------------------------------------------------------------------------------- | ---------------------- | ---------------------------- |
| baseURL | The base URL for the RPC. The service path will be appended to this string. | string | "https://my.server.com/" |
| headers | HTTP headers to include in the RPC. | Record<string, string> | { "idempotency-key": "foo" } |
| prefix | A path prefix such as "/my/custom/prefix". Defaults to "/twirp", but can be set to "". | string | "/my/custom/prefix" |
| Name | Description | Type | Example |
| ------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------- | ---------------------------- |
| baseURL | The base URL for the RPC. The service path will be appended to this string. | string | "https://my.server.com/" |
| headers | HTTP headers to include in the RPC. | Record<string, string> | { "idempotency-key": "foo" } |
| prefix | A path prefix such as "/my/custom/prefix". Defaults to "/twirp", but can be set to "". | string | "/my/custom/prefix" |
| rpcTransport | The transport to use for the RPC. Defaults to `fetch`. Overrides must conform to a subset of the fetch interface defined by the `RpcTransport` type. | `RpcTransport` | `fetch` |

##### Example

Expand Down Expand Up @@ -271,6 +272,21 @@ const hat = await MakeHat(
console.log(hat);
```

##### rpcTransport

Twirp abstracts many network details from clients. Sometimes you will want more control over the underlying network request. For these cases, TwirpScript exposes `rpcTransport`.

`rpcTransport` can be used to customize the `fetch` request made. For example, setting `fetch`'s [credentials](https://developer.mozilla.org/en-US/docs/Web/API/fetch#credentials) option to include (which will include cookies in cross origin requests):

```ts
import { client } from "twirpscript";

client.rpcTransport = (url, opts) =>
fetch(url, { ...opts, credentials: "include" });
```

`rpcTransport` could also be used to replace `fetch` use entirely with something like `axios` or an [https agent](https://nodejs.org/api/https.html#https_class_https_agent).

#### Server

Servers can be configured by passing a configuration object to `createTwirpServer`.
Expand Down