y-partykit v0.0.28
y-partykit
y-partykit
is an addon library for partykit
designed to host backends for Yjs, a high-performance library of data structures for building collaborative software.
Install
npm install y-partykit
Usage
You can set up a Yjs backend with just a few lines of code:
// server.ts
import { onConnect } from "y-partykit";
export default {
async onConnect(conn, room, context) {
return onConnect(conn, room);
}
};
You can pass additional options for more complex backends:
// server.ts
import { onConnect } from "y-partykit";
export default {
async onConnect(conn, room, context) {
return await onConnect(conn, room, {
// experimental: persist the document to partykit's room storage
persist: true,
// Or, you can load/save to your own database or storage
load() {
// load a document from a database, or some remote resource
// and return a Y.Doc instance here (or null if no document exists)
},
callback: {
async handler(yDoc) {
// called every few seconds after edits
// you can use this to write to a database
// or some external storage
},
// control how often handler is called with these options
debounceWait: 10000, // default: 2000 ms
debounceMaxWait: 20000, // default: 10000 ms
timeout: 5000 // default: 5000 ms
}
});
}
};
Then, use the provider to connect to this server from your client:
import YPartyKitProvider from "y-partykit/provider";
import * as Y from "yjs";
const yDoc = new Y.Doc();
const provider = new YPartyKitProvider(
"localhost:1999",
"my-document-name",
yDoc
);
You can add additional options to the provider:
// ...
const provider = new YPartyKitProvider(
"localhost:1999",
"my-document-name",
yDoc,
{
readOnly: false, // Only allow read access to the document (default: false)
connect: false, // don't connect immediately, use provider.connect() when required
params: { token: "my-secret-token" }, // adds to the query string of the websocket connection
awareness: new awarenessProtocol.Awareness(yDoc) // use your own Yjs awareness instance
}
);
If you're using react, then you can the hook version of the provider: useYPartyKitProvider
.
import useYProvider from "y-partykit/react";
function App() {
const provider = useYProvider({
host: "localhost:1999", // optional, defaults to window.location.host
room: "my-document-name",
doc: yDoc, // optional!
options
});
}
Refer to the official Yjs documentation for more information. Examples provided in the Yjs documentation should work seamlessly with y-partykit
(ensure to replace y-websocket
with y-partykit/provider
).
20 days ago
20 days ago
23 days ago
23 days ago
28 days ago
29 days ago
1 month ago
1 month ago
1 month ago
1 month ago
1 month ago
1 month ago
1 month ago
1 month ago
1 month ago
1 month ago
1 month ago
1 month ago
1 month ago
1 month ago
1 month ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
4 months ago
4 months ago
4 months ago
4 months ago
3 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
6 months ago
6 months ago
6 months ago
6 months ago
7 months ago
7 months ago
6 months ago
6 months ago
7 months ago
6 months ago
6 months ago
7 months ago
6 months ago
7 months ago
6 months ago
7 months ago
7 months ago
6 months ago
6 months ago
7 months ago
7 months ago
5 months ago
5 months ago
6 months ago
6 months ago
5 months ago
6 months ago
5 months ago
6 months ago
7 months ago
7 months ago
5 months ago
5 months ago
5 months ago
7 months ago
7 months ago
6 months ago
6 months ago
7 months ago
5 months ago
6 months ago
5 months ago
5 months ago
7 months ago
6 months ago
7 months ago
5 months ago
5 months ago
7 months ago
5 months ago
6 months ago
7 months ago
5 months ago
7 months ago
6 months ago
5 months ago
6 months ago
6 months ago
5 months ago
6 months ago
6 months ago
5 months ago
6 months ago
7 months ago
5 months ago
5 months ago
6 months ago
6 months ago
7 months ago
6 months ago
7 months ago
5 months ago
7 months ago
7 months ago
6 months ago
6 months ago
6 months ago
6 months ago
5 months ago
5 months ago
7 months ago
6 months ago
5 months ago
5 months ago
5 months ago
5 months ago
6 months ago
7 months ago
9 months ago
10 months ago
8 months ago
10 months ago
10 months ago
7 months ago
7 months ago
8 months ago
9 months ago
8 months ago
8 months ago
8 months ago
8 months ago
8 months ago
9 months ago
11 months ago
8 months ago
8 months ago
8 months ago
10 months ago
8 months ago
8 months ago
8 months ago
10 months ago
7 months ago
7 months ago
10 months ago
8 months ago
9 months ago
10 months ago
9 months ago
7 months ago
8 months ago
8 months ago
9 months ago
10 months ago
10 months ago
7 months ago
9 months ago
8 months ago
7 months ago
8 months ago
9 months ago
10 months ago
9 months ago
8 months ago
8 months ago
8 months ago
10 months ago
7 months ago
8 months ago
8 months ago
7 months ago
10 months ago
9 months ago
7 months ago
9 months ago
8 months ago
8 months ago
7 months ago
8 months ago
8 months ago
9 months ago
8 months ago
10 months ago
7 months ago
8 months ago
8 months ago
8 months ago
9 months ago
8 months ago
9 months ago
8 months ago
8 months ago
8 months ago
7 months ago
7 months ago
7 months ago
8 months ago
10 months ago
9 months ago
8 months ago
8 months ago
9 months ago
8 months ago
8 months ago
8 months ago
11 months ago
8 months ago
10 months ago
8 months ago
10 months ago
8 months ago
10 months ago
8 months ago
8 months ago
11 months ago
7 months ago
8 months ago
8 months ago
8 months ago
9 months ago
8 months ago
8 months ago
8 months ago
8 months ago
10 months ago
8 months ago
8 months ago
7 months ago
10 months ago
7 months ago
8 months ago
9 months ago
9 months ago
11 months ago
7 months ago
10 months ago
11 months ago
8 months ago
7 months ago
7 months ago
10 months ago
9 months ago
7 months ago
8 months ago
9 months ago
8 months ago
8 months ago
9 months ago
8 months ago
8 months ago
8 months ago
8 months ago
9 months ago
10 months ago
9 months ago
9 months ago
8 months ago
10 months ago
10 months ago
8 months ago
10 months ago
9 months ago
9 months ago
9 months ago
8 months ago
9 months ago
9 months ago
10 months ago
8 months ago
8 months ago
12 months ago
9 months ago
7 months ago
10 months ago
8 months ago
9 months ago
8 months ago
8 months ago
10 months ago
8 months ago
8 months ago
8 months ago
8 months ago
7 months ago
8 months ago
8 months ago
7 months ago
8 months ago
8 months ago
9 months ago
10 months ago
8 months ago
8 months ago
8 months ago
8 months ago
9 months ago
8 months ago
7 months ago
8 months ago
7 months ago
8 months ago
7 months ago
9 months ago
10 months ago
8 months ago
8 months ago
8 months ago
7 months ago
11 months ago
8 months ago
10 months ago
7 months ago
8 months ago
8 months ago
7 months ago
8 months ago
8 months ago
8 months ago
8 months ago
8 months ago
11 months ago
7 months ago
7 months ago
8 months ago
8 months ago
9 months ago
9 months ago
10 months ago
8 months ago
8 months ago
8 months ago
8 months ago
10 months ago
8 months ago
9 months ago
10 months ago
8 months ago
8 months ago
8 months ago
11 months ago
8 months ago
9 months ago
8 months ago
9 months ago
10 months ago
8 months ago
9 months ago
9 months ago
10 months ago
8 months ago
8 months ago
8 months ago
8 months ago
10 months ago
8 months ago
8 months ago
8 months ago
7 months ago
7 months ago
10 months ago
7 months ago
8 months ago
7 months ago
10 months ago
8 months ago
8 months ago
8 months ago
8 months ago
9 months ago
8 months ago
8 months ago
9 months ago
7 months ago
7 months ago
7 months ago
7 months ago
8 months ago
8 months ago
8 months ago
9 months ago
7 months ago
8 months ago
8 months ago
8 months ago
7 months ago
8 months ago
10 months ago
9 months ago
8 months ago
8 months ago
8 months ago
8 months ago
8 months ago
8 months ago
10 months ago
8 months ago
8 months ago
8 months ago
9 months ago
8 months ago
8 months ago
8 months ago
7 months ago
8 months ago
8 months ago
8 months ago
8 months ago
9 months ago
9 months ago
10 months ago
8 months ago
8 months ago
9 months ago
8 months ago
8 months ago
8 months ago
8 months ago
8 months ago
7 months ago
8 months ago
8 months ago
9 months ago
10 months ago
7 months ago
8 months ago
9 months ago
7 months ago
9 months ago
8 months ago
8 months ago
9 months ago
7 months ago
8 months ago
9 months ago
9 months ago
10 months ago
8 months ago
8 months ago
10 months ago
10 months ago
10 months ago
9 months ago
9 months ago
9 months ago
10 months ago
8 months ago
9 months ago
9 months ago
11 months ago
8 months ago
9 months ago
7 months ago
10 months ago
8 months ago
8 months ago
8 months ago
8 months ago
9 months ago
10 months ago
8 months ago
8 months ago
11 months ago
10 months ago
10 months ago
9 months ago
9 months ago
8 months ago
9 months ago
8 months ago
11 months ago
7 months ago
8 months ago
9 months ago
9 months ago
10 months ago
8 months ago
10 months ago
9 months ago
8 months ago
7 months ago
9 months ago
8 months ago
8 months ago
8 months ago
9 months ago
9 months ago
7 months ago
8 months ago
8 months ago
8 months ago
9 months ago
8 months ago
8 months ago
9 months ago
10 months ago
7 months ago
9 months ago
8 months ago
8 months ago
9 months ago
8 months ago
10 months ago
7 months ago
7 months ago
7 months ago
8 months ago
7 months ago
8 months ago
10 months ago
10 months ago
9 months ago
9 months ago
10 months ago
7 months ago
7 months ago
10 months ago
10 months ago
8 months ago
8 months ago
9 months ago
9 months ago
7 months ago
8 months ago
8 months ago
7 months ago
9 months ago
9 months ago
7 months ago
7 months ago
8 months ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
12 months ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
12 months ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
12 months ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
12 months ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago