UNPKG

yjs-server

Version:

An extensible websocket server for the Yjs collaborative editing framework. Compatible with y-websocket.

16 lines (15 loc) 750 B
import type { DocStorage, IRequest, Logger, YjsServer } from './types.js'; import type { Room } from './Room.js'; import type { Doc } from 'yjs'; export declare const defaultDocNameFromRequest: (req: IRequest) => string | undefined; export interface CreateYjsServerOptions { createDoc: () => Doc; logger?: Logger; docNameFromRequest?: typeof defaultDocNameFromRequest; docStorage?: DocStorage; rooms?: Map<string, Room>; pingTimeoutMs?: number; maxBufferedBytes?: number; maxBufferedBytesBeforeConnect?: number; } export declare const createYjsServer: ({ createDoc, docStorage, logger, docNameFromRequest, rooms, pingTimeoutMs, maxBufferedBytesBeforeConnect, maxBufferedBytes, }: CreateYjsServerOptions) => YjsServer;