Class ClientAbstract

constructor

• new Client(): Client

• Returns Client

awaitOperation

bufferedOperation

revision

state

ackOperation

• ackOperation(): void

• Acknowledge the latest unacknowledged operation.

  Called when the client receives an acknowledgement from the server.

  (Usually) should NOT manually called.

  Returns void

applyClient

• applyClient(operation): void

• Apply a local operation to the client's document and send it to the server.

  Call this function when the client needs to perform an operation.

  Parameters

  • operation: Operation

    The operation to apply.

  Returns void

applyOperation

• applyOperation(operation): void

• Apply an operation to the document.

  Will only update the document and NOT handle the revision, server and so on.

  (Usually) should NOT manually called. Consider using Client.applyClient.

  Parameters

  • operation: Operation

    The operation to apply.

  Returns void

applyServer

• applyServer(operation): void

• Apply a remote operation from server to the client's document.

  Called when the client receives an operation from the server

  (Usually) should NOT manually called.

  Parameters

  • operation: Operation

    The operation to apply.

  Returns void

getDoc

• getDoc(): string

• Get the current document content.

  Returns string

  The document content.

AbstractsendOperation

• sendOperation(operation, revision): this

• Send an operation to the server.

  (Usually) should NOT manually called.

  Parameters

  • operation: Operation

    The operation to send.
  • revision: number

    The current revision number (= this.revision).

  Returns this

  The updated client instance.