capnweb 0.0.0-32e381c → 0.0.0-3447dde
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +33 -33
- package/dist/index-bun.cjs +265 -104
- package/dist/index-bun.cjs.map +1 -1
- package/dist/index-bun.d.cts +55 -32
- package/dist/index-bun.d.ts +55 -32
- package/dist/index-bun.js +265 -103
- package/dist/index-bun.js.map +1 -1
- package/dist/index-workers.cjs +266 -104
- package/dist/index-workers.cjs.map +1 -1
- package/dist/index-workers.d.cts +51 -31
- package/dist/index-workers.d.ts +51 -31
- package/dist/index-workers.js +265 -103
- package/dist/index-workers.js.map +1 -1
- package/dist/index.cjs +265 -104
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +51 -31
- package/dist/index.d.ts +51 -31
- package/dist/index.js +265 -103
- package/dist/index.js.map +1 -1
- package/package.json +21 -26
package/README.md
CHANGED
|
@@ -45,7 +45,7 @@ import { RpcTarget, newWebSocketRpcSession } from "capnweb";
|
|
|
45
45
|
```
|
|
46
46
|
|
|
47
47
|
To use `using` declarations, your `tsconfig.json` needs `"target": "esnext"` and matching `lib`s.
|
|
48
|
-
See [Installation](packages/docs/src/content/docs/start/installation.
|
|
48
|
+
See [Installation](packages/docs/src/content/docs/start/installation.mdx).
|
|
49
49
|
|
|
50
50
|
## Example
|
|
51
51
|
|
|
@@ -114,49 +114,49 @@ under [`packages/docs/`](packages/docs/), and every page is readable as Markdown
|
|
|
114
114
|
|
|
115
115
|
Start here:
|
|
116
116
|
|
|
117
|
-
| Page
|
|
118
|
-
|
|
|
119
|
-
| [Introduction](packages/docs/src/content/docs/start/introduction.
|
|
120
|
-
| [Quickstart](packages/docs/src/content/docs/start/quickstart.
|
|
121
|
-
| [Pipelining tour](packages/docs/src/content/docs/start/pipelining-tour.
|
|
122
|
-
| [How it compares](packages/docs/src/content/docs/guides/comparisons.
|
|
117
|
+
| Page | What it covers |
|
|
118
|
+
| --------------------------------------------------------------------------- | ---------------------------------------------------- |
|
|
119
|
+
| [Introduction](packages/docs/src/content/docs/start/introduction.mdx) | What Cap'n Web is and why object capabilities matter |
|
|
120
|
+
| [Quickstart](packages/docs/src/content/docs/start/quickstart.mdx) | A working client and server |
|
|
121
|
+
| [Pipelining tour](packages/docs/src/content/docs/start/pipelining-tour.mdx) | The part that makes it fast |
|
|
122
|
+
| [How it compares](packages/docs/src/content/docs/guides/comparisons.mdx) | Against tRPC, JSON-RPC, GraphQL and Cap'n Proto |
|
|
123
123
|
|
|
124
124
|
Core concepts:
|
|
125
|
-
[What can be passed](packages/docs/src/content/docs/concepts/values.
|
|
126
|
-
[RpcTarget](packages/docs/src/content/docs/concepts/rpc-target.
|
|
127
|
-
[RpcStub](packages/docs/src/content/docs/concepts/stubs.
|
|
128
|
-
[RpcPromise & pipelining](packages/docs/src/content/docs/concepts/promises.
|
|
129
|
-
[The magic `map()`](packages/docs/src/content/docs/concepts/map.
|
|
130
|
-
[Streaming](packages/docs/src/content/docs/concepts/streaming.
|
|
131
|
-
[Disposal](packages/docs/src/content/docs/concepts/disposal.
|
|
125
|
+
[What can be passed](packages/docs/src/content/docs/concepts/values.mdx) ·
|
|
126
|
+
[RpcTarget](packages/docs/src/content/docs/concepts/rpc-target.mdx) ·
|
|
127
|
+
[RpcStub](packages/docs/src/content/docs/concepts/stubs.mdx) ·
|
|
128
|
+
[RpcPromise & pipelining](packages/docs/src/content/docs/concepts/promises.mdx) ·
|
|
129
|
+
[The magic `map()`](packages/docs/src/content/docs/concepts/map.mdx) ·
|
|
130
|
+
[Streaming](packages/docs/src/content/docs/concepts/streaming.mdx) ·
|
|
131
|
+
[Disposal](packages/docs/src/content/docs/concepts/disposal.mdx)
|
|
132
132
|
|
|
133
133
|
Transports:
|
|
134
|
-
[Overview](packages/docs/src/content/docs/transports/index.
|
|
135
|
-
[HTTP batch](packages/docs/src/content/docs/transports/http-batch.
|
|
136
|
-
[WebSocket](packages/docs/src/content/docs/transports/websocket.
|
|
137
|
-
[MessagePort](packages/docs/src/content/docs/transports/message-port.
|
|
138
|
-
[Custom](packages/docs/src/content/docs/transports/custom.
|
|
134
|
+
[Overview](packages/docs/src/content/docs/transports/index.mdx) ·
|
|
135
|
+
[HTTP batch](packages/docs/src/content/docs/transports/http-batch.mdx) ·
|
|
136
|
+
[WebSocket](packages/docs/src/content/docs/transports/websocket.mdx) ·
|
|
137
|
+
[MessagePort](packages/docs/src/content/docs/transports/message-port.mdx) ·
|
|
138
|
+
[Custom](packages/docs/src/content/docs/transports/custom.mdx)
|
|
139
139
|
|
|
140
140
|
Server runtimes:
|
|
141
|
-
[Cloudflare Workers](packages/docs/src/content/docs/servers/workers.
|
|
142
|
-
[Node.js](packages/docs/src/content/docs/servers/node.
|
|
143
|
-
[Deno](packages/docs/src/content/docs/servers/deno.
|
|
144
|
-
[Bun](packages/docs/src/content/docs/servers/bun.
|
|
145
|
-
[Hono](packages/docs/src/content/docs/servers/hono.
|
|
146
|
-
[Other](packages/docs/src/content/docs/servers/other.
|
|
141
|
+
[Cloudflare Workers](packages/docs/src/content/docs/servers/workers.mdx) ·
|
|
142
|
+
[Node.js](packages/docs/src/content/docs/servers/node.mdx) ·
|
|
143
|
+
[Deno](packages/docs/src/content/docs/servers/deno.mdx) ·
|
|
144
|
+
[Bun](packages/docs/src/content/docs/servers/bun.mdx) ·
|
|
145
|
+
[Hono](packages/docs/src/content/docs/servers/hono.mdx) ·
|
|
146
|
+
[Other](packages/docs/src/content/docs/servers/other.mdx)
|
|
147
147
|
|
|
148
148
|
Guides and reference:
|
|
149
|
-
[Security considerations](packages/docs/src/content/docs/guides/security.
|
|
150
|
-
[Sessions & reconnection](packages/docs/src/content/docs/guides/sessions.
|
|
151
|
-
[Runtime validation](packages/docs/src/content/docs/guides/validation.
|
|
152
|
-
[Workers RPC interop](packages/docs/src/content/docs/guides/workers-rpc.
|
|
153
|
-
[Wire protocol](packages/docs/src/content/docs/reference/protocol.
|
|
154
|
-
[API cheat sheet](packages/docs/src/content/docs/reference/api.
|
|
149
|
+
[Security considerations](packages/docs/src/content/docs/guides/security.mdx) ·
|
|
150
|
+
[Sessions & reconnection](packages/docs/src/content/docs/guides/sessions.mdx) ·
|
|
151
|
+
[Runtime validation](packages/docs/src/content/docs/guides/validation.mdx) ·
|
|
152
|
+
[Workers RPC interop](packages/docs/src/content/docs/guides/workers-rpc.mdx) ·
|
|
153
|
+
[Wire protocol](packages/docs/src/content/docs/reference/protocol.mdx) ·
|
|
154
|
+
[API cheat sheet](packages/docs/src/content/docs/reference/api.mdx)
|
|
155
155
|
|
|
156
156
|
To run the site locally, with both examples embedded as live in-browser playgrounds:
|
|
157
157
|
|
|
158
158
|
```sh
|
|
159
|
-
|
|
159
|
+
pnpm install && pnpm run dev:docs
|
|
160
160
|
```
|
|
161
161
|
|
|
162
162
|
## Examples
|
|
@@ -180,7 +180,7 @@ Runnable examples live in [`examples/`](examples/):
|
|
|
180
180
|
Cap'n Web gives you strong authorization tools, but a few things are your responsibility:
|
|
181
181
|
authenticating in-band rather than with cookies, rate-limiting because pipelining is cheap for
|
|
182
182
|
attackers, setting transport payload limits, and validating types at runtime. Read
|
|
183
|
-
[Security considerations](packages/docs/src/content/docs/guides/security.
|
|
183
|
+
[Security considerations](packages/docs/src/content/docs/guides/security.mdx) before exposing a
|
|
184
184
|
service to untrusted peers.
|
|
185
185
|
|
|
186
186
|
To report a vulnerability, see [SECURITY.md](SECURITY.md).
|