@yorkie-js/sdk
    Preparing search index...

    Interface AttachOptions<R, P>

    AttachOptions are user-settable options used when attaching documents.

    interface AttachOptions<R, P> {
        documentPollInterval?: number;
        initialPresence?: P;
        initialRoot?: R;
        schema?: string;
        syncMode?: SyncMode;
    }

    Type Parameters

    • R
    • P
    Index

    Properties

    documentPollInterval? initialPresence? initialRoot? schema? syncMode?

    Properties

    documentPollInterval?: number

    documentPollInterval (ms) — only used when syncMode is Polling. Default: 3000.

    initialPresence?: P

    initialPresence is the initial presence of the client.

    initialRoot?: R

    initialRoot is the initial root of the document. It is used to initialize the document. It is used when the fields are not set in the document.

    schema?: string

    schema is the schema of the document. It is used to validate the document.

    syncMode?: SyncMode

    syncMode defines the synchronization mode of the document.

    Settings

    Member Visibility

    On This Page

    Properties