From 97f96207cf51cc0c0a438497591319bba5030dd7 Mon Sep 17 00:00:00 2001 From: hackerwins Date: Mon, 23 Dec 2024 04:49:32 +0000 Subject: [PATCH] deploy: a217445af078849ae94e885770fe33337f3dcbbf --- api-reference/classes/Change.html | 28 ++-- api-reference/classes/Client.html | 42 +++--- api-reference/classes/Counter.html | 16 +- api-reference/classes/Document.html | 140 +++++++++--------- api-reference/classes/Primitive.html | 48 +++--- api-reference/classes/Text.html | 38 ++--- api-reference/classes/TimeTicket.html | 30 ++-- api-reference/classes/Tree.html | 52 +++---- api-reference/classes/VersionVector.html | 22 +-- api-reference/enums/ClientCondition.html | 6 +- api-reference/enums/ClientStatus.html | 6 +- api-reference/enums/DocEventType.html | 28 ++-- api-reference/enums/DocStatus.html | 8 +- api-reference/enums/DocSyncStatus.html | 6 +- api-reference/enums/LogLevel.html | 4 +- api-reference/enums/OpSource.html | 4 +- .../enums/StreamConnectionStatus.html | 6 +- api-reference/enums/SyncMode.html | 10 +- api-reference/enums/TreeChangeType.html | 4 +- api-reference/interfaces/ChangeInfo.html | 4 +- api-reference/interfaces/ClientOptions.html | 14 +- .../interfaces/ConnectionChangedEvent.html | 4 +- .../interfaces/InitializedEvent.html | 4 +- .../interfaces/LocalChangeEvent.html | 6 +- api-reference/interfaces/Observable.html | 4 +- api-reference/interfaces/Observer.html | 4 +- .../interfaces/PresenceChangedEvent.html | 4 +- .../interfaces/RemoteChangeEvent.html | 6 +- api-reference/interfaces/SnapshotEvent.html | 6 +- .../interfaces/SyncStatusChangedEvent.html | 4 +- api-reference/interfaces/UnwatchedEvent.html | 4 +- api-reference/interfaces/WatchedEvent.html | 4 +- api-reference/modules/Devtools.html | 2 +- api-reference/types/ActorID.html | 2 +- api-reference/types/AddOpInfo.html | 2 +- api-reference/types/ArrayOperationInfo.html | 2 +- api-reference/types/CRDTTreeNodeIDStruct.html | 2 +- api-reference/types/CompleteFn.html | 2 +- api-reference/types/CounterOperationInfo.html | 2 +- api-reference/types/CounterValue.html | 2 +- api-reference/types/Devtools.Client.html | 2 +- .../types/Devtools.ContainerValue.html | 2 +- api-reference/types/Devtools.JSONElement.html | 2 +- .../types/Devtools.TreeNodeInfo.html | 2 +- api-reference/types/DocEvent.html | 2 +- api-reference/types/EditOpInfo.html | 2 +- api-reference/types/ElementNode.html | 2 +- api-reference/types/ErrorFn.html | 2 +- .../types/FullPanelToSDKMessage.html | 2 +- .../types/FullSDKToPanelMessage.html | 2 +- api-reference/types/IncreaseOpInfo.html | 2 +- api-reference/types/Indexable.html | 2 +- api-reference/types/JSONArray.html | 26 ++-- api-reference/types/JSONElement.html | 2 +- api-reference/types/JSONObject.html | 8 +- api-reference/types/MoveOpInfo.html | 2 +- api-reference/types/NextFn.html | 2 +- api-reference/types/ObjectOperationInfo.html | 2 +- api-reference/types/OperationInfo.html | 2 +- api-reference/types/PanelToSDKMessage.html | 2 +- api-reference/types/PrimitiveValue.html | 2 +- api-reference/types/RemoveOpInfo.html | 2 +- api-reference/types/SDKToPanelMessage.html | 2 +- api-reference/types/SetOpInfo.html | 2 +- api-reference/types/StyleOpInfo.html | 2 +- api-reference/types/TextNode.html | 2 +- api-reference/types/TextOperationInfo.html | 2 +- api-reference/types/TextPosStruct.html | 2 +- api-reference/types/TextPosStructRange.html | 2 +- api-reference/types/TimeTicketStruct.html | 2 +- api-reference/types/TransactionEvent.html | 2 +- api-reference/types/TreeChange.html | 2 +- api-reference/types/TreeEditOpInfo.html | 2 +- api-reference/types/TreeNode.html | 2 +- api-reference/types/TreeOperationInfo.html | 2 +- api-reference/types/TreePosStructRange.html | 2 +- api-reference/types/TreeStyleOpInfo.html | 2 +- api-reference/types/Unsubscribe.html | 2 +- api-reference/types/WrappedElement.html | 2 +- .../variables/EventSourceDevPanel.html | 2 +- api-reference/variables/EventSourceSDK.html | 2 +- api-reference/variables/converter.html | 2 +- api-reference/variables/default.html | 2 +- examples/nextjs-scheduler/404.html | 2 +- .../_buildManifest.js | 0 .../_ssgManifest.js | 0 examples/nextjs-scheduler/index.html | 2 +- examples/nextjs-scheduler/index.txt | 2 +- 88 files changed, 352 insertions(+), 352 deletions(-) rename examples/nextjs-scheduler/_next/static/{u3uXYOUHYQOqUxL-X8yoB => dwYR6z8TNyKgTPufwxcKm}/_buildManifest.js (100%) rename examples/nextjs-scheduler/_next/static/{u3uXYOUHYQOqUxL-X8yoB => dwYR6z8TNyKgTPufwxcKm}/_ssgManifest.js (100%) diff --git a/api-reference/classes/Change.html b/api-reference/classes/Change.html index ceacae42c..dbb8836c0 100644 --- a/api-reference/classes/Change.html +++ b/api-reference/classes/Change.html @@ -1,5 +1,5 @@ Change | yorkie-js-sdk

Class Change<P>

Change represents a unit of modification in the document.

-

Type Parameters

Constructors

constructor +

Type Parameters

Constructors

constructor

Properties

id message? operations @@ -16,16 +16,16 @@ toTestString create fromStruct -

Constructors

constructor

  • new Change<P>(__namedParameters): Change<P>

  • Type Parameters

    Parameters

    • __namedParameters: {
          id: ChangeID;
          message?: string;
          operations?: Operation[];
          presenceChange?: PresenceChange<P>;
      }
      • id: ChangeID
      • Optional message?: string
      • Optional operations?: Operation[]
      • Optional presenceChange?: PresenceChange<P>

    Returns Change<P>

Properties

Private id

id: ChangeID

Private Optional message

message?: string

Private operations

operations: Operation[]

Private Optional presenceChange

presenceChange?: PresenceChange<P>

Methods

execute

  • execute(root, presences, source): {
        opInfos: OperationInfo[];
        reverseOps: HistoryOperation<P>[];
    }

  • execute executes the operations of this change to the given root.

    -

    Parameters

    • root: CRDTRoot
    • presences: Map<string, P>
    • source: OpSource

    Returns {
        opInfos: OperationInfo[];
        reverseOps: HistoryOperation<P>[];
    }

getID

getMessage

  • getMessage(): undefined | string

  • getMessage returns the message of this change.

    -

    Returns undefined | string

getOperations

getPresenceChange

  • getPresenceChange(): undefined | PresenceChange<P>

  • getPresenceChange returns the presence change of this change.

    -

    Returns undefined | PresenceChange<P>

hasOperations

  • hasOperations(): boolean

  • hasOperations returns whether this change has operations or not.

    -

    Returns boolean

hasPresenceChange

  • hasPresenceChange(): boolean

  • hasPresenceChange returns whether this change has presence change or not.

    -

    Returns boolean

setActor

toStruct

toTestString

  • toTestString(): string

  • toTestString returns a string containing the meta data of this change.

    -

    Returns string

Static create

  • create<P>(__namedParameters): Change<P>

  • create creates a new instance of Change.

    -

    Type Parameters

    Parameters

    • __namedParameters: {
          id: ChangeID;
          message?: string;
          operations?: Operation[];
          presenceChange?: PresenceChange<P>;
      }
      • id: ChangeID
      • Optional message?: string
      • Optional operations?: Operation[]
      • Optional presenceChange?: PresenceChange<P>

    Returns Change<P>

Static fromStruct

Settings

Member Visibility

Theme

On This Page

constructoridmessageoperationspresenceChangeexecutegetIDgetMessagegetOperationsgetPresenceChangehasOperationshasPresenceChangesetActortoStructtoTestStringcreatefromStruct
\ No newline at end of file +

Constructors

constructor

  • new Change<P>(__namedParameters): Change<P>

  • Type Parameters

    Parameters

    • __namedParameters: {
          id: ChangeID;
          message?: string;
          operations?: Operation[];
          presenceChange?: PresenceChange<P>;
      }
      • id: ChangeID
      • Optional message?: string
      • Optional operations?: Operation[]
      • Optional presenceChange?: PresenceChange<P>

    Returns Change<P>

Properties

Private id

id: ChangeID

Private Optional message

message?: string

Private operations

operations: Operation[]

Private Optional presenceChange

presenceChange?: PresenceChange<P>

Methods

execute

  • execute(root, presences, source): {
        opInfos: OperationInfo[];
        reverseOps: HistoryOperation<P>[];
    }

  • execute executes the operations of this change to the given root.

    +

    Parameters

    • root: CRDTRoot
    • presences: Map<string, P>
    • source: OpSource

    Returns {
        opInfos: OperationInfo[];
        reverseOps: HistoryOperation<P>[];
    }

getID

getMessage

  • getMessage(): undefined | string

  • getMessage returns the message of this change.

    +

    Returns undefined | string

getOperations

getPresenceChange

  • getPresenceChange(): undefined | PresenceChange<P>

  • getPresenceChange returns the presence change of this change.

    +

    Returns undefined | PresenceChange<P>

hasOperations

  • hasOperations(): boolean

  • hasOperations returns whether this change has operations or not.

    +

    Returns boolean

hasPresenceChange

  • hasPresenceChange(): boolean

  • hasPresenceChange returns whether this change has presence change or not.

    +

    Returns boolean

setActor

toStruct

toTestString

  • toTestString(): string

  • toTestString returns a string containing the meta data of this change.

    +

    Returns string

Static create

  • create<P>(__namedParameters): Change<P>

  • create creates a new instance of Change.

    +

    Type Parameters

    Parameters

    • __namedParameters: {
          id: ChangeID;
          message?: string;
          operations?: Operation[];
          presenceChange?: PresenceChange<P>;
      }
      • id: ChangeID
      • Optional message?: string
      • Optional operations?: Operation[]
      • Optional presenceChange?: PresenceChange<P>

    Returns Change<P>

Static fromStruct

Settings

Member Visibility

Theme

On This Page

constructoridmessageoperationspresenceChangeexecutegetIDgetMessagegetOperationsgetPresenceChangehasOperationshasPresenceChangesetActortoStructtoTestStringcreatefromStruct
\ No newline at end of file diff --git a/api-reference/classes/Client.html b/api-reference/classes/Client.html index 1058633a9..7c75bf7cf 100644 --- a/api-reference/classes/Client.html +++ b/api-reference/classes/Client.html @@ -1,7 +1,7 @@ Client | yorkie-js-sdk

Class Client

Client is a normal client that can communicate with the server. It has documents and sends changes of the documents in local to the server to synchronize with other replicas in remote.

-

Constructors

constructor +

Constructors

constructor

Properties

apiKey attachmentMap authTokenInjector? @@ -41,7 +41,7 @@ syncInternal

Constructors

constructor

Properties

Private apiKey

apiKey: string

Private attachmentMap

attachmentMap: Map<string, Attachment<unknown, any>>

Private Optional authTokenInjector

authTokenInjector?: ((reason?) => Promise<string>)

Type declaration

    • (reason?): Promise<string>

    • Parameters

      • Optional reason: string

      Returns Promise<string>

Private conditions

conditions: Record<ClientCondition, boolean>

Private Optional id

id?: string

Private keepalive

keepalive: boolean = false

Private key

key: string

Private processing

processing: boolean = false

Private reconnectStreamDelay

reconnectStreamDelay: number

Private retrySyncLoopDelay

retrySyncLoopDelay: number

Private rpcClient

rpcClient: PromiseClient<{
    methods: {
        activateClient: {
            I: typeof ActivateClientRequest;
            O: typeof ActivateClientResponse;
            kind: Unary;
            name: "ActivateClient";
        };
        attachDocument: {
            I: typeof AttachDocumentRequest;
            O: typeof AttachDocumentResponse;
            kind: Unary;
            name: "AttachDocument";
        };
        broadcast: {
            I: typeof BroadcastRequest;
            O: typeof BroadcastResponse;
            kind: Unary;
            name: "Broadcast";
        };
        deactivateClient: {
            I: typeof DeactivateClientRequest;
            O: typeof DeactivateClientResponse;
            kind: Unary;
            name: "DeactivateClient";
        };
        detachDocument: {
            I: typeof DetachDocumentRequest;
            O: typeof DetachDocumentResponse;
            kind: Unary;
            name: "DetachDocument";
        };
        pushPullChanges: {
            I: typeof PushPullChangesRequest;
            O: typeof PushPullChangesResponse;
            kind: Unary;
            name: "PushPullChanges";
        };
        removeDocument: {
            I: typeof RemoveDocumentRequest;
            O: typeof RemoveDocumentResponse;
            kind: Unary;
            name: "RemoveDocument";
        };
        watchDocument: {
            I: typeof WatchDocumentRequest;
            O: typeof WatchDocumentResponse;
            kind: ServerStreaming;
            name: "WatchDocument";
        };
    };
    typeName: "yorkie.v1.YorkieService";
}>

Type declaration

  • Readonly methods: {
        activateClient: {
            I: typeof ActivateClientRequest;
            O: typeof ActivateClientResponse;
            kind: Unary;
            name: "ActivateClient";
        };
        attachDocument: {
            I: typeof AttachDocumentRequest;
            O: typeof AttachDocumentResponse;
            kind: Unary;
            name: "AttachDocument";
        };
        broadcast: {
            I: typeof BroadcastRequest;
            O: typeof BroadcastResponse;
            kind: Unary;
            name: "Broadcast";
        };
        deactivateClient: {
            I: typeof DeactivateClientRequest;
            O: typeof DeactivateClientResponse;
            kind: Unary;
            name: "DeactivateClient";
        };
        detachDocument: {
            I: typeof DetachDocumentRequest;
            O: typeof DetachDocumentResponse;
            kind: Unary;
            name: "DetachDocument";
        };
        pushPullChanges: {
            I: typeof PushPullChangesRequest;
            O: typeof PushPullChangesResponse;
            kind: Unary;
            name: "PushPullChanges";
        };
        removeDocument: {
            I: typeof RemoveDocumentRequest;
            O: typeof RemoveDocumentResponse;
            kind: Unary;
            name: "RemoveDocument";
        };
        watchDocument: {
            I: typeof WatchDocumentRequest;
            O: typeof WatchDocumentResponse;
            kind: ServerStreaming;
            name: "WatchDocument";
        };
    }
    • Readonly activateClient: {
          I: typeof ActivateClientRequest;
          O: typeof ActivateClientResponse;
          kind: Unary;
          name: "ActivateClient";
      }

      Generated

      from rpc yorkie.v1.YorkieService.ActivateClient

      +

Returns Client

Properties

Private apiKey

apiKey: string

Private attachmentMap

attachmentMap: Map<string, Attachment<unknown, any>>

Private Optional authTokenInjector

authTokenInjector?: ((reason?) => Promise<string>)

Type declaration

    • (reason?): Promise<string>

    • Parameters

      • Optional reason: string

      Returns Promise<string>

Private conditions

conditions: Record<ClientCondition, boolean>

Private Optional id

id?: string

Private keepalive

keepalive: boolean = false

Private key

key: string

Private processing

processing: boolean = false

Private reconnectStreamDelay

reconnectStreamDelay: number

Private retrySyncLoopDelay

retrySyncLoopDelay: number

Private rpcClient

rpcClient: PromiseClient<{
    methods: {
        activateClient: {
            I: typeof ActivateClientRequest;
            O: typeof ActivateClientResponse;
            kind: Unary;
            name: "ActivateClient";
        };
        attachDocument: {
            I: typeof AttachDocumentRequest;
            O: typeof AttachDocumentResponse;
            kind: Unary;
            name: "AttachDocument";
        };
        broadcast: {
            I: typeof BroadcastRequest;
            O: typeof BroadcastResponse;
            kind: Unary;
            name: "Broadcast";
        };
        deactivateClient: {
            I: typeof DeactivateClientRequest;
            O: typeof DeactivateClientResponse;
            kind: Unary;
            name: "DeactivateClient";
        };
        detachDocument: {
            I: typeof DetachDocumentRequest;
            O: typeof DetachDocumentResponse;
            kind: Unary;
            name: "DetachDocument";
        };
        pushPullChanges: {
            I: typeof PushPullChangesRequest;
            O: typeof PushPullChangesResponse;
            kind: Unary;
            name: "PushPullChanges";
        };
        removeDocument: {
            I: typeof RemoveDocumentRequest;
            O: typeof RemoveDocumentResponse;
            kind: Unary;
            name: "RemoveDocument";
        };
        watchDocument: {
            I: typeof WatchDocumentRequest;
            O: typeof WatchDocumentResponse;
            kind: ServerStreaming;
            name: "WatchDocument";
        };
    };
    typeName: "yorkie.v1.YorkieService";
}>

