Interface IJsonCrdtPatchOperation

Represents a common interface for all JSON CRDT patch operations.

interface IJsonCrdtPatchOperation {
    id: ITimestampStruct;
    name(): JsonCrdtPatchMnemonic;
    span(): number;
    toString(tab?: string): string;
}

Hierarchy (View Summary)

Identifiable
- IJsonCrdtPatchOperation
  - IJsonCrdtPatchEditOperation

Implemented by

Index

Properties

Methods

name span toString

Properties

id

id: ITimestampStruct

Unique ID of that operation within the document, Lamport timestamp.

Methods

name

name(): JsonCrdtPatchMnemonic
User friendly name of the operation.

Returns JsonCrdtPatchMnemonic
- Defined in src/json-crdt-patch/types.ts:44

span

span(): number
Some operations, such as array and string insert/delete operations are compound a single operation instance effectively represents multiple operations (one per character or array element).

This method returns the effective number of operations.

Returns number
Overrides Identifiable.span
- Defined in src/json-crdt-patch/types.ts:39

toString

toString(tab?: string): string
Parameters
- Optionaltab: string
Returns string
Inherited from Identifiable.toString
- Defined in node_modules/tree-dump/lib/types.d.ts:2