Archives/cudr_slate-collaborative
1
0
Fork 0
mirror of https://github.com/cudr/slate-collaborative.git synced 2024-09-28 14:20:47 +00:00
Code Issues Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
George 2019-10-19 22:43:55 +03:00 committed by GitHub
parent 7978257b06
commit 528ee75ebd
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -44,20 +44,20 @@ const connection = new CollaborativeBackend(options)
### options: ### options:
``` ```
{ {
port: number port: number // posrt to start io connection
connectOpts?: SocketIO.ServerOptions connectOpts?: SocketIO.ServerOptions
defaultValue?: ValueJSON defaultValue?: ValueJSON // default value
saveTreshold?: number saveTreshold?: number // theshold of onDocumentSave callback execution
cursorAnnotationType?: string cursorAnnotationType?: string // type string for cursor annotations
onAuthRequest?: ( onAuthRequest?: ( // auth callback
query: Object, query: Object,
socket?: SocketIO.Socket socket?: SocketIO.Socket
) => Promise<boolean> | boolean ) => Promise<boolean> | boolean
onDocumentLoad?: ( onDocumentLoad?: ( // request slatejs document callback
pathname: string, pathname: string,
query?: Object query?: Object
) => ValueJSON | null | false | undefined ) => ValueJSON | null | false | undefined
onDocumentSave?: (pathname: string, json: ValueJSON) => Promise<void> | void onDocumentSave?: (pathname: string, json: ValueJSON) => Promise<void> | void // save document callback
} }
``` ```