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 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.md).
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 | What it covers |
118
- | -------------------------------------------------------------------------- | ---------------------------------------------------- |
119
- | [Introduction](packages/docs/src/content/docs/start/introduction.md) | What Cap'n Web is and why object capabilities matter |
120
- | [Quickstart](packages/docs/src/content/docs/start/quickstart.md) | A working client and server |
121
- | [Pipelining tour](packages/docs/src/content/docs/start/pipelining-tour.md) | The part that makes it fast |
122
- | [How it compares](packages/docs/src/content/docs/guides/comparisons.md) | Against tRPC, JSON-RPC, GraphQL and Cap'n Proto |
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.md) ·
126
- [RpcTarget](packages/docs/src/content/docs/concepts/rpc-target.md) ·
127
- [RpcStub](packages/docs/src/content/docs/concepts/stubs.md) ·
128
- [RpcPromise & pipelining](packages/docs/src/content/docs/concepts/promises.md) ·
129
- [The magic `map()`](packages/docs/src/content/docs/concepts/map.md) ·
130
- [Streaming](packages/docs/src/content/docs/concepts/streaming.md) ·
131
- [Disposal](packages/docs/src/content/docs/concepts/disposal.md)
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.md) ·
135
- [HTTP batch](packages/docs/src/content/docs/transports/http-batch.md) ·
136
- [WebSocket](packages/docs/src/content/docs/transports/websocket.md) ·
137
- [MessagePort](packages/docs/src/content/docs/transports/message-port.md) ·
138
- [Custom](packages/docs/src/content/docs/transports/custom.md)
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.md) ·
142
- [Node.js](packages/docs/src/content/docs/servers/node.md) ·
143
- [Deno](packages/docs/src/content/docs/servers/deno.md) ·
144
- [Bun](packages/docs/src/content/docs/servers/bun.md) ·
145
- [Hono](packages/docs/src/content/docs/servers/hono.md) ·
146
- [Other](packages/docs/src/content/docs/servers/other.md)
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.md) ·
150
- [Sessions & reconnection](packages/docs/src/content/docs/guides/sessions.md) ·
151
- [Runtime validation](packages/docs/src/content/docs/guides/validation.md) ·
152
- [Workers RPC interop](packages/docs/src/content/docs/guides/workers-rpc.md) ·
153
- [Wire protocol](packages/docs/src/content/docs/reference/protocol.md) ·
154
- [API cheat sheet](packages/docs/src/content/docs/reference/api.md)
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
- cd packages/docs && npm install && npm run dev
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.md) before exposing a
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).