Type declaration

  • Readonly methods: {
        activateClient: {
            I: typeof ActivateClientRequest;
            O: typeof ActivateClientResponse;
            kind: Unary;
            name: "ActivateClient";
        };
        attachDocument: {
            I: typeof AttachDocumentRequest;
            O: typeof AttachDocumentResponse;
            kind: Unary;
            name: "AttachDocument";
        };
        broadcast: {
            I: typeof BroadcastRequest;
            O: typeof BroadcastResponse;
            kind: Unary;
            name: "Broadcast";
        };
        deactivateClient: {
            I: typeof DeactivateClientRequest;
            O: typeof DeactivateClientResponse;
            kind: Unary;
            name: "DeactivateClient";
        };
        detachDocument: {
            I: typeof DetachDocumentRequest;
            O: typeof DetachDocumentResponse;
            kind: Unary;
            name: "DetachDocument";
        };
        pushPullChanges: {
            I: typeof PushPullChangesRequest;
            O: typeof PushPullChangesResponse;
            kind: Unary;
            name: "PushPullChanges";
        };
        removeDocument: {
            I: typeof RemoveDocumentRequest;
            O: typeof RemoveDocumentResponse;
            kind: Unary;
            name: "RemoveDocument";
        };
        watchDocument: {
            I: typeof WatchDocumentRequest;
            O: typeof WatchDocumentResponse;
            kind: ServerStreaming;
            name: "WatchDocument";
        };
    }
    • Readonly activateClient: {
          I: typeof ActivateClientRequest;
          O: typeof ActivateClientResponse;
          kind: Unary;
          name: "ActivateClient";
      }

      Generated

      from rpc yorkie.v1.YorkieService.ActivateClient

      • Readonly I: typeof ActivateClientRequest
      • Readonly O: typeof ActivateClientResponse
      • Readonly kind: Unary
      • Readonly name: "ActivateClient"
    • Readonly attachDocument: {
          I: typeof AttachDocumentRequest;
          O: typeof AttachDocumentResponse;
          kind: Unary;
          name: "AttachDocument";
      }

      Generated

      from rpc yorkie.v1.YorkieService.AttachDocument

      • Readonly I: typeof AttachDocumentRequest
      • Readonly O: typeof AttachDocumentResponse
      • Readonly kind: Unary
      • Readonly name: "AttachDocument"
    • Readonly broadcast: {
          I: typeof BroadcastRequest;
          O: typeof BroadcastResponse;
          kind: Unary;
          name: "Broadcast";
      }

      Generated

      from rpc yorkie.v1.YorkieService.Broadcast

      • Readonly I: typeof BroadcastRequest
      • Readonly O: typeof BroadcastResponse
      • Readonly kind: Unary
      • Readonly name: "Broadcast"
    • Readonly deactivateClient: {
          I: typeof DeactivateClientRequest;
          O: typeof DeactivateClientResponse;
          kind: Unary;
          name: "DeactivateClient";
      }

      Generated

      from rpc yorkie.v1.YorkieService.DeactivateClient

      @@ -49,39 +49,39 @@
      • Readonly I: typeof DetachDocumentRequest
      • Readonly O: typeof DetachDocumentResponse
      • Readonly kind: Unary
      • Readonly name: "DetachDocument"
    • Readonly pushPullChanges: {
          I: typeof PushPullChangesRequest;
          O: typeof PushPullChangesResponse;
          kind: Unary;
          name: "PushPullChanges";
      }

      Generated

      from rpc yorkie.v1.YorkieService.PushPullChanges

      • Readonly I: typeof PushPullChangesRequest
      • Readonly O: typeof PushPullChangesResponse
      • Readonly kind: Unary
      • Readonly name: "PushPullChanges"
    • Readonly removeDocument: {
          I: typeof RemoveDocumentRequest;
          O: typeof RemoveDocumentResponse;
          kind: Unary;
          name: "RemoveDocument";
      }

      Generated

      from rpc yorkie.v1.YorkieService.RemoveDocument

      • Readonly I: typeof RemoveDocumentRequest
      • Readonly O: typeof RemoveDocumentResponse
      • Readonly kind: Unary
      • Readonly name: "RemoveDocument"
    • Readonly watchDocument: {
          I: typeof WatchDocumentRequest;
          O: typeof WatchDocumentResponse;
          kind: ServerStreaming;
          name: "WatchDocument";
      }

      Generated

      from rpc yorkie.v1.YorkieService.WatchDocument

      -
      • Readonly I: typeof WatchDocumentRequest
      • Readonly O: typeof WatchDocumentResponse
      • Readonly kind: ServerStreaming
      • Readonly name: "WatchDocument"
  • Readonly typeName: "yorkie.v1.YorkieService"

Private setAuthToken

setAuthToken: ((token) => void)

Type declaration

    • (token): void

    • Parameters

      • token: string

      Returns void

Private status

status: ClientStatus

Private syncLoopDuration

syncLoopDuration: number

Private taskQueue

taskQueue: (() => Promise<any>)[]

Type declaration

    • (): Promise<any>

    • Returns Promise<any>

Methods

