mirror of
https://github.com/getpaseo/paseo.git
synced 2026-11-03 15:12:48 +00:00
Mohamed Boudra
c689b5626e
Plugins can declare a subscription with defineSubscription, handle it with
server.handle(contract, (input, { push, signal })), and listen from a surface
with useSubscription or client.subscribe. A top-level Uint8Array in an event,
an RPC output, or an RPC input crosses the wire as a binary frame (opcodes
0x20-0x2f) without JSON or base64; a nested one fails validation on the sender.
Each subscriber runs its own handler, owned by the session that subscribed,
so release, disconnect, plugin stop and reload need no plugin code. The
runtime buffers pushes until the subscribe response has gone out, so a client
never sees an event for a subscription it does not know yet.
Gated on server_info.features.pluginSubscriptions; binary outputs reach only
clients that advertise plugin_binary_payloads.
15 lines
597 B
Markdown
15 lines
597 B
Markdown
# Diff watch plugin example
|
|
|
|
A workspace panel subscribes to a daemon-side watcher and lists the files that differ from `HEAD`,
|
|
updating as files change.
|
|
|
|
```bash
|
|
paseo plugin add /absolute/path/to/paseo/plugin-examples/diff-watch
|
|
```
|
|
|
|
- `shared/diff.ts` defines the `diff.watch` subscription contract.
|
|
- `index.server.ts` handles it: an async handler that loops until the subscriber leaves, pushing
|
|
the file list whenever it changes. A git failure rejects the handler and closes the subscription
|
|
with that error.
|
|
- `client/diff-panel.tsx` calls `useSubscription` and renders the latest list.
|