Interface ClientState

Represents the state of a client in the text editor.

interface ClientState {
    ackOperation(context: Client): ClientState;
    applyClient(context: Client, operation: Operation): ClientState;
    applyServer(context: Client, operation: Operation): ClientState;
}

Implemented by

Index

Methods

ackOperation applyClient applyServer

Methods

ackOperation

ackOperation(context): ClientState
Acknowledge the latest unacknowledged operation.

Called when the client receives an acknowledgement from the server.
Parameters
- context: Client
  The client context.
Returns ClientState
The updated client state.
- Defined in client.ts:35

applyClient

applyClient(context, operation): ClientState
Apply a local operation to the client's document and send it to the server.

Called when the client performs an operation.
Parameters
- context: Client
  The client context.
- operation: Operation
  The operation to apply.
Returns ClientState
The updated client state.
- Defined in client.ts:16

applyServer

applyServer(context, operation): ClientState
Apply a remote operation from server to the client's document.

Called when the client receives an operation from the server.
Parameters
- context: Client
  The client context.
- operation: Operation
  The operation to apply.
Returns ClientState
The updated client state.
- Defined in client.ts:26