activate

  • activate(): Promise<void>

  • activate activates this client. That is, it registers itself to the server +

    • Readonly I: typeof WatchDocumentRequest
    • Readonly O: typeof WatchDocumentResponse
    • Readonly kind: ServerStreaming
    • Readonly name: "WatchDocument"
  • Readonly typeName: "yorkie.v1.YorkieService"

    • Private setAuthToken

    setAuthToken: ((token) => void)

    Type declaration

      • (token): void

      • Parameters

        • token: string

        Returns void

    Private status

    status: ClientStatus

    Private syncLoopDuration

    syncLoopDuration: number

    Private taskQueue

    taskQueue: (() => Promise<any>)[]

    Type declaration

      • (): Promise<any>

      • Returns Promise<any>

    Methods

    activate

    • activate(): Promise<void>

    • activate activates this client. That is, it registers itself to the server and receives a unique ID from the server. The given ID is used to distinguish different clients.

      -

      Returns Promise<void>

    attach

    • attach<T, P>(doc, options?): Promise<Document<T, P>>

    • attach attaches the given document to this client. It tells the server that +

      Returns Promise<void>

    attach

    • attach<T, P>(doc, options?): Promise<Document<T, P>>

    • attach attaches the given document to this client. It tells the server that this client will synchronize the given document.

      -

      Type Parameters

      Parameters

      • doc: Document<T, P>
      • options: {
            initialPresence?: P;
            initialRoot?: T;
            syncMode?: SyncMode;
        } = {}
        • Optional initialPresence?: P
        • Optional initialRoot?: T
        • Optional syncMode?: SyncMode

      Returns Promise<Document<T, P>>

    broadcast

    • broadcast(docKey, topic, payload, options?): Promise<void>

    • broadcast broadcasts the given payload to the given topic.

      -

      Parameters

      • docKey: string
      • topic: string
      • payload: Json
      • Optional options: BroadcastOptions

      Returns Promise<void>

    changeSyncMode

    deactivate

    • deactivate(options?): Promise<void>

    • deactivate deactivates this client.

      +

      Type Parameters

      Parameters

      • doc: Document<T, P>
      • options: {
            initialPresence?: P;
            initialRoot?: T;
            syncMode?: SyncMode;
        } = {}
        • Optional initialPresence?: P
        • Optional initialRoot?: T
        • Optional syncMode?: SyncMode

      Returns Promise<Document<T, P>>

    broadcast

    • broadcast(docKey, topic, payload, options?): Promise<void>

    • broadcast broadcasts the given payload to the given topic.

      +

      Parameters

      • docKey: string
      • topic: string
      • payload: Json
      • Optional options: BroadcastOptions

      Returns Promise<void>

    changeSyncMode

    deactivate

    • deactivate(options?): Promise<void>

    • deactivate deactivates this client.

      Parameters

      • options: {
            keepalive: boolean;
        } = ...

        If keepalive is true, the client will request deactivation immediately using fetch with the keepalive option enabled. This is useful for ensuring the deactivation request completes even if the page is being unloaded, such as in beforeunload or unload event listeners.

        -
        • keepalive: boolean

      Returns Promise<void>

    Private deactivateInternal

    detach

    • detach<T, P>(doc, options?): Promise<Document<T, P>>

    • detach detaches the given document from this client. It tells the +

      • keepalive: boolean

    Returns Promise<void>

    Private deactivateInternal

    detach

    • detach<T, P>(doc, options?): Promise<Document<T, P>>

    • detach detaches the given document from this client. It tells the server that this client will no longer synchronize the given document.

      To collect garbage things like CRDT tombstones left on the document, all the changes should be applied to other replicas before GC time. For this, if the document is no longer used by this client, it should be detached.

      -

      Type Parameters

      Parameters

      • doc: Document<T, P>
      • options: {
            removeIfNotAttached?: boolean;
        } = {}
        • Optional removeIfNotAttached?: boolean

      Returns Promise<Document<T, P>>

    Private detachInternal

    Private enqueueTask

    • enqueueTask(task): Promise<any>

    • enqueueTask enqueues the given task to the task queue.

      -

      Parameters

      • task: (() => Promise<any>)
          • (): Promise<any>

          • Returns Promise<any>

      Returns Promise<any>

    getCondition

    getID

    • getID(): undefined | string

    • getID returns a ActorID of client.

      -

      Returns undefined | string

    getKey

    getStatus

    Private handleConnectError

    • handleConnectError(err): Promise<boolean>

    • handleConnectError handles the given error. If the given error can be +

      Type Parameters

      Parameters

      • doc: Document<T, P>
      • options: {
            removeIfNotAttached?: boolean;
        } = {}
        • Optional removeIfNotAttached?: boolean

      Returns Promise<Document<T, P>>

    Private detachInternal

    Private enqueueTask

    • enqueueTask(task): Promise<any>

    • enqueueTask enqueues the given task to the task queue.

      +

      Parameters

      • task: (() => Promise<any>)
          • (): Promise<any>

          • Returns Promise<any>

      Returns Promise<any>

    getCondition

    getID

    • getID(): undefined | string

    • getID returns a ActorID of client.

      +

      Returns undefined | string

    getKey

    getStatus

    Private handleConnectError

    • handleConnectError(err): Promise<boolean>

    • handleConnectError handles the given error. If the given error can be retried after handling, it returns true.

      -

      Parameters

      • err: any

      Returns Promise<boolean>

    Private handleWatchDocumentsResponse

    • handleWatchDocumentsResponse<T, P>(attachment, resp): void

    • Type Parameters

      Parameters

      • attachment: Attachment<T, P>
      • resp: WatchDocumentResponse

      Returns void

    isActive

    • isActive(): boolean

    • isActive checks if the client is active.

      -

      Returns boolean

    Private processNext

    • processNext(): Promise<void>

    • processNext processes the next task in the task queue. This method is +

      Parameters

      • err: any

      Returns Promise<boolean>

    Private handleWatchDocumentsResponse

    • handleWatchDocumentsResponse<T, P>(attachment, resp): void

    • Type Parameters

      Parameters

      • attachment: Attachment<T, P>
      • resp: WatchDocumentResponse

      Returns void

    isActive

    • isActive(): boolean

    • isActive checks if the client is active.

      +

      Returns boolean

    Private processNext

    • processNext(): Promise<void>

    • processNext processes the next task in the task queue. This method is part of enqueueTask.

      -

      Returns Promise<void>

    remove

    Private runSyncLoop

    • runSyncLoop(): void

    • runSyncLoop runs the sync loop. The sync loop pushes local changes to +

      Returns Promise<void>

    remove

    Private runSyncLoop

    • runSyncLoop(): void

    • runSyncLoop runs the sync loop. The sync loop pushes local changes to the server and pulls remote changes from the server.

      -

      Returns void

    Private runWatchLoop

    • runWatchLoop(docKey): Promise<void>

    • runWatchLoop runs the watch loop for the given document. The watch loop +

      Returns void

    Private runWatchLoop

    • runWatchLoop(docKey): Promise<void>

    • runWatchLoop runs the watch loop for the given document. The watch loop listens to the events of the given document from the server.

      -

      Parameters

      • docKey: string

      Returns Promise<void>

    sync

    • sync<T, P>(doc?): Promise<Document<T, P>[]>

    • sync pushes local changes of the attached documents to the server and +

      Parameters

      • docKey: string

      Returns Promise<void>

    sync

    • sync<T, P>(doc?): Promise<Document<T, P>[]>

    • sync pushes local changes of the attached documents to the server and receives changes of the remote replica from the server then apply them to local documents.

      -

      Type Parameters

      Parameters

      Returns Promise<Document<T, P>[]>

    Private syncInternal

    Settings

    Member Visibility

    Theme

    On This Page

    constructorapiKeyattachmentMapauthTokenInjectorconditionsidkeepalivekeyprocessingreconnectStreamDelayretrySyncLoopDelayrpcClientsetAuthTokenstatussyncLoopDurationtaskQueueactivateattachbroadcastchangeSyncModedeactivatedeactivateInternaldetachdetachInternalenqueueTaskgetConditiongetIDgetKeygetStatushandleConnectErrorhandleWatchDocumentsResponseisActiveprocessNextremoverunSyncLooprunWatchLoopsyncsyncInternal
    \ No newline at end of file +

    Type Parameters

    Parameters

    Returns Promise<Document<T, P>[]>

    Private syncInternal

    Settings

    Member Visibility

    Theme

    On This Page

    constructorapiKeyattachmentMapauthTokenInjectorconditionsidkeepalivekeyprocessingreconnectStreamDelayretrySyncLoopDelayrpcClientsetAuthTokenstatussyncLoopDurationtaskQueueactivateattachbroadcastchangeSyncModedeactivatedeactivateInternaldetachdetachInternalenqueueTaskgetConditiongetIDgetKeygetStatushandleConnectErrorhandleWatchDocumentsResponseisActiveprocessNextremoverunSyncLooprunWatchLoopsyncsyncInternal
    \ No newline at end of file diff --git a/api-reference/classes/Counter.html b/api-reference/classes/Counter.html index b6f128c4a..ea3339702 100644 --- a/api-reference/classes/Counter.html +++ b/api-reference/classes/Counter.html @@ -1,5 +1,5 @@ Counter | yorkie-js-sdk

    Class Counter

    Counter is a custom data type that is used to counter.

    -

    Constructors

    constructor +

    Constructors

    constructor

    Properties

    context? counter? value @@ -10,10 +10,10 @@ increase initialize toJSForTest -

    Constructors

    constructor

    Properties

    Private Optional context

    context?: ChangeContext<Indexable>

    Private Optional counter

    counter?: CRDTCounter

    Private value

    value: number | Long

    Private valueType

    valueType: CounterType

    Methods

    getID

    getValue

    • getValue(): number | Long
    • Internal

      getValue returns the value of this counter;

      -

      Returns number | Long

    getValueType

    • getValueType(): CounterType

    • getValueType returns the value type of this counter.

      -

      Returns CounterType

    increase

    initialize

    • initialize(context, counter): void
    • Internal

      initialize initialize this text with context and internal text.

      -

      Parameters

      • context: ChangeContext<Indexable>
      • counter: CRDTCounter

      Returns void

    toJSForTest

    Settings

    Member Visibility

    Theme

    On This Page

    constructorcontextcountervaluevalueTypegetIDgetValuegetValueTypeincreaseinitializetoJSForTest
    \ No newline at end of file +

    Constructors

    constructor

    Properties

    Private Optional context

    context?: ChangeContext<Indexable>

    Private Optional counter

    counter?: CRDTCounter

    Private value

    value: number | Long

    Private valueType

    valueType: CounterType

    Methods

    getID

    getValue

    • getValue(): number | Long
    • Internal

      getValue returns the value of this counter;

      +

      Returns number | Long

    getValueType

    • getValueType(): CounterType

    • getValueType returns the value type of this counter.

      +

      Returns CounterType

    increase

    initialize

    • initialize(context, counter): void
    • Internal

      initialize initialize this text with context and internal text.

      +

      Parameters

      • context: ChangeContext<Indexable>
      • counter: CRDTCounter

      Returns void

    toJSForTest

    Settings

    Member Visibility

    Theme

    On This Page

    constructorcontextcountervaluevalueTypegetIDgetValuegetValueTypeincreaseinitializetoJSForTest
    \ No newline at end of file diff --git a/api-reference/classes/Document.html b/api-reference/classes/Document.html index 1bf5b2e51..dba5b8d97 100644 --- a/api-reference/classes/Document.html +++ b/api-reference/classes/Document.html @@ -1,6 +1,6 @@ Document | yorkie-js-sdk

    Class Document<T, P>

    Document is a CRDT-based data type. We can represent the model of the application and edit it even while offline.

    -

    Type Parameters

    Constructors

    constructor +

    Type Parameters

    Constructors

    constructor

    Properties

    changeID checkpoint clone? @@ -69,106 +69,106 @@ toSortedJSON undo update -

    Constructors

    constructor

    Properties

    Private changeID

    changeID: ChangeID

    Private checkpoint

    checkpoint: Checkpoint

    Private Optional clone

    clone?: {
        presences: Map<string, P>;
        root: CRDTRoot;
    }

    Type declaration

    • presences: Map<string, P>
    • root: CRDTRoot

    Private eventStream

    eventStream: Observable<TransactionEvent<P>>

    Private eventStreamObserver

    eventStreamObserver: Observer<TransactionEvent<P>>

    history

    history: {
        canRedo: (() => boolean);
        canUndo: (() => boolean);
        redo: (() => void);
        undo: (() => void);
    }

    history is exposed to the user to manage undo/redo operations.

    +

    Constructors

    constructor

    Properties

    Private changeID

    changeID: ChangeID

    Private checkpoint

    checkpoint: Checkpoint

    Private Optional clone

    clone?: {
        presences: Map<string, P>;
        root: CRDTRoot;
    }

    Type declaration

    • presences: Map<string, P>
    • root: CRDTRoot

    Private eventStream

    eventStream: Observable<TransactionEvent<P>>

    Private eventStreamObserver

    eventStreamObserver: Observer<TransactionEvent<P>>

    history

    history: {
        canRedo: (() => boolean);
        canUndo: (() => boolean);
        redo: (() => void);
        undo: (() => void);
    }

    history is exposed to the user to manage undo/redo operations.

    Type declaration

    • canRedo: (() => boolean)
        • (): boolean

        • canRedo returns whether there are any operations to redo.

          Returns boolean

    • canUndo: (() => boolean)
        • (): boolean

        • canUndo returns whether there are any operations to undo.

          Returns boolean

    • redo: (() => void)
        • (): void

        • redo redoes the last operation executed by the current client. It does not impact operations made by other clients.

          Returns void

    • undo: (() => void)
        • (): void

        • undo undoes the last operation executed by the current client. It does not impact operations made by other clients.

          -

          Returns void

    internalHistory

    internalHistory: History<P>

    internalHistory is used to manage undo/redo operations internally.

    -

    Private isUpdating

    isUpdating: boolean

    isUpdating is whether the document is updating by updater or not. It is +

    Returns void

    internalHistory

    internalHistory: History<P>

    internalHistory is used to manage undo/redo operations internally.

    +

    Private isUpdating

    isUpdating: boolean

    isUpdating is whether the document is updating by updater or not. It is used to prevent the updater from calling undo/redo.

    -

    Private key

    key: string

    Private localChanges

    localChanges: Change<P>[]

    Private onlineClients

    onlineClients: Set<string>

    onlineClients is a set of client IDs that are currently online.

    -

    Private opts

    opts: DocumentOptions

    Private presences

    presences: Map<string, P>

    presences is a map of client IDs to their presence information.

    -

    Private root

    root: CRDTRoot

    Private status

    status: DocStatus

    Methods

    addOnlineClient

    • addOnlineClient(clientID): void
    • Internal

      addOnlineClient adds the given clientID into the online client set.

      -

      Parameters

      • clientID: string

      Returns void

    applyChange

    applyChangePack

    • applyChangePack(pack): void
    • Internal

      applyChangePack applies the given change pack into this document.

      +

    Private key

    key: string

    Private localChanges

    localChanges: Change<P>[]

    Private onlineClients

    onlineClients: Set<string>

    onlineClients is a set of client IDs that are currently online.

    +

    Private opts

    opts: DocumentOptions

    Private presences

    presences: Map<string, P>

    presences is a map of client IDs to their presence information.

    +

    Private root

    root: CRDTRoot

    Private status

    status: DocStatus

    Methods

    addOnlineClient

    • addOnlineClient(clientID): void
    • Internal

      addOnlineClient adds the given clientID into the online client set.

      +

      Parameters

      • clientID: string

      Returns void

    applyChange

    applyChangePack

    • applyChangePack(pack): void
    • Internal

      applyChangePack applies the given change pack into this document.

      1. Remove local changes applied to server.
      2. Update the checkpoint.
      3. Do Garbage collection.

      Parameters

      • pack: ChangePack<P>

        change pack

        -

      Returns void

    applyChanges

    applyDocEvent

    applySnapshot

    • applySnapshot(serverSeq, snapshotVector, snapshot?, clientSeq?): void

    • applySnapshot applies the given snapshot into this document.

      -

      Parameters

      • serverSeq: bigint
      • snapshotVector: VersionVector
      • Optional snapshot: Uint8Array
      • clientSeq: number = -1

      Returns void

    applyStatus

    applyTransactionEvent

    applyWatchStream

    • applyWatchStream(resp): void

    • applyWatchStream applies the given watch stream response into this document.

      -

      Parameters

      • resp: WatchDocumentResponse

      Returns void

    broadcast

    • broadcast(topic, payload, options?): void

    • broadcast the payload to the given topic.

      -

      Parameters

      • topic: string
      • payload: Json
      • Optional options: BroadcastOptions

      Returns void

    Private canRedo

    • canRedo(): boolean

    • canRedo returns whether there are any operations to redo.

      -

      Returns boolean

    Private canUndo

    • canUndo(): boolean

    • canUndo returns whether there are any operations to undo.

      -

      Returns boolean

    createChangePack

    • createChangePack(): ChangePack<P>
    • Internal

      createChangePack create change pack of the local changes to send to the +

    Returns void

    applyChanges

    applyDocEvent

    applySnapshot

    applyStatus

    applyTransactionEvent

    applyWatchStream

    broadcast

    Private canRedo

    Private canUndo

    createChangePack

    ensureClone

    Private filterVersionVector

    garbageCollect

    getChangeID

    getCheckpoint

    getCloneRoot

    getGarbageLen

    getGarbageLenFromClone

    getKey

    getMyPresence

    getOthersForTest

    getPresence

    getPresenceForTest

    ensureClone

    Private filterVersionVector

    garbageCollect

    getChangeID

    getCheckpoint

    getCloneRoot

    getGarbageLen

    getGarbageLenFromClone

    getKey

    getMyPresence

    getOthersForTest

    getPresence

    getPresenceForTest

    getPresences

    getRedoStackForTest

    getRoot

    getRootObject

    getSelfForTest

    getStats

    getStatus

    getUndoStackForTest

    getValueByPath

    getVersionVector

    hasLocalChanges

    hasPresence

    isEnableDevtools

    Private isSameElementOrChildOf

    publish

    getPresences

    getRedoStackForTest

    getRoot

    getRootObject

    getSelfForTest

    getStats

    getStatus

    getUndoStackForTest

    getValueByPath

    getVersionVector

    hasLocalChanges

    hasPresence

    isEnableDevtools

    Private isSameElementOrChildOf

    publish

    Private redo

    Private redo

    removeOnlineClient

    Private removePushedLocalChanges

    removeOnlineClient

    Private removePushedLocalChanges

    resetOnlineClients

    setActor

    Returns void

    resetOnlineClients

    setActor

    setOnlineClients

    subscribe

    setOnlineClients

    subscribe

    toJSForTest

    toJSON

    toSortedJSON

    Private undo

    toJSForTest

    toJSON

    toSortedJSON

    Private undo

    update

    Settings

    Member Visibility

    Theme

    On This Page

    constructorchangeIDcheckpointcloneeventStreameventStreamObserverhistoryinternalHistoryisUpdatingkeylocalChangesonlineClientsoptspresencesrootstatusaddOnlineClientapplyChangeapplyChangePackapplyChangesapplyDocEventapplySnapshotapplyStatusapplyTransactionEventapplyWatchStreambroadcastcanRedocanUndocreateChangePackensureClonefilterVersionVectorgarbageCollectgetChangeIDgetCheckpointgetCloneRootgetGarbageLengetGarbageLenFromClonegetKeygetMyPresencegetOthersForTestgetPresencegetPresenceForTestgetPresencesgetRedoStackForTestgetRootgetRootObjectgetSelfForTestgetStatsgetStatusgetUndoStackForTestgetValueByPathgetVersionVectorhasLocalChangeshasPresenceisEnableDevtoolsisSameElementOrChildOfpublishredoremoveOnlineClientremovePushedLocalChangesresetOnlineClientssetActorsetOnlineClientssubscribetoJSForTesttoJSONtoSortedJSONundoupdate
    \ No newline at end of file +

    Returns void

    update

    Settings

    Member Visibility

    Theme

    On This Page

    constructorchangeIDcheckpointcloneeventStreameventStreamObserverhistoryinternalHistoryisUpdatingkeylocalChangesonlineClientsoptspresencesrootstatusaddOnlineClientapplyChangeapplyChangePackapplyChangesapplyDocEventapplySnapshotapplyStatusapplyTransactionEventapplyWatchStreambroadcastcanRedocanUndocreateChangePackensureClonefilterVersionVectorgarbageCollectgetChangeIDgetCheckpointgetCloneRootgetGarbageLengetGarbageLenFromClonegetKeygetMyPresencegetOthersForTestgetPresencegetPresenceForTestgetPresencesgetRedoStackForTestgetRootgetRootObjectgetSelfForTestgetStatsgetStatusgetUndoStackForTestgetValueByPathgetVersionVectorhasLocalChangeshasPresenceisEnableDevtoolsisSameElementOrChildOfpublishredoremoveOnlineClientremovePushedLocalChangesresetOnlineClientssetActorsetOnlineClientssubscribetoJSForTesttoJSONtoSortedJSONundoupdate
    \ No newline at end of file diff --git a/api-reference/classes/Primitive.html b/api-reference/classes/Primitive.html index 4f06d300d..b60b8eb94 100644 --- a/api-reference/classes/Primitive.html +++ b/api-reference/classes/Primitive.html @@ -1,6 +1,6 @@ Primitive | yorkie-js-sdk

    Class Primitive

    Primitive represents primitive data type including logical clock. It has a type and a value.

    -

    Hierarchy

    • CRDTElement
      • Primitive

    Constructors

    constructor +

    Hierarchy

    • CRDTElement
      • Primitive

    Constructors

    constructor

    Properties

    value valueType

    Methods

    deepcopy @@ -25,27 +25,27 @@ isSupport of valueFromBytes -

    Constructors

    constructor

    Properties

    Private value

    value: PrimitiveValue

    Private valueType

    valueType: PrimitiveType

    Methods

    deepcopy

    getCreatedAt

    getID

    getMovedAt

    getPositionedAt

    • getPositionedAt(): TimeTicket

    • getPositionedAt returns the time of this element when it was positioned +

    Constructors

    constructor

    Properties

    Private value

    value: PrimitiveValue

    Private valueType

    valueType: PrimitiveType

    Methods

    deepcopy

    getCreatedAt

    getID

    getMovedAt

    getPositionedAt

    • getPositionedAt(): TimeTicket

    • getPositionedAt returns the time of this element when it was positioned in the document by undo/redo or move operation.

      -

      Returns TimeTicket

    getRemovedAt

    getType

    getValue

    isNumericType

    isRemoved

    • isRemoved(): boolean

    • isRemoved check if this element was removed.

      -

      Returns boolean

    remove

    setMovedAt

    • setMovedAt(movedAt?): boolean

    • setMovedAt sets the move time of this element.

      -

      Parameters

      Returns boolean

    setRemovedAt

    • setRemovedAt(removedAt?): void

    • setRemovedAt sets the remove time of this element.

      -

      Parameters

      Returns void

    toBytes

    toJSForTest

    toJSON

    toSortedJSON

    • toSortedJSON(): string

    • toSortedJSON returns the sorted JSON encoding of the value.

      -

      Returns string

    Static getPrimitiveType

    • getPrimitiveType(value): undefined | PrimitiveType

    • getPrimitiveType returns the primitive type of the value.

      -

      Parameters

      • value: unknown

      Returns undefined | PrimitiveType

    Static isInteger

    • isInteger(num): boolean

    • isInteger checks if the given number is integer.

      -

      Parameters

      • num: number

      Returns boolean

    Static isSupport

    • isSupport(value): boolean

    • isSupport check if the given value is supported type.

      -

      Parameters

      • value: unknown

      Returns boolean

    Static of

    Static valueFromBytes

    Settings

    Member Visibility

    Theme

    On This Page

    constructorvaluevalueTypedeepcopygetCreatedAtgetIDgetMovedAtgetPositionedAtgetRemovedAtgetTypegetValueisNumericTypeisRemovedremovesetMovedAtsetRemovedAttoBytestoJSForTesttoJSONtoSortedJSONgetPrimitiveTypeisIntegerisSupportofvalueFromBytes
    \ No newline at end of file +

    Returns TimeTicket

    getRemovedAt

    getType

    getValue

    isNumericType

    isRemoved

    remove

    setMovedAt

    setRemovedAt

    toBytes

    toJSForTest

    toJSON

    toSortedJSON

    Static getPrimitiveType

    Static isInteger

    Static isSupport

    Static of

    Static valueFromBytes

    Settings

    Member Visibility

    Theme

    On This Page

    constructorvaluevalueTypedeepcopygetCreatedAtgetIDgetMovedAtgetPositionedAtgetRemovedAtgetTypegetValueisNumericTypeisRemovedremovesetMovedAtsetRemovedAttoBytestoJSForTesttoJSONtoSortedJSONgetPrimitiveTypeisIntegerisSupportofvalueFromBytes
    \ No newline at end of file diff --git a/api-reference/classes/Text.html b/api-reference/classes/Text.html index 4ff652844..47b2641d2 100644 --- a/api-reference/classes/Text.html +++ b/api-reference/classes/Text.html @@ -1,5 +1,5 @@ Text | yorkie-js-sdk

    Class Text<A>

    Text is an extended data type for the contents of a text editor.

    -

    Type Parameters

    Constructors

    constructor +

    Type Parameters

    Constructors

    constructor

    Properties

    context? text?

    Accessors

    length @@ -19,23 +19,23 @@ toString toTestString values -

    Constructors

    constructor

    Properties

    Private Optional context

    context?: ChangeContext<Indexable>

    Private Optional text

    text?: CRDTText<A>

    Accessors

    length

    Methods

    createRangeForTest

    • createRangeForTest(fromIdx, toIdx): RGATreeSplitPosRange

    • createRangeForTest returns pair of RGATreeSplitNodePos of the given indexes +

    Constructors

    constructor

    Properties

    Private Optional context

    context?: ChangeContext<Indexable>

    Private Optional text

    text?: CRDTText<A>

    Accessors

    length

    Methods

    createRangeForTest

    • createRangeForTest(fromIdx, toIdx): RGATreeSplitPosRange

    • createRangeForTest returns pair of RGATreeSplitNodePos of the given indexes for testing purpose.

      -

      Parameters

      • fromIdx: number
      • toIdx: number

      Returns RGATreeSplitPosRange

    delete

    • delete(fromIdx, toIdx): undefined | [number, number]

    • delete deletes the text in the given range.

      -

      Parameters

      • fromIdx: number
      • toIdx: number

      Returns undefined | [number, number]

    edit

    • edit(fromIdx, toIdx, content, attributes?): undefined | [number, number]

    • edit edits this text with the given content.

      -

      Parameters

      • fromIdx: number
      • toIdx: number
      • content: string
      • Optional attributes: A

      Returns undefined | [number, number]

    empty

    • empty(): undefined | [number, number]

    • empty makes the text empty.

      -

      Returns undefined | [number, number]

    getID

    getTreeByID

    • getTreeByID(): LLRBTree<RGATreeSplitNodeID, RGATreeSplitNode<CRDTTextValue>>

    • getTreeByID returns IDTree of the text for testing purpose.

      -

      Returns LLRBTree<RGATreeSplitNodeID, RGATreeSplitNode<CRDTTextValue>>

    getTreeByIndex

    • getTreeByIndex(): SplayTree<CRDTTextValue>

    • getTreeByIndex returns IndexTree of the text for testing purpose.

      -

      Returns SplayTree<CRDTTextValue>

    indexRangeToPosRange

    initialize

    • initialize(context, text): void
    • Internal

      initialize initialize this text with context and internal text.

      -

      Parameters

      • context: ChangeContext<Indexable>
      • text: CRDTText<A>

      Returns void

    posRangeToIndexRange

    setStyle

    • setStyle(fromIdx, toIdx, attributes): boolean

    • setStyle styles this text with the given attributes.

      -

      Parameters

      • fromIdx: number
      • toIdx: number
      • attributes: A

      Returns boolean

    toJSForTest

    toJSON

    toString

    • toString(): string

    • toString returns the string representation of this text.

      -

      Returns string

    toTestString

    • toTestString(): string

    • toTestString returns a String containing the meta data of the node +

      Parameters

      • fromIdx: number
      • toIdx: number

      Returns RGATreeSplitPosRange

    delete

    • delete(fromIdx, toIdx): undefined | [number, number]

    • delete deletes the text in the given range.

      +

      Parameters

      • fromIdx: number
      • toIdx: number

      Returns undefined | [number, number]

    edit

    • edit(fromIdx, toIdx, content, attributes?): undefined | [number, number]

    • edit edits this text with the given content.

      +

      Parameters

      • fromIdx: number
      • toIdx: number
      • content: string
      • Optional attributes: A

      Returns undefined | [number, number]

    empty

    • empty(): undefined | [number, number]

    • empty makes the text empty.

      +

      Returns undefined | [number, number]

    getID

    getTreeByID

    • getTreeByID(): LLRBTree<RGATreeSplitNodeID, RGATreeSplitNode<CRDTTextValue>>

    • getTreeByID returns IDTree of the text for testing purpose.

      +

      Returns LLRBTree<RGATreeSplitNodeID, RGATreeSplitNode<CRDTTextValue>>

    getTreeByIndex

    • getTreeByIndex(): SplayTree<CRDTTextValue>

    • getTreeByIndex returns IndexTree of the text for testing purpose.

      +

      Returns SplayTree<CRDTTextValue>

    indexRangeToPosRange

    initialize

    • initialize(context, text): void
    • Internal

      initialize initialize this text with context and internal text.

      +

      Parameters

      • context: ChangeContext<Indexable>
      • text: CRDTText<A>

      Returns void

    posRangeToIndexRange

    setStyle

    • setStyle(fromIdx, toIdx, attributes): boolean

    • setStyle styles this text with the given attributes.

      +

      Parameters

      • fromIdx: number
      • toIdx: number
      • attributes: A

      Returns boolean

    toJSForTest

    toJSON

    toString

    • toString(): string

    • toString returns the string representation of this text.

      +

      Returns string

    toTestString

    • toTestString(): string

    • toTestString returns a String containing the meta data of the node for debugging purpose.

      -

      Returns string

    values

    Settings

    Member Visibility

    Theme

    On This Page

    constructorcontexttextlengthcreateRangeForTestdeleteeditemptygetIDgetTreeByIDgetTreeByIndexindexRangeToPosRangeinitializeposRangeToIndexRangesetStyletoJSForTesttoJSONtoStringtoTestStringvalues
    \ No newline at end of file +

    Returns string

    values

    Settings

    Member Visibility

    Theme

    On This Page

    constructorcontexttextlengthcreateRangeForTestdeleteeditemptygetIDgetTreeByIDgetTreeByIndexindexRangeToPosRangeinitializeposRangeToIndexRangesetStyletoJSForTesttoJSONtoStringtoTestStringvalues
    \ No newline at end of file diff --git a/api-reference/classes/TimeTicket.html b/api-reference/classes/TimeTicket.html index aa7f7807e..f25eb06b7 100644 --- a/api-reference/classes/TimeTicket.html +++ b/api-reference/classes/TimeTicket.html @@ -1,6 +1,6 @@ TimeTicket | yorkie-js-sdk

    Class TimeTicket

    TimeTicket is a timestamp of the logical clock. Ticket is immutable. It is created by ChangeID.

    -

    Constructors

    constructor +

    Constructors

    constructor

    Properties

    actorID delimiter lamport @@ -17,20 +17,20 @@ toTestString fromStruct of -

    Constructors

    constructor

    Properties

    Private actorID

    actorID: string

    Private delimiter

    delimiter: number

    Private lamport

    lamport: bigint

    Methods

    after

    compare

    • compare(other): number

    • compare returns an integer comparing two Ticket. +

    Constructors

    constructor

    Properties

    Private actorID

    actorID: string

    Private delimiter

    delimiter: number

    Private lamport

    lamport: bigint

    Methods

    after

    compare

    • compare(other): number

    • compare returns an integer comparing two Ticket. The result will be 0 if id==other, -1 if id < other, and +1 if id > other. If the receiver or argument is nil, it would panic at runtime.

      -

      Parameters

      Returns number

    equals

    getActorID

    getDelimiter

    getLamport

    getLamportAsString

    setActor

    toIDString

    toStruct

    toTestString

    equals

    getActorID

    getDelimiter

    getLamport

    getLamportAsString

    setActor

    toIDString

    toStruct

    toTestString

    • toTestString(): string

    • toTestString returns a string containing the meta data of the ticket for debugging purpose.

      -

      Returns string

    Static fromStruct

    Static of

    Settings

    Member Visibility

    Theme

    On This Page

    constructoractorIDdelimiterlamportaftercompareequalsgetActorIDgetDelimitergetLamportgetLamportAsStringsetActortoIDStringtoStructtoTestStringfromStructof
    \ No newline at end of file +

    Returns string

    Static fromStruct

    Static of

    Settings

    Member Visibility

    Theme

    On This Page

    constructoractorIDdelimiterlamportaftercompareequalsgetActorIDgetDelimitergetLamportgetLamportAsStringsetActortoIDStringtoStructtoTestStringfromStructof
    \ No newline at end of file diff --git a/api-reference/classes/Tree.html b/api-reference/classes/Tree.html index 26614ddbc..32d2b1fdf 100644 --- a/api-reference/classes/Tree.html +++ b/api-reference/classes/Tree.html @@ -1,6 +1,6 @@ Tree | yorkie-js-sdk

    Class Tree

    Tree is a CRDT-based tree structure that is used to represent the document tree of text-based editor such as ProseMirror.

    -

    Constructors

    constructor +

    Constructors

    constructor

    Properties

    context? initialRoot? tree? @@ -29,29 +29,29 @@ toJSInfoForTest toJSON toXML -

    Constructors

    constructor

    Properties

    Private Optional context

    context?: ChangeContext<Indexable>

    Private Optional initialRoot

    initialRoot?: ElementNode

    Private Optional tree

    tree?: CRDTTree

    Methods

    buildRoot

    • buildRoot(context): CRDTTreeNode

    • buildRoot builds the root of this tree with the given initial root +

    Constructors

    constructor

    Properties

    Private Optional context

    context?: ChangeContext<Indexable>

    Private Optional initialRoot

    initialRoot?: ElementNode

    Private Optional tree

    tree?: CRDTTree

    Methods

    buildRoot

    • buildRoot(context): CRDTTreeNode

    • buildRoot builds the root of this tree with the given initial root which set by the user.

      -

      Parameters

      Returns CRDTTreeNode

    edit

    • edit(fromIdx, toIdx, content?, splitLevel?): boolean

    • edit edits this tree with the given nodes.

      -

      Parameters

      • fromIdx: number
      • toIdx: number
      • Optional content: TreeNode
      • splitLevel: number = 0

      Returns boolean

    editBulk

    • editBulk(fromIdx, toIdx, contents, splitLevel?): boolean

    • editBulk edits this tree with the given nodes.

      -

      Parameters

      • fromIdx: number
      • toIdx: number
      • contents: TreeNode[]
      • splitLevel: number = 0

      Returns boolean

    editBulkByPath

    • editBulkByPath(fromPath, toPath, contents, splitLevel?): boolean

    • editBulkByPath edits this tree with the given node and path.

      -

      Parameters

      • fromPath: number[]
      • toPath: number[]
      • contents: TreeNode[]
      • splitLevel: number = 0

      Returns boolean

    editByPath

    • editByPath(fromPath, toPath, content?, splitLevel?): boolean

    • editByPath edits this tree with the given node and path.

      -

      Parameters

      • fromPath: number[]
      • toPath: number[]
      • Optional content: TreeNode
      • splitLevel: number = 0

      Returns boolean

    Private editInternal

    • editInternal(fromPos, toPos, contents, splitLevel?): boolean

    • Parameters

      • fromPos: CRDTTreePos
      • toPos: CRDTTreePos
      • contents: TreeNode[]
      • splitLevel: number = 0

      Returns boolean

    getID

    getIndexTree

    • getIndexTree(): IndexTree<CRDTTreeNode>

    • getIndexTree returns the index tree of this tree.

      -

      Returns IndexTree<CRDTTreeNode>

    getNodeSize

    getRootTreeNode

    getSize

    indexRangeToPosRange

    indexToPath

    • indexToPath(index): number[]

    • indexToPath returns the path of the given index.

      -

      Parameters

      • index: number

      Returns number[]

    initialize

    • initialize(context, tree): void
    • Internal

      initialize initialize this tree with context and internal tree.

      -

      Parameters

      • context: ChangeContext<Indexable>
      • tree: CRDTTree

      Returns void

    pathRangeToPosRange

    pathToIndex

    • pathToIndex(path): number

    • pathToIndex returns the index of given path.

      -

      Parameters

      • path: number[]

      Returns number

    posRangeToIndexRange

    posRangeToPathRange

    • posRangeToPathRange(range): [number[], number[]]

    • posRangeToPathRange converts the position range into the path range.

      -

      Parameters

      Returns [number[], number[]]

    removeStyle

    • removeStyle(fromIdx, toIdx, attributesToRemove): void

    • removeStyle removes the attributes to the elements of the given range.

      -

      Parameters

      • fromIdx: number
      • toIdx: number
      • attributesToRemove: string[]

      Returns void

    style

    • style(fromIdx, toIdx, attributes): void

    • style sets the attributes to the elements of the given range.

      -

      Parameters

      • fromIdx: number
      • toIdx: number
      • attributes: {
            [key: string]: any;
        }
        • [key: string]: any

      Returns void

    styleByPath

    • styleByPath(path, attributes): void

    • styleByPath sets the attributes to the elements of the given path.

      -

      Parameters

      • path: number[]
      • attributes: {
            [key: string]: any;
        }
        • [key: string]: any

      Returns void

    toJSForTest

    toJSInfoForTest

    toJSON

    toXML

    Settings

    Member Visibility

    Theme

    On This Page

    constructorcontextinitialRoottreebuildRootediteditBulkeditBulkByPatheditByPatheditInternalgetIDgetIndexTreegetNodeSizegetRootTreeNodegetSizeindexRangeToPosRangeindexToPathinitializepathRangeToPosRangepathToIndexposRangeToIndexRangeposRangeToPathRangeremoveStylestylestyleByPathtoJSForTesttoJSInfoForTesttoJSONtoXML
    \ No newline at end of file +

    Parameters

    Returns CRDTTreeNode

    edit

    editBulk

    editBulkByPath

    editByPath

    Private editInternal

    getID

    getIndexTree

    getNodeSize

    getRootTreeNode

    getSize

    indexRangeToPosRange

    indexToPath

    initialize

    pathRangeToPosRange

    pathToIndex

    posRangeToIndexRange

    posRangeToPathRange

    removeStyle

    style

    styleByPath

    toJSForTest

    toJSInfoForTest

    toJSON

    toXML

    Settings

    Member Visibility

    Theme

    On This Page

    constructorcontextinitialRoottreebuildRootediteditBulkeditBulkByPatheditByPatheditInternalgetIDgetIndexTreegetNodeSizegetRootTreeNodegetSizeindexRangeToPosRangeindexToPathinitializepathRangeToPosRangepathToIndexposRangeToIndexRangeposRangeToPathRangeremoveStylestylestyleByPathtoJSForTesttoJSInfoForTesttoJSONtoXML
    \ No newline at end of file diff --git a/api-reference/classes/VersionVector.html b/api-reference/classes/VersionVector.html index 8914f3abc..875ac27b1 100644 --- a/api-reference/classes/VersionVector.html +++ b/api-reference/classes/VersionVector.html @@ -2,7 +2,7 @@ between changes whether they are causally related or concurrent. It is similar to vector clocks, but it is synced with lamport timestamp of the change.

    -

    Constructors

    constructor +

    Constructors

    constructor

    Properties

    vector

    Methods

    [iterator] afterOrEqual @@ -14,13 +14,13 @@ set size unset -

    Constructors

    constructor

    Properties

    Private vector

    vector: Map<string, bigint>

    Methods

    [iterator]

    afterOrEqual

    deepcopy

    filter

    get

    • get(actorID): undefined | bigint

    • get gets the lamport timestamp of the given actor.

      -

      Parameters

      • actorID: string

      Returns undefined | bigint

    max

    maxLamport

    set

    • set(actorID, lamport): void

    • set sets the lamport timestamp of the given actor.

      -

      Parameters

      • actorID: string
      • lamport: bigint

      Returns void

    size

    unset

    • unset(actorID): void

    • unset removes the version for the given actor from the VersionVector.

      -

      Parameters

      • actorID: string

      Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    constructorvector[iterator]afterOrEqualdeepcopyfiltergetmaxmaxLamportsetsizeunset
    \ No newline at end of file +

    Constructors

    constructor

    Properties

    Private vector

    vector: Map<string, bigint>

    Methods

    [iterator]

    afterOrEqual

    deepcopy

    filter

    get

    • get(actorID): undefined | bigint

    • get gets the lamport timestamp of the given actor.

      +

      Parameters

      • actorID: string

      Returns undefined | bigint

    max

    maxLamport

    set

    • set(actorID, lamport): void

    • set sets the lamport timestamp of the given actor.

      +

      Parameters

      • actorID: string
      • lamport: bigint

      Returns void

    size

    unset

    • unset(actorID): void

    • unset removes the version for the given actor from the VersionVector.

      +

      Parameters

      • actorID: string

      Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    constructorvector[iterator]afterOrEqualdeepcopyfiltergetmaxmaxLamportsetsizeunset
    \ No newline at end of file diff --git a/api-reference/enums/ClientCondition.html b/api-reference/enums/ClientCondition.html index 4a8c56134..f6679e0bf 100644 --- a/api-reference/enums/ClientCondition.html +++ b/api-reference/enums/ClientCondition.html @@ -1,6 +1,6 @@ ClientCondition | yorkie-js-sdk

    Enumeration ClientCondition

    ClientCondition represents the condition of the client.

    -

    Enumeration Members

    SyncLoop +

    Enumeration Members

    SyncLoop WatchLoop

    Enumeration Members

    SyncLoop

    SyncLoop: "SyncLoop"

    SyncLoop is a key of the sync loop condition.

    -

    WatchLoop

    WatchLoop: "WatchLoop"

    WatchLoop is a key of the watch loop condition.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    SyncLoopWatchLoop
    \ No newline at end of file +

    WatchLoop

    WatchLoop: "WatchLoop"

    WatchLoop is a key of the watch loop condition.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    SyncLoopWatchLoop
    \ No newline at end of file diff --git a/api-reference/enums/ClientStatus.html b/api-reference/enums/ClientStatus.html index e2fb483db..db681be30 100644 --- a/api-reference/enums/ClientStatus.html +++ b/api-reference/enums/ClientStatus.html @@ -1,9 +1,9 @@ ClientStatus | yorkie-js-sdk

    Enumeration ClientStatus

    ClientStatus represents the status of the client.

    -

    Enumeration Members

    Activated +

    Enumeration Members

    Activated Deactivated

    Enumeration Members

    Activated

    Activated: "activated"

    Activated means that the client is activated. If the client is activated, all Documents of the client are also ready to be used.

    -

    Deactivated

    Deactivated: "deactivated"

    Deactivated means that the client is not activated. It is the initial +

    Deactivated

    Deactivated: "deactivated"

    Deactivated means that the client is not activated. It is the initial status of the client. If the client is deactivated, all Documents of the client are also not used.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    ActivatedDeactivated
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    ActivatedDeactivated
    \ No newline at end of file diff --git a/api-reference/enums/DocEventType.html b/api-reference/enums/DocEventType.html index be87641a3..93e1102a2 100644 --- a/api-reference/enums/DocEventType.html +++ b/api-reference/enums/DocEventType.html @@ -1,5 +1,5 @@ DocEventType | yorkie-js-sdk

    Enumeration DocEventType

    DocEventType represents the type of the event that occurs in Document.

    -

    Enumeration Members

    AuthError +

    Enumeration Members

    AuthError Broadcast ConnectionChanged Initialized @@ -13,17 +13,17 @@ Unwatched Watched

    Enumeration Members

    AuthError

    AuthError: "auth-error"

    AuthError indicates an authorization failure in syncLoop or watchLoop.

    -

    Broadcast

    Broadcast: "broadcast"

    Broadcast means that the broadcast event is received from the remote client.

    -

    ConnectionChanged

    ConnectionChanged: "connection-changed"

    ConnectionChanged means that the watch stream connection status has changed.

    -

    Initialized

    Initialized: "initialized"

    Initialized means that online clients have been loaded from the server.

    -

    LocalBroadcast

    LocalBroadcast: "local-broadcast"

    LocalBroadcast means that the broadcast event is sent from the local client.

    -

    LocalChange

    LocalChange: "local-change"

    local document change event type

    -

    PresenceChanged

    PresenceChanged: "presence-changed"

    PresenceChanged means that the presences of the client has updated.

    -

    RemoteChange

    RemoteChange: "remote-change"

    remote document change event type

    -

    Snapshot

    Snapshot: "snapshot"

    snapshot event type

    -

    StatusChanged

    StatusChanged: "status-changed"

    status changed event type

    -

    SyncStatusChanged

    SyncStatusChanged: "sync-status-changed"

    SyncStatusChanged means that the document sync status has changed.

    -

    Unwatched

    Unwatched: "unwatched"

    Unwatched means that the connection has been disconnected.

    -

    Watched

    Watched: "watched"

    Watched means that the client has established a connection with the server, +

    Broadcast

    Broadcast: "broadcast"

    Broadcast means that the broadcast event is received from the remote client.

    +

    ConnectionChanged

    ConnectionChanged: "connection-changed"

    ConnectionChanged means that the watch stream connection status has changed.

    +

    Initialized

    Initialized: "initialized"

    Initialized means that online clients have been loaded from the server.

    +

    LocalBroadcast

    LocalBroadcast: "local-broadcast"

    LocalBroadcast means that the broadcast event is sent from the local client.

    +

    LocalChange

    LocalChange: "local-change"

    local document change event type

    +

    PresenceChanged

    PresenceChanged: "presence-changed"

    PresenceChanged means that the presences of the client has updated.

    +

    RemoteChange

    RemoteChange: "remote-change"

    remote document change event type

    +

    Snapshot

    Snapshot: "snapshot"

    snapshot event type

    +

    StatusChanged

    StatusChanged: "status-changed"

    status changed event type

    +

    SyncStatusChanged

    SyncStatusChanged: "sync-status-changed"

    SyncStatusChanged means that the document sync status has changed.

    +

    Unwatched

    Unwatched: "unwatched"

    Unwatched means that the connection has been disconnected.

    +

    Watched

    Watched: "watched"

    Watched means that the client has established a connection with the server, enabling real-time synchronization.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    AuthErrorBroadcastConnectionChangedInitializedLocalBroadcastLocalChangePresenceChangedRemoteChangeSnapshotStatusChangedSyncStatusChangedUnwatchedWatched
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    AuthErrorBroadcastConnectionChangedInitializedLocalBroadcastLocalChangePresenceChangedRemoteChangeSnapshotStatusChangedSyncStatusChangedUnwatchedWatched
    \ No newline at end of file diff --git a/api-reference/enums/DocStatus.html b/api-reference/enums/DocStatus.html index 9310146c2..c70c9c89f 100644 --- a/api-reference/enums/DocStatus.html +++ b/api-reference/enums/DocStatus.html @@ -1,11 +1,11 @@ DocStatus | yorkie-js-sdk

    Enumeration DocStatus

    DocStatus represents the status of the document.

    -

    Enumeration Members

    Attached +

    Enumeration Members

    Attached Detached Removed

    Enumeration Members

    Attached

    Attached: "attached"

    Attached means that this document is attached to the client. The actor of the ticket is created with being assigned by the client.

    -

    Detached

    Detached: "detached"

    Detached means that the document is not attached to the client. +

    Detached

    Detached: "detached"

    Detached means that the document is not attached to the client. The actor of the ticket is created without being assigned.

    -

    Removed

    Removed: "removed"

    Removed means that this document is removed. If the document is removed, +

    Removed

    Removed: "removed"

    Removed means that this document is removed. If the document is removed, it cannot be edited.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    AttachedDetachedRemoved
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    AttachedDetachedRemoved
    \ No newline at end of file diff --git a/api-reference/enums/DocSyncStatus.html b/api-reference/enums/DocSyncStatus.html index e841ebcab..00a557fe3 100644 --- a/api-reference/enums/DocSyncStatus.html +++ b/api-reference/enums/DocSyncStatus.html @@ -1,6 +1,6 @@ DocSyncStatus | yorkie-js-sdk

    Enumeration DocSyncStatus

    DocSyncStatus represents the result of synchronizing the document with the server.

    -

    Enumeration Members

    SyncFailed +

    Enumeration Members

    SyncFailed Synced

    Enumeration Members

    SyncFailed

    SyncFailed: "sync-failed"

    SyncFiled means that document synchronization has failed.

    -

    Synced

    Synced: "synced"

    Synced means that document synced successfully.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    SyncFailedSynced
    \ No newline at end of file +

    Synced

    Synced: "synced"

    Synced means that document synced successfully.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    SyncFailedSynced
    \ No newline at end of file diff --git a/api-reference/enums/LogLevel.html b/api-reference/enums/LogLevel.html index 6484c8fad..efe136666 100644 --- a/api-reference/enums/LogLevel.html +++ b/api-reference/enums/LogLevel.html @@ -1,7 +1,7 @@ -LogLevel | yorkie-js-sdk

    Enumeration LogLevel

    Enumeration Members

    Debug +LogLevel | yorkie-js-sdk

    Enumeration LogLevel

    Enumeration Members

    Debug Error Fatal Info Trivial Warn -

    Enumeration Members

    Debug

    Debug: 1

    Error

    Error: 4

    Fatal

    Fatal: 5

    Info

    Info: 2

    Trivial

    Trivial: 0

    Warn

    Warn: 3

    Settings

    Member Visibility

    Theme

    On This Page

    DebugErrorFatalInfoTrivialWarn
    \ No newline at end of file +

    Enumeration Members

    Debug

    Debug: 1

    Error

    Error: 4

    Fatal

    Fatal: 5

    Info

    Info: 2

    Trivial

    Trivial: 0

    Warn

    Warn: 3

    Settings

    Member Visibility

    Theme

    On This Page

    DebugErrorFatalInfoTrivialWarn
    \ No newline at end of file diff --git a/api-reference/enums/OpSource.html b/api-reference/enums/OpSource.html index 283f65b0c..f17757397 100644 --- a/api-reference/enums/OpSource.html +++ b/api-reference/enums/OpSource.html @@ -1,7 +1,7 @@ OpSource | yorkie-js-sdk

    Enumeration OpSource

    OpSource represents the source of the operation. It is used to handle corner cases in the operations created by undo/redo allow the removed elements when executing them.

    -

    Enumeration Members

    Local +

    Enumeration Members

    Local Remote UndoRedo -

    Enumeration Members

    Local

    Local: "local"

    Remote

    Remote: "remote"

    UndoRedo

    UndoRedo: "undoredo"

    Settings

    Member Visibility

    Theme

    On This Page

    LocalRemoteUndoRedo
    \ No newline at end of file +

    Enumeration Members

    Local

    Local: "local"

    Remote

    Remote: "remote"

    UndoRedo

    UndoRedo: "undoredo"

    Settings

    Member Visibility

    Theme

    On This Page

    LocalRemoteUndoRedo
    \ No newline at end of file diff --git a/api-reference/enums/StreamConnectionStatus.html b/api-reference/enums/StreamConnectionStatus.html index dcb1b3ff6..e6c915230 100644 --- a/api-reference/enums/StreamConnectionStatus.html +++ b/api-reference/enums/StreamConnectionStatus.html @@ -1,6 +1,6 @@ StreamConnectionStatus | yorkie-js-sdk

    Enumeration StreamConnectionStatus

    StreamConnectionStatus represents whether the stream connection is connected or not.

    -

    Enumeration Members

    Connected +

    Enumeration Members

    Connected Disconnected

    Enumeration Members

    Connected

    Connected: "connected"

    Connected means that the stream connection is connected.

    -

    Disconnected

    Disconnected: "disconnected"

    Disconnected means that the stream connection is disconnected.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    ConnectedDisconnected
    \ No newline at end of file +

    Disconnected

    Disconnected: "disconnected"

    Disconnected means that the stream connection is disconnected.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    ConnectedDisconnected
    \ No newline at end of file diff --git a/api-reference/enums/SyncMode.html b/api-reference/enums/SyncMode.html index 38dbe5b5d..35e310d6e 100644 --- a/api-reference/enums/SyncMode.html +++ b/api-reference/enums/SyncMode.html @@ -1,11 +1,11 @@ SyncMode | yorkie-js-sdk

    Enumeration SyncMode

    SyncMode defines synchronization modes for the PushPullChanges API.

    -

    Enumeration Members

    Manual +

    Enumeration Members

    Manual Realtime RealtimePushOnly RealtimeSyncOff

    Enumeration Members

    Manual

    Manual: "manual"

    Manual mode indicates that changes are not automatically pushed or pulled.

    -

    Realtime

    Realtime: "realtime"

    Realtime mode indicates that changes are automatically pushed and pulled.

    -

    RealtimePushOnly

    RealtimePushOnly: "realtime-pushonly"

    RealtimePushOnly mode indicates that only local changes are automatically pushed.

    -

    RealtimeSyncOff

    RealtimeSyncOff: "realtime-syncoff"

    RealtimeSyncOff mode indicates that changes are not automatically pushed or pulled, +

    Realtime

    Realtime: "realtime"

    Realtime mode indicates that changes are automatically pushed and pulled.

    +

    RealtimePushOnly

    RealtimePushOnly: "realtime-pushonly"

    RealtimePushOnly mode indicates that only local changes are automatically pushed.

    +

    RealtimeSyncOff

    RealtimeSyncOff: "realtime-syncoff"

    RealtimeSyncOff mode indicates that changes are not automatically pushed or pulled, but the watch stream is kept active.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    ManualRealtimeRealtimePushOnlyRealtimeSyncOff
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    ManualRealtimeRealtimePushOnlyRealtimeSyncOff
    \ No newline at end of file diff --git a/api-reference/enums/TreeChangeType.html b/api-reference/enums/TreeChangeType.html index b2351d58d..72a224949 100644 --- a/api-reference/enums/TreeChangeType.html +++ b/api-reference/enums/TreeChangeType.html @@ -1,5 +1,5 @@ TreeChangeType | yorkie-js-sdk

    Enumeration TreeChangeType

    TreeChangeType represents the type of change in the tree.

    -

    Enumeration Members

    Content +

    Enumeration Members

    Content RemoveStyle Style -

    Enumeration Members

    Content

    Content: "content"

    RemoveStyle

    RemoveStyle: "removeStyle"

    Style

    Style: "style"

    Settings

    Member Visibility

    Theme

    On This Page

    ContentRemoveStyleStyle
    \ No newline at end of file +

    Enumeration Members

    Content

    Content: "content"

    RemoveStyle

    RemoveStyle: "removeStyle"

    Style

    Style: "style"

    Settings

    Member Visibility

    Theme

    On This Page

    ContentRemoveStyleStyle
    \ No newline at end of file diff --git a/api-reference/interfaces/ChangeInfo.html b/api-reference/interfaces/ChangeInfo.html index c21a8ed37..5fc25a876 100644 --- a/api-reference/interfaces/ChangeInfo.html +++ b/api-reference/interfaces/ChangeInfo.html @@ -1,8 +1,8 @@ ChangeInfo | yorkie-js-sdk

    Interface ChangeInfo<T>

    ChangeInfo represents the modifications made during a document update and the message passed.

    -
    interface ChangeInfo<T> {
        actor: string;
        clientSeq: number;
        message: string;
        operations: T[];
        serverSeq: string;
    }

    Type Parameters

    Properties

    actor +
    interface ChangeInfo<T> {
        actor: string;
        clientSeq: number;
        message: string;
        operations: T[];
        serverSeq: string;
    }

    Type Parameters

    Properties

    actor clientSeq message operations serverSeq -

    Properties

    actor

    actor: string

    clientSeq

    clientSeq: number

    message

    message: string

    operations

    operations: T[]

    serverSeq

    serverSeq: string

    Settings

    Member Visibility

    Theme

    On This Page

    actorclientSeqmessageoperationsserverSeq
    \ No newline at end of file +

    Properties

    actor

    actor: string

    clientSeq

    clientSeq: number

    message

    message: string

    operations

    operations: T[]

    serverSeq

    serverSeq: string

    Settings

    Member Visibility

    Theme

    On This Page

    actorclientSeqmessageoperationsserverSeq
    \ No newline at end of file diff --git a/api-reference/interfaces/ClientOptions.html b/api-reference/interfaces/ClientOptions.html index ef349fa66..fdfdb46fd 100644 --- a/api-reference/interfaces/ClientOptions.html +++ b/api-reference/interfaces/ClientOptions.html @@ -1,5 +1,5 @@ ClientOptions | yorkie-js-sdk

    Interface ClientOptions

    ClientOptions are user-settable options used when defining clients.

    -
    interface ClientOptions {
        apiKey?: string;
        authTokenInjector?: ((reason?) => Promise<string>);
        key?: string;
        reconnectStreamDelay?: number;
        retrySyncLoopDelay?: number;
        syncLoopDuration?: number;
    }

    Properties

    apiKey? +
    interface ClientOptions {
        apiKey?: string;
        authTokenInjector?: ((reason?) => Promise<string>);
        key?: string;
        reconnectStreamDelay?: number;
        retrySyncLoopDelay?: number;
        syncLoopDuration?: number;
    }

    Properties

    apiKey? authTokenInjector? key? reconnectStreamDelay? @@ -7,18 +7,18 @@ syncLoopDuration?

    Properties

    Optional apiKey

    apiKey?: string

    apiKey is the API key of the project. It is used to identify the project. If not set, API key of the default project is used.

    -

    Optional authTokenInjector

    authTokenInjector?: ((reason?) => Promise<string>)

    authTokenInjector is a function that provides a token for the auth webhook. +

    Optional authTokenInjector

    authTokenInjector?: ((reason?) => Promise<string>)

    authTokenInjector is a function that provides a token for the auth webhook. When the webhook response status code is 401, this function is called to refresh the token. The reason parameter is the reason from the webhook response.

    -

    Type declaration

      • (reason?): Promise<string>

      • Parameters

        • Optional reason: string

        Returns Promise<string>

    Optional key

    key?: string

    key is the client key. It is used to identify the client. +

    Type declaration

      • (reason?): Promise<string>

      • Parameters

        • Optional reason: string

        Returns Promise<string>

    Optional key

    key?: string

    key is the client key. It is used to identify the client. If not set, a random key is generated.

    -

    Optional reconnectStreamDelay

    reconnectStreamDelay?: number

    reconnectStreamDelay is the delay of the reconnect stream. If the stream +

    Optional reconnectStreamDelay

    reconnectStreamDelay?: number

    reconnectStreamDelay is the delay of the reconnect stream. If the stream is disconnected, the client waits for the delay to reconnect the stream. The default value is 1000(ms).

    -

    Optional retrySyncLoopDelay

    retrySyncLoopDelay?: number

    retrySyncLoopDelay is the delay of the retry sync loop. If the sync loop +

    Optional retrySyncLoopDelay

    retrySyncLoopDelay?: number

    retrySyncLoopDelay is the delay of the retry sync loop. If the sync loop fails, the client waits for the delay to retry the sync loop. The default value is 1000(ms).

    -

    Optional syncLoopDuration

    syncLoopDuration?: number

    syncLoopDuration is the duration of the sync loop. After each sync loop, +

    Optional syncLoopDuration

    syncLoopDuration?: number

    syncLoopDuration is the duration of the sync loop. After each sync loop, the client waits for the duration to next sync. The default value is 50(ms).

    -

    Settings

    Member Visibility

    Theme

    On This Page

    apiKeyauthTokenInjectorkeyreconnectStreamDelayretrySyncLoopDelaysyncLoopDuration
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    apiKeyauthTokenInjectorkeyreconnectStreamDelayretrySyncLoopDelaysyncLoopDuration
    \ No newline at end of file diff --git a/api-reference/interfaces/ConnectionChangedEvent.html b/api-reference/interfaces/ConnectionChangedEvent.html index fdaf2c614..c340d20b4 100644 --- a/api-reference/interfaces/ConnectionChangedEvent.html +++ b/api-reference/interfaces/ConnectionChangedEvent.html @@ -1,5 +1,5 @@ ConnectionChangedEvent | yorkie-js-sdk

    Interface ConnectionChangedEvent

    ConnectionChangedEvent is an event that occurs when the stream connection state changes.

    -
    interface ConnectionChangedEvent {
        type: ConnectionChanged;
        value: StreamConnectionStatus;
    }

    Hierarchy

    • BaseDocEvent
      • ConnectionChangedEvent

    Properties

    type +
    interface ConnectionChangedEvent {
        type: ConnectionChanged;
        value: StreamConnectionStatus;
    }

    Hierarchy

    • BaseDocEvent
      • ConnectionChangedEvent

    Properties

    type value

    Properties

    type

    type: ConnectionChanged

    enum DocEventType.ConnectionChanged

    -

    value

    value: StreamConnectionStatus

    Settings

    Member Visibility

    Theme

    On This Page

    typevalue
    \ No newline at end of file +

    value

    value: StreamConnectionStatus

    Settings

    Member Visibility

    Theme

    On This Page

    typevalue
    \ No newline at end of file diff --git a/api-reference/interfaces/InitializedEvent.html b/api-reference/interfaces/InitializedEvent.html index 3b5b5ec47..d67e131c4 100644 --- a/api-reference/interfaces/InitializedEvent.html +++ b/api-reference/interfaces/InitializedEvent.html @@ -1,4 +1,4 @@ -InitializedEvent | yorkie-js-sdk

    Interface InitializedEvent<P>

    interface InitializedEvent<P> {
        source: Local;
        type: Initialized;
        value: {
            clientID: string;
            presence: P;
        }[];
    }

    Type Parameters

    Hierarchy

    • BaseDocEvent
      • InitializedEvent

    Properties

    source +InitializedEvent | yorkie-js-sdk

    Interface InitializedEvent<P>

    interface InitializedEvent<P> {
        source: Local;
        type: Initialized;
        value: {
            clientID: string;
            presence: P;
        }[];
    }

    Type Parameters

    Hierarchy

    • BaseDocEvent
      • InitializedEvent

    Properties

    source type value -

    Properties

    source

    source: Local

    type

    type: Initialized

    value

    value: {
        clientID: string;
        presence: P;
    }[]

    Type declaration

    • clientID: string
    • presence: P

    Settings

    Member Visibility

    Theme

    On This Page

    sourcetypevalue
    \ No newline at end of file +

    Properties

    source

    source: Local

    type

    type: Initialized

    value

    value: {
        clientID: string;
        presence: P;
    }[]

    Type declaration

    • clientID: string
    • presence: P

    Settings

    Member Visibility

    Theme

    On This Page

    sourcetypevalue
    \ No newline at end of file diff --git a/api-reference/interfaces/LocalChangeEvent.html b/api-reference/interfaces/LocalChangeEvent.html index b29a5d327..06751e0d9 100644 --- a/api-reference/interfaces/LocalChangeEvent.html +++ b/api-reference/interfaces/LocalChangeEvent.html @@ -1,8 +1,8 @@ LocalChangeEvent | yorkie-js-sdk

    Interface LocalChangeEvent<T, P>

    LocalChangeEvent is an event that occurs when the document is changed by local changes.

    -
    interface LocalChangeEvent<T, P> {
        rawChange?: ChangeStruct<P>;
        source: Local | UndoRedo;
        type: LocalChange;
        value: ChangeInfo<T>;
    }

    Type Parameters

    Hierarchy

    • BaseDocEvent
      • LocalChangeEvent

    Properties

    rawChange? +
    interface LocalChangeEvent<T, P> {
        rawChange?: ChangeStruct<P>;
        source: Local | UndoRedo;
        type: LocalChange;
        value: ChangeInfo<T>;
    }

    Type Parameters

    Hierarchy

    • BaseDocEvent
      • LocalChangeEvent

    Properties

    rawChange? source type value -

    Properties

    Optional rawChange

    rawChange?: ChangeStruct<P>

    source

    source: Local | UndoRedo

    type

    type: LocalChange

    enum DocEventType.LocalChange

    -

    value

    value: ChangeInfo<T>

    Settings

    Member Visibility

    Theme

    On This Page

    rawChangesourcetypevalue
    \ No newline at end of file +

    Properties

    Optional rawChange

    rawChange?: ChangeStruct<P>

    source

    source: Local | UndoRedo

    type

    type: LocalChange

    enum DocEventType.LocalChange

    +

    value

    value: ChangeInfo<T>

    Settings

    Member Visibility

    Theme

    On This Page

    rawChangesourcetypevalue
    \ No newline at end of file diff --git a/api-reference/interfaces/Observable.html b/api-reference/interfaces/Observable.html index 34943a90d..55f605634 100644 --- a/api-reference/interfaces/Observable.html +++ b/api-reference/interfaces/Observable.html @@ -1,3 +1,3 @@ -Observable | yorkie-js-sdk

    Interface Observable<T>

    interface Observable<T> {
        getProxy?: (() => ObserverProxy<T>);
        subscribe: SubscribeFn<T>;
    }

    Type Parameters

    • T

    Properties

    getProxy? +Observable | yorkie-js-sdk

    Interface Observable<T>

    interface Observable<T> {
        getProxy?: (() => ObserverProxy<T>);
        subscribe: SubscribeFn<T>;
    }

    Type Parameters

    • T

    Properties

    getProxy? subscribe -

    Properties

    Optional getProxy

    getProxy?: (() => ObserverProxy<T>)

    Type declaration

      • (): ObserverProxy<T>

      • Returns ObserverProxy<T>

    subscribe

    subscribe: SubscribeFn<T>

    Settings

    Member Visibility

    Theme

    On This Page

    getProxysubscribe
    \ No newline at end of file +

    Properties

    Optional getProxy

    getProxy?: (() => ObserverProxy<T>)

    Type declaration

      • (): ObserverProxy<T>

      • Returns ObserverProxy<T>

    subscribe

    subscribe: SubscribeFn<T>

    Settings

    Member Visibility

    Theme

    On This Page

    getProxysubscribe
    \ No newline at end of file diff --git a/api-reference/interfaces/Observer.html b/api-reference/interfaces/Observer.html index a2a2ed011..8669d30ba 100644 --- a/api-reference/interfaces/Observer.html +++ b/api-reference/interfaces/Observer.html @@ -1,4 +1,4 @@ -Observer | yorkie-js-sdk

    Interface Observer<T>

    interface Observer<T> {
        complete?: CompleteFn;
        error?: ErrorFn;
        next: NextFn<T>;
    }

    Type Parameters

    • T

    Properties

    complete? +Observer | yorkie-js-sdk

    Interface Observer<T>

    interface Observer<T> {
        complete?: CompleteFn;
        error?: ErrorFn;
        next: NextFn<T>;
    }

    Type Parameters

    • T

    Properties

    complete? error? next -

    Properties

    Optional complete

    complete?: CompleteFn

    Optional error

    error?: ErrorFn

    next

    next: NextFn<T>

    Settings

    Member Visibility

    Theme

    On This Page

    completeerrornext
    \ No newline at end of file +

    Properties

    Optional complete

    complete?: CompleteFn

    Optional error

    error?: ErrorFn

    next

    next: NextFn<T>

    Settings

    Member Visibility

    Theme

    On This Page

    completeerrornext
    \ No newline at end of file diff --git a/api-reference/interfaces/PresenceChangedEvent.html b/api-reference/interfaces/PresenceChangedEvent.html index 977e12529..35646baeb 100644 --- a/api-reference/interfaces/PresenceChangedEvent.html +++ b/api-reference/interfaces/PresenceChangedEvent.html @@ -1,4 +1,4 @@ -PresenceChangedEvent | yorkie-js-sdk

    Interface PresenceChangedEvent<P>

    interface PresenceChangedEvent<P> {
        source: OpSource;
        type: PresenceChanged;
        value: {
            clientID: string;
            presence: P;
        };
    }

    Type Parameters

    Hierarchy

    • BaseDocEvent
      • PresenceChangedEvent

    Properties

    source +PresenceChangedEvent | yorkie-js-sdk

    Interface PresenceChangedEvent<P>

    interface PresenceChangedEvent<P> {
        source: OpSource;
        type: PresenceChanged;
        value: {
            clientID: string;
            presence: P;
        };
    }

    Type Parameters

    Hierarchy

    • BaseDocEvent
      • PresenceChangedEvent

    Properties

    source type value -

    Properties

    source

    source: OpSource

    type

    type: PresenceChanged

    value

    value: {
        clientID: string;
        presence: P;
    }

    Type declaration

    • clientID: string
    • presence: P

    Settings

    Member Visibility

    Theme

    On This Page

    sourcetypevalue
    \ No newline at end of file +

    Properties

    source

    source: OpSource

    type

    type: PresenceChanged

    value

    value: {
        clientID: string;
        presence: P;
    }

    Type declaration

    • clientID: string
    • presence: P

    Settings

    Member Visibility

    Theme

    On This Page

    sourcetypevalue
    \ No newline at end of file diff --git a/api-reference/interfaces/RemoteChangeEvent.html b/api-reference/interfaces/RemoteChangeEvent.html index 8820a0f70..60c61e1d4 100644 --- a/api-reference/interfaces/RemoteChangeEvent.html +++ b/api-reference/interfaces/RemoteChangeEvent.html @@ -1,8 +1,8 @@ RemoteChangeEvent | yorkie-js-sdk

    Interface RemoteChangeEvent<T, P>

    RemoteChangeEvent is an event that occurs when the document is changed by remote changes.

    -
    interface RemoteChangeEvent<T, P> {
        rawChange?: ChangeStruct<P>;
        source: Remote;
        type: RemoteChange;
        value: ChangeInfo<T>;
    }

    Type Parameters

    Hierarchy

    • BaseDocEvent
      • RemoteChangeEvent

    Properties

    rawChange? +
    interface RemoteChangeEvent<T, P> {
        rawChange?: ChangeStruct<P>;
        source: Remote;
        type: RemoteChange;
        value: ChangeInfo<T>;
    }

    Type Parameters

    Hierarchy

    • BaseDocEvent
      • RemoteChangeEvent

    Properties

    rawChange? source type value -

    Properties

    Optional rawChange

    rawChange?: ChangeStruct<P>

    source

    source: Remote

    type

    type: RemoteChange

    enum DocEventType.RemoteChange

    -

    value

    value: ChangeInfo<T>

    Settings

    Member Visibility

    Theme

    On This Page

    rawChangesourcetypevalue
    \ No newline at end of file +

    Properties

    Optional rawChange

    rawChange?: ChangeStruct<P>

    source

    source: Remote

    type

    type: RemoteChange

    enum DocEventType.RemoteChange

    +

    value

    value: ChangeInfo<T>

    Settings

    Member Visibility

    Theme

    On This Page

    rawChangesourcetypevalue
    \ No newline at end of file diff --git a/api-reference/interfaces/SnapshotEvent.html b/api-reference/interfaces/SnapshotEvent.html index d6397fecd..95f3cc197 100644 --- a/api-reference/interfaces/SnapshotEvent.html +++ b/api-reference/interfaces/SnapshotEvent.html @@ -1,7 +1,7 @@ SnapshotEvent | yorkie-js-sdk

    Interface SnapshotEvent

    SnapshotEvent is an event that occurs when a snapshot is received from the server.

    -
    interface SnapshotEvent {
        source: Remote;
        type: Snapshot;
        value: {
            serverSeq: string;
            snapshot: undefined | string;
            snapshotVector: string;
        };
    }

    Hierarchy

    • BaseDocEvent
      • SnapshotEvent

    Properties

    source +
    interface SnapshotEvent {
        source: Remote;
        type: Snapshot;
        value: {
            serverSeq: string;
            snapshot: undefined | string;
            snapshotVector: string;
        };
    }

    Hierarchy

    • BaseDocEvent
      • SnapshotEvent

    Properties

    source type value -

    Properties

    source

    source: Remote

    type

    type: Snapshot

    enum DocEventType.Snapshot

    -

    value

    value: {
        serverSeq: string;
        snapshot: undefined | string;
        snapshotVector: string;
    }

    Type declaration

    • serverSeq: string
    • snapshot: undefined | string
    • snapshotVector: string

    Settings

    Member Visibility

    Theme

    On This Page

    sourcetypevalue
    \ No newline at end of file +

    Properties

    source

    source: Remote

    type

    type: Snapshot

    enum DocEventType.Snapshot

    +

    value

    value: {
        serverSeq: string;
        snapshot: undefined | string;
        snapshotVector: string;
    }

    Type declaration

    • serverSeq: string
    • snapshot: undefined | string
    • snapshotVector: string

    Settings

    Member Visibility

    Theme

    On This Page

    sourcetypevalue
    \ No newline at end of file diff --git a/api-reference/interfaces/SyncStatusChangedEvent.html b/api-reference/interfaces/SyncStatusChangedEvent.html index d65833bce..fd607b865 100644 --- a/api-reference/interfaces/SyncStatusChangedEvent.html +++ b/api-reference/interfaces/SyncStatusChangedEvent.html @@ -1,5 +1,5 @@ SyncStatusChangedEvent | yorkie-js-sdk

    Interface SyncStatusChangedEvent

    SyncStatusChangedEvent is an event that occurs when document is synced with the server.

    -
    interface SyncStatusChangedEvent {
        type: SyncStatusChanged;
        value: DocSyncStatus;
    }

    Hierarchy

    • BaseDocEvent
      • SyncStatusChangedEvent

    Properties

    type +
    interface SyncStatusChangedEvent {
        type: SyncStatusChanged;
        value: DocSyncStatus;
    }

    Hierarchy

    • BaseDocEvent
      • SyncStatusChangedEvent

    Properties

    type value

    Properties

    type

    type: SyncStatusChanged

    enum DocEventType.SyncStatusChanged

    -

    value

    value: DocSyncStatus

    Settings

    Member Visibility

    Theme

    On This Page

    typevalue
    \ No newline at end of file +

    value

    value: DocSyncStatus

    Settings

    Member Visibility

    Theme

    On This Page

    typevalue
    \ No newline at end of file diff --git a/api-reference/interfaces/UnwatchedEvent.html b/api-reference/interfaces/UnwatchedEvent.html index 872492506..d370d823e 100644 --- a/api-reference/interfaces/UnwatchedEvent.html +++ b/api-reference/interfaces/UnwatchedEvent.html @@ -1,4 +1,4 @@ -UnwatchedEvent | yorkie-js-sdk

    Interface UnwatchedEvent<P>

    interface UnwatchedEvent<P> {
        source: Remote;
        type: Unwatched;
        value: {
            clientID: string;
            presence: P;
        };
    }

    Type Parameters

    Hierarchy

    • BaseDocEvent
      • UnwatchedEvent

    Properties

    source +UnwatchedEvent | yorkie-js-sdk

    Interface UnwatchedEvent<P>

    interface UnwatchedEvent<P> {
        source: Remote;
        type: Unwatched;
        value: {
            clientID: string;
            presence: P;
        };
    }

    Type Parameters

    Hierarchy

    • BaseDocEvent
      • UnwatchedEvent

    Properties

    source type value -

    Properties

    source

    source: Remote

    type

    type: Unwatched

    value

    value: {
        clientID: string;
        presence: P;
    }

    Type declaration

    • clientID: string
    • presence: P

    Settings

    Member Visibility

    Theme

    On This Page

    sourcetypevalue
    \ No newline at end of file +

    Properties

    source

    source: Remote

    type

    type: Unwatched

    value

    value: {
        clientID: string;
        presence: P;
    }

    Type declaration

    • clientID: string
    • presence: P

    Settings

    Member Visibility

    Theme

    On This Page

    sourcetypevalue
    \ No newline at end of file diff --git a/api-reference/interfaces/WatchedEvent.html b/api-reference/interfaces/WatchedEvent.html index 021b26509..be7b15589 100644 --- a/api-reference/interfaces/WatchedEvent.html +++ b/api-reference/interfaces/WatchedEvent.html @@ -1,4 +1,4 @@ -WatchedEvent | yorkie-js-sdk

    Interface WatchedEvent<P>

    interface WatchedEvent<P> {
        source: Remote;
        type: Watched;
        value: {
            clientID: string;
            presence: P;
        };
    }

    Type Parameters

    Hierarchy

    • BaseDocEvent
      • WatchedEvent

    Properties

    source +WatchedEvent | yorkie-js-sdk

    Interface WatchedEvent<P>

    interface WatchedEvent<P> {
        source: Remote;
        type: Watched;
        value: {
            clientID: string;
            presence: P;
        };
    }

    Type Parameters

    Hierarchy

    • BaseDocEvent
      • WatchedEvent

    Properties

    source type value -

    Properties

    source

    source: Remote

    type

    type: Watched

    value

    value: {
        clientID: string;
        presence: P;
    }

    Type declaration

    • clientID: string
    • presence: P

    Settings

    Member Visibility

    Theme

    On This Page

    sourcetypevalue
    \ No newline at end of file +

    Properties

    source

    source: Remote

    type

    type: Watched

    value

    value: {
        clientID: string;
        presence: P;
    }

    Type declaration

    • clientID: string
    • presence: P

    Settings

    Member Visibility

    Theme

    On This Page

    sourcetypevalue
    \ No newline at end of file diff --git a/api-reference/modules/Devtools.html b/api-reference/modules/Devtools.html index 1622a1245..382b408e5 100644 --- a/api-reference/modules/Devtools.html +++ b/api-reference/modules/Devtools.html @@ -1,4 +1,4 @@ -Devtools | yorkie-js-sdk

    Namespace Devtools

    Index

    Type Aliases

    Client +Devtools | yorkie-js-sdk

    Namespace Devtools

    Index

    Type Aliases

    Client ContainerValue JSONElement TreeNodeInfo diff --git a/api-reference/types/ActorID.html b/api-reference/types/ActorID.html index e731fbdef..fd8d65f51 100644 --- a/api-reference/types/ActorID.html +++ b/api-reference/types/ActorID.html @@ -1,3 +1,3 @@ ActorID | yorkie-js-sdk

    Type alias ActorID

    ActorID: string

    ActorID is used to identify who is making changes to the document. It is a hexadecimal string and should be generated by a unique value.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/api-reference/types/AddOpInfo.html b/api-reference/types/AddOpInfo.html index f389a750f..9d8ebbf95 100644 --- a/api-reference/types/AddOpInfo.html +++ b/api-reference/types/AddOpInfo.html @@ -1,2 +1,2 @@ AddOpInfo | yorkie-js-sdk

    Type alias AddOpInfo

    AddOpInfo: {
        index: number;
        path: string;
        type: "add";
    }

    AddOpInfo represents the information of the add operation.

    -

    Type declaration

    • index: number
    • path: string
    • type: "add"

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type declaration

    • index: number
    • path: string
    • type: "add"

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/api-reference/types/ArrayOperationInfo.html b/api-reference/types/ArrayOperationInfo.html index f9c3b8f93..7f73b02c1 100644 --- a/api-reference/types/ArrayOperationInfo.html +++ b/api-reference/types/ArrayOperationInfo.html @@ -1,2 +1,2 @@ ArrayOperationInfo | yorkie-js-sdk

    Type alias ArrayOperationInfo

    ArrayOperationInfo: AddOpInfo | RemoveOpInfo | MoveOpInfo

    ArrayOperationInfo represents the OperationInfo for the JSONArray.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/api-reference/types/CRDTTreeNodeIDStruct.html b/api-reference/types/CRDTTreeNodeIDStruct.html index 36a579fa6..321cb59b2 100644 --- a/api-reference/types/CRDTTreeNodeIDStruct.html +++ b/api-reference/types/CRDTTreeNodeIDStruct.html @@ -1,3 +1,3 @@ CRDTTreeNodeIDStruct | yorkie-js-sdk

    Type alias CRDTTreeNodeIDStruct

    CRDTTreeNodeIDStruct: {
        createdAt: TimeTicketStruct;
        offset: number;
    }

    CRDTTreeNodeIDStruct represents the structure of CRDTTreeNodeID. It is used to serialize and deserialize the CRDTTreeNodeID.

    -

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/api-reference/types/CompleteFn.html b/api-reference/types/CompleteFn.html index 1bd9cea9f..eda69d134 100644 --- a/api-reference/types/CompleteFn.html +++ b/api-reference/types/CompleteFn.html @@ -1 +1 @@ -CompleteFn | yorkie-js-sdk

    Type alias CompleteFn

    CompleteFn: (() => void)

    Type declaration

      • (): void

      • Returns void

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +CompleteFn | yorkie-js-sdk

    Type alias CompleteFn

    CompleteFn: (() => void)

    Type declaration

      • (): void

      • Returns void

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/api-reference/types/CounterOperationInfo.html b/api-reference/types/CounterOperationInfo.html index 059c4869c..1abe58673 100644 --- a/api-reference/types/CounterOperationInfo.html +++ b/api-reference/types/CounterOperationInfo.html @@ -1,2 +1,2 @@ CounterOperationInfo | yorkie-js-sdk

    Type alias CounterOperationInfo

    CounterOperationInfo: IncreaseOpInfo

    CounterOperationInfo represents the OperationInfo for the yorkie.Counter.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/api-reference/types/CounterValue.html b/api-reference/types/CounterValue.html index 9b5c2c21b..9df20902f 100644 --- a/api-reference/types/CounterValue.html +++ b/api-reference/types/CounterValue.html @@ -1 +1 @@ -CounterValue | yorkie-js-sdk

    Type alias CounterValue

    CounterValue: number | Long

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +CounterValue | yorkie-js-sdk

    Type alias CounterValue

    CounterValue: number | Long

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/api-reference/types/Devtools.Client.html b/api-reference/types/Devtools.Client.html index f2a93dd48..163d54b8c 100644 --- a/api-reference/types/Devtools.Client.html +++ b/api-reference/types/Devtools.Client.html @@ -1,2 +1,2 @@ Client | yorkie-js-sdk

    Type alias Client

    Client: {
        clientID: string;
        presence: Json;
    }

    Client represents a client value in devtools.

    -

    Type declaration

    • clientID: string
    • presence: Json

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/api-reference/types/Devtools.ContainerValue.html b/api-reference/types/Devtools.ContainerValue.html index 4560f0399..fd032cc76 100644 --- a/api-reference/types/Devtools.ContainerValue.html +++ b/api-reference/types/Devtools.ContainerValue.html @@ -1,3 +1,3 @@ ContainerValue | yorkie-js-sdk

    Type alias ContainerValue

    ContainerValue: {
        [key: string]: Devtools.JSONElement;
    }

    ContainerValue represents the result of Array.toJSForTest() and Object.toJSForTest().

    -

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/api-reference/types/Devtools.JSONElement.html b/api-reference/types/Devtools.JSONElement.html index 552d60fcb..ab357519e 100644 --- a/api-reference/types/Devtools.JSONElement.html +++ b/api-reference/types/Devtools.JSONElement.html @@ -1,2 +1,2 @@ JSONElement | yorkie-js-sdk

    Type alias JSONElement

    JSONElement: {
        createdAt: string;
        key?: string;
        type: JSONElementType;
        value: JSONElementValue;
    }

    JSONElement represents the result of Element.toJSForTest().

    -

    Type declaration

    • createdAt: string
    • Optional key?: string
    • type: JSONElementType
    • value: JSONElementValue

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/api-reference/types/Devtools.TreeNodeInfo.html b/api-reference/types/Devtools.TreeNodeInfo.html index 89499991e..96a55c3ac 100644 --- a/api-reference/types/Devtools.TreeNodeInfo.html +++ b/api-reference/types/Devtools.TreeNodeInfo.html @@ -1,2 +1,2 @@ TreeNodeInfo | yorkie-js-sdk

    Type alias TreeNodeInfo

    TreeNodeInfo: {
        attributes?: object;
        children: TreeNodeInfo[];
        depth: number;
        id: string;
        index?: number;
        insNext?: string;
        insPrev?: string;
        isRemoved: boolean;
        parent?: string;
        path?: number[];
        pos?: CRDTTreePosStruct;
        removedAt?: string;
        size: number;
        type: string;
        value?: string;
    }

    TreeNodeInfo represents the crdt tree node information in devtools.

    -

    Type declaration

    • Optional attributes?: object
    • children: TreeNodeInfo[]
    • depth: number
    • id: string
    • Optional index?: number
    • Optional insNext?: string
    • Optional insPrev?: string
    • isRemoved: boolean
    • Optional parent?: string
    • Optional path?: number[]
    • Optional pos?: CRDTTreePosStruct
    • Optional removedAt?: string
    • size: number
    • type: string
    • Optional value?: string

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/api-reference/types/DocEvent.html b/api-reference/types/DocEvent.html index 70aa73b18..e9891a64b 100644 --- a/api-reference/types/DocEvent.html +++ b/api-reference/types/DocEvent.html @@ -1,3 +1,3 @@ DocEvent | yorkie-js-sdk

    Type alias DocEvent<P, T>

    DocEvent<P, T>: StatusChangedEvent | ConnectionChangedEvent | SyncStatusChangedEvent | SnapshotEvent | LocalChangeEvent<T, P> | RemoteChangeEvent<T, P> | InitializedEvent<P> | WatchedEvent<P> | UnwatchedEvent<P> | PresenceChangedEvent<P> | BroadcastEvent | LocalBroadcastEvent | AuthErrorEvent

    DocEvent is an event that occurs in Document. It can be delivered using Document.subscribe().

    -

    Type Parameters

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type Parameters

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/api-reference/types/EditOpInfo.html b/api-reference/types/EditOpInfo.html index 297e213e5..94142c696 100644 --- a/api-reference/types/EditOpInfo.html +++ b/api-reference/types/EditOpInfo.html @@ -1,2 +1,2 @@ EditOpInfo | yorkie-js-sdk

    Type alias EditOpInfo

    EditOpInfo: {
        from: number;
        path: string;
        to: number;
        type: "edit";
        value: {
            attributes: Indexable;
            content: string;
        };
    }

    EditOpInfo represents the information of the edit operation.

    -

    Type declaration

    • from: number
    • path: string
    • to: number
    • type: "edit"
    • value: {
          attributes: Indexable;
          content: string;
      }

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/api-reference/types/ElementNode.html b/api-reference/types/ElementNode.html index e7510897a..acd344d53 100644 --- a/api-reference/types/ElementNode.html +++ b/api-reference/types/ElementNode.html @@ -1,2 +1,2 @@ ElementNode | yorkie-js-sdk

    Type alias ElementNode<A>

    ElementNode<A>: {
        attributes?: A;
        children: TreeNode[];
        type: TreeNodeType;
    }

    ElementNode represents an element node. It has an attributes and children.

    -

    Type Parameters

    Type declaration

    • Optional attributes?: A
    • children: TreeNode[]
    • type: TreeNodeType

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type Parameters

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/api-reference/types/ErrorFn.html b/api-reference/types/ErrorFn.html index f73238c56..fc6731e75 100644 --- a/api-reference/types/ErrorFn.html +++ b/api-reference/types/ErrorFn.html @@ -1 +1 @@ -ErrorFn | yorkie-js-sdk

    Type alias ErrorFn

    ErrorFn: ((error) => void)

    Type declaration

      • (error): void

      • Parameters

        • error: Error

        Returns void

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +ErrorFn | yorkie-js-sdk

    Type alias ErrorFn

    ErrorFn: ((error) => void)

    Type declaration

      • (error): void

      • Parameters

        • error: Error

        Returns void

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/api-reference/types/FullPanelToSDKMessage.html b/api-reference/types/FullPanelToSDKMessage.html index 86646516e..27ee9df9f 100644 --- a/api-reference/types/FullPanelToSDKMessage.html +++ b/api-reference/types/FullPanelToSDKMessage.html @@ -1 +1 @@ -FullPanelToSDKMessage | yorkie-js-sdk

    Type alias FullPanelToSDKMessage

    FullPanelToSDKMessage: PanelToSDKMessage & {
        source: "yorkie-devtools-panel";
    }

    Type declaration

    • source: "yorkie-devtools-panel"

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +FullPanelToSDKMessage | yorkie-js-sdk

    Type alias FullPanelToSDKMessage

    FullPanelToSDKMessage: PanelToSDKMessage & {
        source: "yorkie-devtools-panel";
    }

    Type declaration

    • source: "yorkie-devtools-panel"

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/api-reference/types/FullSDKToPanelMessage.html b/api-reference/types/FullSDKToPanelMessage.html index b28a9d77c..1e35f92b4 100644 --- a/api-reference/types/FullSDKToPanelMessage.html +++ b/api-reference/types/FullSDKToPanelMessage.html @@ -1 +1 @@ -FullSDKToPanelMessage | yorkie-js-sdk

    Type alias FullSDKToPanelMessage

    FullSDKToPanelMessage: SDKToPanelMessage & {
        source: "yorkie-devtools-sdk";
    }

    Type declaration

    • source: "yorkie-devtools-sdk"

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +FullSDKToPanelMessage | yorkie-js-sdk

    Type alias FullSDKToPanelMessage

    FullSDKToPanelMessage: SDKToPanelMessage & {
        source: "yorkie-devtools-sdk";
    }

    Type declaration

    • source: "yorkie-devtools-sdk"

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/api-reference/types/IncreaseOpInfo.html b/api-reference/types/IncreaseOpInfo.html index 446c8e4b7..1bc5bc6ae 100644 --- a/api-reference/types/IncreaseOpInfo.html +++ b/api-reference/types/IncreaseOpInfo.html @@ -1,2 +1,2 @@ IncreaseOpInfo | yorkie-js-sdk

    Type alias IncreaseOpInfo

    IncreaseOpInfo: {
        path: string;
        type: "increase";
        value: number;
    }

    IncreaseOpInfo represents the information of the increase operation.

    -

    Type declaration

    • path: string
    • type: "increase"
    • value: number

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/api-reference/types/Indexable.html b/api-reference/types/Indexable.html index c096c154f..158567d34 100644 --- a/api-reference/types/Indexable.html +++ b/api-reference/types/Indexable.html @@ -1,3 +1,3 @@ Indexable | yorkie-js-sdk

    Type alias Indexable

    Indexable: Record<string, Json>

    Indexable represents the type of the indexable object. It is used to represent the presence information of the client.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/api-reference/types/JSONArray.html b/api-reference/types/JSONArray.html index 53fd935e0..cbb434ae3 100644 --- a/api-reference/types/JSONArray.html +++ b/api-reference/types/JSONArray.html @@ -1,17 +1,17 @@ JSONArray | yorkie-js-sdk

    Type alias JSONArray<T>

    JSONArray<T>: {
        deleteByID?(createdAt): WrappedElement<T>;
        getElementByID?(createdAt): WrappedElement<T>;
        getElementByIndex?(index): WrappedElement<T>;
        getID?(): TimeTicket;
        getLast?(): WrappedElement<T>;
        insertAfter?(prevID, value): WrappedElement<T>;
        insertBefore?(nextID, value): WrappedElement<T>;
        moveAfter?(prevID, id): void;
        moveBefore?(nextID, id): void;
        moveFront?(id): void;
        moveLast?(id): void;
        toJSForTest?(): Devtools.JSONElement;
        toTestString?(): string;
    } & T[]

    JSONArray represents JSON array, but unlike regular JSON, it has time tickets created by a logical clock to resolve conflicts.

    Type Parameters

    • T

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns string

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/api-reference/types/JSONElement.html b/api-reference/types/JSONElement.html index 4dc6a14e4..67dca50fa 100644 --- a/api-reference/types/JSONElement.html +++ b/api-reference/types/JSONElement.html @@ -1,3 +1,3 @@ JSONElement | yorkie-js-sdk

    Type alias JSONElement<T, A>

    JSONElement<T, A>: PrimitiveValue | JSONObject<T> | JSONArray<T> | Text<A> | Counter | Tree

    JSONElement is a wrapper for CRDTElement that provides users with an easy-to-use interface for manipulating Documents.

    -

    Type Parameters

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type Parameters

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/api-reference/types/JSONObject.html b/api-reference/types/JSONObject.html index befb1d912..87bff890d 100644 --- a/api-reference/types/JSONObject.html +++ b/api-reference/types/JSONObject.html @@ -1,7 +1,7 @@ JSONObject | yorkie-js-sdk

    Type alias JSONObject<T>

    JSONObject<T>: {
        getID?(): TimeTicket;
        toJS?(): T;
        toJSForTest?(): Devtools.JSONElement;
        toJSON?(): string;
    } & T

    JSONObject represents a JSON object, but unlike regular JSON, it has time tickets created by a logical clock to resolve conflicts.

    Type Parameters

    • T

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns TimeTicket

  • toJS?:function
  • toJSForTest?:function
  • toJSON?:function

    • Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/api-reference/types/MoveOpInfo.html b/api-reference/types/MoveOpInfo.html index 7a053e666..7aae1a5af 100644 --- a/api-reference/types/MoveOpInfo.html +++ b/api-reference/types/MoveOpInfo.html @@ -1,2 +1,2 @@ MoveOpInfo | yorkie-js-sdk

    Type alias MoveOpInfo

    MoveOpInfo: {
        index: number;
        path: string;
        previousIndex: number;
        type: "move";
    }

    MoveOpInfo represents the information of the move operation.

    -

    Type declaration

    • index: number
    • path: string
    • previousIndex: number
    • type: "move"

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/api-reference/types/NextFn.html b/api-reference/types/NextFn.html index 2bb25be57..25c709a22 100644 --- a/api-reference/types/NextFn.html +++ b/api-reference/types/NextFn.html @@ -1 +1 @@ -NextFn | yorkie-js-sdk

    Type alias NextFn<T>

    NextFn<T>: ((value) => void)

    Type Parameters

    • T

    Type declaration

      • (value): void

      • Parameters

        • value: T

        Returns void

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +NextFn | yorkie-js-sdk

    Type alias NextFn<T>

    NextFn<T>: ((value) => void)

    Type Parameters

    • T

    Type declaration

      • (value): void

      • Parameters

        • value: T

        Returns void

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/api-reference/types/ObjectOperationInfo.html b/api-reference/types/ObjectOperationInfo.html index ab689e9b0..0d1065b9f 100644 --- a/api-reference/types/ObjectOperationInfo.html +++ b/api-reference/types/ObjectOperationInfo.html @@ -1,2 +1,2 @@ ObjectOperationInfo | yorkie-js-sdk

    Type alias ObjectOperationInfo

    ObjectOperationInfo: SetOpInfo | RemoveOpInfo

    ObjectOperationInfo represents the OperationInfo for the JSONObject.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/api-reference/types/OperationInfo.html b/api-reference/types/OperationInfo.html index ec56888fb..58cc4fd79 100644 --- a/api-reference/types/OperationInfo.html +++ b/api-reference/types/OperationInfo.html @@ -1,3 +1,3 @@ OperationInfo | yorkie-js-sdk

    Type alias OperationInfo

    OperationInfo: TextOperationInfo | CounterOperationInfo | ArrayOperationInfo | ObjectOperationInfo | TreeOperationInfo

    OperationInfo represents the information of an operation. It is used to inform to the user what kind of operation was executed.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/api-reference/types/PanelToSDKMessage.html b/api-reference/types/PanelToSDKMessage.html index e25661eb1..69d3d98ca 100644 --- a/api-reference/types/PanelToSDKMessage.html +++ b/api-reference/types/PanelToSDKMessage.html @@ -1,2 +1,2 @@ PanelToSDKMessage | yorkie-js-sdk

    Type alias PanelToSDKMessage

    PanelToSDKMessage: {
        msg: "devtools::connect";
    } | {
        msg: "devtools::disconnect";
    } | {
        docKey: string;
        msg: "devtools::subscribe";
    }

    PanelToSDKMessage is a message sent from the Devtools panel to the SDK.

    -

    Type declaration

    • msg: "devtools::connect"

    Type declaration

    • msg: "devtools::disconnect"

    Type declaration

    • docKey: string
    • msg: "devtools::subscribe"

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type declaration

    Type declaration

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/api-reference/types/PrimitiveValue.html b/api-reference/types/PrimitiveValue.html index 5c0be67a2..fa1c931e6 100644 --- a/api-reference/types/PrimitiveValue.html +++ b/api-reference/types/PrimitiveValue.html @@ -1,3 +1,3 @@ PrimitiveValue | yorkie-js-sdk

    Type alias PrimitiveValue

    PrimitiveValue: null | boolean | number | Long | string | Uint8Array | Date

    PrimitiveValue represents a value of primitive type. Only values of type included in PrimitiveValue can be set to the document.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/api-reference/types/RemoveOpInfo.html b/api-reference/types/RemoveOpInfo.html index f90f214d6..60f4875b5 100644 --- a/api-reference/types/RemoveOpInfo.html +++ b/api-reference/types/RemoveOpInfo.html @@ -1,2 +1,2 @@ RemoveOpInfo | yorkie-js-sdk

    Type alias RemoveOpInfo

    RemoveOpInfo: {
        index?: number;
        key?: string;
        path: string;
        type: "remove";
    }

    RemoveOpInfo represents the information of the remove operation.

    -

    Type declaration

    • Optional index?: number
    • Optional key?: string
    • path: string
    • type: "remove"

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/api-reference/types/SDKToPanelMessage.html b/api-reference/types/SDKToPanelMessage.html index 9ee73c3b7..5a2935094 100644 --- a/api-reference/types/SDKToPanelMessage.html +++ b/api-reference/types/SDKToPanelMessage.html @@ -1,2 +1,2 @@ SDKToPanelMessage | yorkie-js-sdk

    Type alias SDKToPanelMessage

    SDKToPanelMessage: {
        msg: "refresh-devtools";
    } | {
        docKey: string;
        msg: "doc::available";
    } | {
        docKey: string;
        events: TransactionEvent[];
        msg: "doc::sync::full";
    } | {
        docKey: string;
        event: TransactionEvent;
        msg: "doc::sync::partial";
    }

    Definition of all messages the SDK can send to the Devtools panel.

    -

    Type declaration

    • msg: "refresh-devtools"

    Type declaration

    • docKey: string
    • msg: "doc::available"

    Type declaration

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type declaration

    Type declaration

    Type declaration

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/api-reference/types/SetOpInfo.html b/api-reference/types/SetOpInfo.html index c897c2eae..de5aa3654 100644 --- a/api-reference/types/SetOpInfo.html +++ b/api-reference/types/SetOpInfo.html @@ -1,2 +1,2 @@ SetOpInfo | yorkie-js-sdk

    Type alias SetOpInfo

    SetOpInfo: {
        key: string;
        path: string;
        type: "set";
    }

    SetOpInfo represents the information of the set operation.

    -

    Type declaration

    • key: string
    • path: string
    • type: "set"

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/api-reference/types/StyleOpInfo.html b/api-reference/types/StyleOpInfo.html index 21988b7c8..e8b91ff0e 100644 --- a/api-reference/types/StyleOpInfo.html +++ b/api-reference/types/StyleOpInfo.html @@ -1,2 +1,2 @@ StyleOpInfo | yorkie-js-sdk

    Type alias StyleOpInfo

    StyleOpInfo: {
        from: number;
        path: string;
        to: number;
        type: "style";
        value: {
            attributes: Indexable;
        };
    }

    StyleOpInfo represents the information of the style operation.

    -

    Type declaration

    • from: number
    • path: string
    • to: number
    • type: "style"
    • value: {
          attributes: Indexable;
      }

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/api-reference/types/TextNode.html b/api-reference/types/TextNode.html index 8a602a178..642dc6190 100644 --- a/api-reference/types/TextNode.html +++ b/api-reference/types/TextNode.html @@ -1,2 +1,2 @@ TextNode | yorkie-js-sdk

    Type alias TextNode

    TextNode: {
        type: typeof DefaultTextType;
        value: string;
    }

    TextNode represents a text node. It has a string value.

    -

    Type declaration

    • type: typeof DefaultTextType
    • value: string

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/api-reference/types/TextOperationInfo.html b/api-reference/types/TextOperationInfo.html index 4725a369d..dc8f5b9f0 100644 --- a/api-reference/types/TextOperationInfo.html +++ b/api-reference/types/TextOperationInfo.html @@ -1,2 +1,2 @@ TextOperationInfo | yorkie-js-sdk

    Type alias TextOperationInfo

    TextOperationInfo: EditOpInfo | StyleOpInfo

    TextOperationInfo represents the OperationInfo for the yorkie.Text.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/api-reference/types/TextPosStruct.html b/api-reference/types/TextPosStruct.html index c99c264d7..a74522937 100644 --- a/api-reference/types/TextPosStruct.html +++ b/api-reference/types/TextPosStruct.html @@ -1,3 +1,3 @@ TextPosStruct | yorkie-js-sdk

    Type alias TextPosStruct

    TextPosStruct: {
        id: {
            createdAt: TimeTicketStruct;
            offset: number;
        };
        relativeOffset: number;
    }

    TextPosStruct represents the structure of RGATreeSplitPos. It is used to serialize and deserialize the RGATreeSplitPos.

    -

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/api-reference/types/TextPosStructRange.html b/api-reference/types/TextPosStructRange.html index e3634f38d..22406b7bc 100644 --- a/api-reference/types/TextPosStructRange.html +++ b/api-reference/types/TextPosStructRange.html @@ -1,3 +1,3 @@ TextPosStructRange | yorkie-js-sdk

    Type alias TextPosStructRange

    TextPosStructRange: [TextPosStruct, TextPosStruct]

    TextPosStructRange represents the structure of RGATreeSplitPosRange. It is used to serialize and deserialize the RGATreeSplitPosRange.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/api-reference/types/TimeTicketStruct.html b/api-reference/types/TimeTicketStruct.html index 2492ae71a..2ef90cb32 100644 --- a/api-reference/types/TimeTicketStruct.html +++ b/api-reference/types/TimeTicketStruct.html @@ -1,3 +1,3 @@ TimeTicketStruct | yorkie-js-sdk

    Type alias TimeTicketStruct

    TimeTicketStruct: {
        actorID: ActorID;
        delimiter: number;
        lamport: string;
    }

    TimeTicketStruct is a structure represents the meta data of the ticket. It is used to serialize and deserialize the ticket.

    -

    Type declaration

    • actorID: ActorID
    • delimiter: number
    • lamport: string

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/api-reference/types/TransactionEvent.html b/api-reference/types/TransactionEvent.html index 6646d00be..2eecfc4b0 100644 --- a/api-reference/types/TransactionEvent.html +++ b/api-reference/types/TransactionEvent.html @@ -1,3 +1,3 @@ TransactionEvent | yorkie-js-sdk

    Type alias TransactionEvent<P>

    TransactionEvent<P>: DocEvent<P>[]

    TransactionEvent represents document events that occur within a single transaction (e.g., doc.update).

    -

    Type Parameters

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type Parameters

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/api-reference/types/TreeChange.html b/api-reference/types/TreeChange.html index dd98594f3..bec472acf 100644 --- a/api-reference/types/TreeChange.html +++ b/api-reference/types/TreeChange.html @@ -1,2 +1,2 @@ TreeChange | yorkie-js-sdk

    Type alias TreeChange

    TreeChange: {
        actor: ActorID;
        from: number;
        fromPath: number[];
        splitLevel?: number;
        to: number;
        toPath: number[];
        type: Content;
        value?: TreeNode[];
    } | {
        actor: ActorID;
        from: number;
        fromPath: number[];
        splitLevel?: number;
        to: number;
        toPath: number[];
        type: Style;
        value: {
            [key: string]: string;
        };
    } | {
        actor: ActorID;
        from: number;
        fromPath: number[];
        splitLevel?: number;
        to: number;
        toPath: number[];
        type: RemoveStyle;
        value?: string[];
    }

    TreeChange represents the change in the tree.

    -

    Type declaration

    • actor: ActorID
    • from: number
    • fromPath: number[]
    • Optional splitLevel?: number
    • to: number
    • toPath: number[]
    • type: Content
    • Optional value?: TreeNode[]

    Type declaration

    • actor: ActorID
    • from: number
    • fromPath: number[]
    • Optional splitLevel?: number
    • to: number
    • toPath: number[]
    • type: Style
    • value: {
          [key: string]: string;
      }
      • [key: string]: string

    Type declaration

    • actor: ActorID
    • from: number
    • fromPath: number[]
    • Optional splitLevel?: number
    • to: number
    • toPath: number[]
    • type: RemoveStyle
    • Optional value?: string[]

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type declaration

    Type declaration

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/api-reference/types/TreeEditOpInfo.html b/api-reference/types/TreeEditOpInfo.html index 9a9940493..10852a5bc 100644 --- a/api-reference/types/TreeEditOpInfo.html +++ b/api-reference/types/TreeEditOpInfo.html @@ -1,2 +1,2 @@ TreeEditOpInfo | yorkie-js-sdk

    Type alias TreeEditOpInfo

    TreeEditOpInfo: {
        from: number;
        fromPath: number[];
        path: string;
        splitLevel?: number;
        to: number;
        toPath: number[];
        type: "tree-edit";
        value?: TreeNode[];
    }

    TreeEditOpInfo represents the information of the tree edit operation.

    -

    Type declaration

    • from: number
    • fromPath: number[]
    • path: string
    • Optional splitLevel?: number
    • to: number
    • toPath: number[]
    • type: "tree-edit"
    • Optional value?: TreeNode[]

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/api-reference/types/TreeNode.html b/api-reference/types/TreeNode.html index b19866c00..bace3f5a1 100644 --- a/api-reference/types/TreeNode.html +++ b/api-reference/types/TreeNode.html @@ -1,2 +1,2 @@ TreeNode | yorkie-js-sdk

    Type alias TreeNode

    TreeNode: TextNode | ElementNode

    TreeNode represents a node in the tree.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/api-reference/types/TreeOperationInfo.html b/api-reference/types/TreeOperationInfo.html index 196e9fd7e..412e89190 100644 --- a/api-reference/types/TreeOperationInfo.html +++ b/api-reference/types/TreeOperationInfo.html @@ -1,2 +1,2 @@ TreeOperationInfo | yorkie-js-sdk

    Type alias TreeOperationInfo

    TreeOperationInfo: TreeEditOpInfo | TreeStyleOpInfo

    TreeOperationInfo represents the OperationInfo for the yorkie.Tree.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/api-reference/types/TreePosStructRange.html b/api-reference/types/TreePosStructRange.html index 9b6a3bceb..6f9e50631 100644 --- a/api-reference/types/TreePosStructRange.html +++ b/api-reference/types/TreePosStructRange.html @@ -1,3 +1,3 @@ TreePosStructRange | yorkie-js-sdk

    Type alias TreePosStructRange

    TreePosStructRange: [CRDTTreePosStruct, CRDTTreePosStruct]

    TreePosStructRange represents the structure of TreeRange. It is used to serialize and deserialize the TreeRange.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/api-reference/types/TreeStyleOpInfo.html b/api-reference/types/TreeStyleOpInfo.html index 36af2618f..3d8a0e924 100644 --- a/api-reference/types/TreeStyleOpInfo.html +++ b/api-reference/types/TreeStyleOpInfo.html @@ -1,2 +1,2 @@ TreeStyleOpInfo | yorkie-js-sdk

    Type alias TreeStyleOpInfo

    TreeStyleOpInfo: {
        from: number;
        fromPath: number[];
        path: string;
        to: number;
        toPath: number[];
        type: "tree-style";
        value: {
            attributes?: Indexable;
            attributesToRemove?: string[];
        };
    }

    TreeStyleOpInfo represents the information of the tree style operation.

    -

    Type declaration

    • from: number
    • fromPath: number[]
    • path: string
    • to: number
    • toPath: number[]
    • type: "tree-style"
    • value: {
          attributes?: Indexable;
          attributesToRemove?: string[];
      }
      • Optional attributes?: Indexable
      • Optional attributesToRemove?: string[]

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/api-reference/types/Unsubscribe.html b/api-reference/types/Unsubscribe.html index f5843f25b..e05859f4e 100644 --- a/api-reference/types/Unsubscribe.html +++ b/api-reference/types/Unsubscribe.html @@ -1 +1 @@ -Unsubscribe | yorkie-js-sdk

    Type alias Unsubscribe

    Unsubscribe: (() => void)

    Type declaration

      • (): void

      • Returns void

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +Unsubscribe | yorkie-js-sdk

    Type alias Unsubscribe

    Unsubscribe: (() => void)

    Type declaration

      • (): void

      • Returns void

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/api-reference/types/WrappedElement.html b/api-reference/types/WrappedElement.html index 17cc914a4..f51dfade5 100644 --- a/api-reference/types/WrappedElement.html +++ b/api-reference/types/WrappedElement.html @@ -1,2 +1,2 @@ WrappedElement | yorkie-js-sdk

    Type alias WrappedElement<T, A>

    WrappedElement<T, A>: Primitive | JSONObject<T> | JSONArray<T> | Text<A> | Counter | Tree

    WrappedElement is a wrapper of JSONElement that provides getID().

    -

    Type Parameters

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type Parameters

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/api-reference/variables/EventSourceDevPanel.html b/api-reference/variables/EventSourceDevPanel.html index f2d4dedcf..80421bdb5 100644 --- a/api-reference/variables/EventSourceDevPanel.html +++ b/api-reference/variables/EventSourceDevPanel.html @@ -1,3 +1,3 @@ EventSourceDevPanel | yorkie-js-sdk

    Variable EventSourceDevPanelConst

    EventSourceDevPanel: "yorkie-devtools-panel" = 'yorkie-devtools-panel'

    EventSourceDevPanel is the name of the source representing messages from the Devtools panel.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/api-reference/variables/EventSourceSDK.html b/api-reference/variables/EventSourceSDK.html index f3af4af45..cea04be06 100644 --- a/api-reference/variables/EventSourceSDK.html +++ b/api-reference/variables/EventSourceSDK.html @@ -1,3 +1,3 @@ EventSourceSDK | yorkie-js-sdk

    Variable EventSourceSDKConst

    EventSourceSDK: "yorkie-devtools-sdk" = 'yorkie-devtools-sdk'

    EventSourceSDK is the name of the source representing messages from the SDK.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/api-reference/variables/converter.html b/api-reference/variables/converter.html index b249d0f42..923ef1032 100644 --- a/api-reference/variables/converter.html +++ b/api-reference/variables/converter.html @@ -19,4 +19,4 @@

    Parameters

    Returns PbOperation

  • toTreeNodes: ((node) => PbTreeNode[])
  • toUint8Array: ((hex) => Uint8Array)
  • versionVectorToHex: ((vector) => string)

    • Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Parameters

    Returns string

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/api-reference/variables/default.html b/api-reference/variables/default.html index fa3354789..3d4a8d558 100644 --- a/api-reference/variables/default.html +++ b/api-reference/variables/default.html @@ -3,4 +3,4 @@ assigned to the yorkie global.

    e.g) new yorkie.Client(...);

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Parameters

    Returns void

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/examples/nextjs-scheduler/404.html b/examples/nextjs-scheduler/404.html index 453591eae..e920fa966 100644 --- a/examples/nextjs-scheduler/404.html +++ b/examples/nextjs-scheduler/404.html @@ -1 +1 @@ -Next.js react-calendar example

    404 not found

    \ No newline at end of file +Next.js react-calendar example

    404 not found

    \ No newline at end of file diff --git a/examples/nextjs-scheduler/_next/static/u3uXYOUHYQOqUxL-X8yoB/_buildManifest.js b/examples/nextjs-scheduler/_next/static/dwYR6z8TNyKgTPufwxcKm/_buildManifest.js similarity index 100% rename from examples/nextjs-scheduler/_next/static/u3uXYOUHYQOqUxL-X8yoB/_buildManifest.js rename to examples/nextjs-scheduler/_next/static/dwYR6z8TNyKgTPufwxcKm/_buildManifest.js diff --git a/examples/nextjs-scheduler/_next/static/u3uXYOUHYQOqUxL-X8yoB/_ssgManifest.js b/examples/nextjs-scheduler/_next/static/dwYR6z8TNyKgTPufwxcKm/_ssgManifest.js similarity index 100% rename from examples/nextjs-scheduler/_next/static/u3uXYOUHYQOqUxL-X8yoB/_ssgManifest.js rename to examples/nextjs-scheduler/_next/static/dwYR6z8TNyKgTPufwxcKm/_ssgManifest.js diff --git a/examples/nextjs-scheduler/index.html b/examples/nextjs-scheduler/index.html index f4e855183..e71fbbf11 100644 --- a/examples/nextjs-scheduler/index.html +++ b/examples/nextjs-scheduler/index.html @@ -1 +1 @@ -Next.js react-calendar example

    peers : [ ]

    Mon
    Tue
    Wed
    Thu
    Fri
    Sat
    Sun

    selected day : 11-12-24

    input form

    \ No newline at end of file +Next.js react-calendar example

    peers : [ ]

    Mon
    Tue
    Wed
    Thu
    Fri
    Sat
    Sun

    selected day : 23-12-24

    input form

    \ No newline at end of file diff --git a/examples/nextjs-scheduler/index.txt b/examples/nextjs-scheduler/index.txt index 540f7fe02..7d0793023 100644 --- a/examples/nextjs-scheduler/index.txt +++ b/examples/nextjs-scheduler/index.txt @@ -2,6 +2,6 @@ 3:I[1802,["662","static/chunks/662-2ca4b8930a4bf5cf.js","931","static/chunks/app/page-d47c72bd3c8b5064.js"],""] 4:I[4926,[],""] 5:I[4582,[],""] -0:["u3uXYOUHYQOqUxL-X8yoB",[[["",{"children":["__PAGE__",{}]},"$undefined","$undefined",true],["",{"children":["__PAGE__",{},["$L1",["$","$L2",null,{"propsForComponent":{"params":{}},"Component":"$3","isStaticGeneration":true}],null]]},[null,["$","html",null,{"lang":"en","children":["$","body",null,{"children":["$","$L4",null,{"parallelRouterKey":"children","segmentPath":["children"],"loading":"$undefined","loadingStyles":"$undefined","loadingScripts":"$undefined","hasLoading":false,"error":"$undefined","errorStyles":"$undefined","errorScripts":"$undefined","template":["$","$L5",null,{}],"templateStyles":"$undefined","templateScripts":"$undefined","notFound":["$","h1",null,{"children":"404 not found"}],"notFoundStyles":[],"styles":[["$","link","0",{"rel":"stylesheet","href":"/yorkie-js-sdk/examples/nextjs-scheduler/_next/static/css/0b8518b4fc95b726.css","precedence":"next","crossOrigin":""}]]}]}]}],null]],[[["$","link","0",{"rel":"stylesheet","href":"/yorkie-js-sdk/examples/nextjs-scheduler/_next/static/css/55c28824c4a39011.css","precedence":"next","crossOrigin":""}]],"$L6"]]]] +0:["dwYR6z8TNyKgTPufwxcKm",[[["",{"children":["__PAGE__",{}]},"$undefined","$undefined",true],["",{"children":["__PAGE__",{},["$L1",["$","$L2",null,{"propsForComponent":{"params":{}},"Component":"$3","isStaticGeneration":true}],null]]},[null,["$","html",null,{"lang":"en","children":["$","body",null,{"children":["$","$L4",null,{"parallelRouterKey":"children","segmentPath":["children"],"loading":"$undefined","loadingStyles":"$undefined","loadingScripts":"$undefined","hasLoading":false,"error":"$undefined","errorStyles":"$undefined","errorScripts":"$undefined","template":["$","$L5",null,{}],"templateStyles":"$undefined","templateScripts":"$undefined","notFound":["$","h1",null,{"children":"404 not found"}],"notFoundStyles":[],"styles":[["$","link","0",{"rel":"stylesheet","href":"/yorkie-js-sdk/examples/nextjs-scheduler/_next/static/css/0b8518b4fc95b726.css","precedence":"next","crossOrigin":""}]]}]}]}],null]],[[["$","link","0",{"rel":"stylesheet","href":"/yorkie-js-sdk/examples/nextjs-scheduler/_next/static/css/55c28824c4a39011.css","precedence":"next","crossOrigin":""}]],"$L6"]]]] 6:[["$","meta","0",{"name":"viewport","content":"width=device-width, initial-scale=1"}],["$","meta","1",{"charSet":"utf-8"}],["$","title","2",{"children":"Next.js react-calendar example"}],["$","meta","3",{"name":"description","content":"example of yorkie-js-sdk with next.js & react-calendar"}],["$","link","4",{"rel":"icon","href":"/yorkie-js-sdk/examples/nextjs-scheduler/favicon.ico","type":"image/x-icon","sizes":"64x64"}]] 1:null