| Class | Description |
|---|---|
| Change | Change represents a unit of modification in the document. |
| 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. |
| Counter | Counter is a custom data type that is used to counter. |
| Document | Document is a CRDT-based data type. We can represent the model of the application and edit it even while offline. |
| Primitive | Primitive represents primitive data type including logical clock. It has a type and a value. |
| Text | Text is an extended data type for the contents of a text editor. |
| TimeTicket | TimeTicket is a timestamp of the logical clock. Ticket is immutable. It is created by ChangeID. |
| Tree | Tree is a CRDT-based tree structure that is used to represent the document tree of text-based editor such as ProseMirror. |
| Enumeration | Description |
|---|---|
| ClientEventType | ClientEventType represents the type of the event that the client can emit. |
| ClientStatus | ClientStatus represents the status of the client. |
| DocEventType | DocEventType represents the type of the event that occurs in Document. |
| DocumentSyncResultType | DocumentSyncResultType represents the result of synchronizing the document with the server. |
| StreamConnectionStatus | StreamConnectionStatus represents whether the stream connection between the client and the server is connected or not. |
| SyncMode | SyncMode is the mode of synchronization. It is used to determine whether to push and pull changes in PushPullChanges API. |
| TreeChangeType | TreeChangeType represents the type of change in the tree. |
| Interface | Description |
|---|---|
| ChangeInfo | ChangeInfo represents the modifications made during a document update and the message passed. |
| ClientOptions | ClientOptions are user-settable options used when defining clients. |
| DocumentChangedEvent | DocumentChangedEvent is an event that occurs when document attached to the client changes. |
| DocumentSyncedEvent | DocumentSyncedEvent is an event that occurs when document attached to the client are synced. |
| LocalChangeEvent | LocalChangeEvent is an event that occurs when the document is changed by local changes. |
| Observable | |
| Observer | |
| RemoteChangeEvent | RemoteChangeEvent is an event that occurs when the document is changed by remote changes. |
| SnapshotEvent | SnapshotEvent is an event that occurs when a snapshot is received from the server. |
| StatusChangedEvent | StatusChangedEvent is an event that occurs when the Client’s state changes. |
| StreamConnectionStatusChangedEvent | StreamConnectionStatusChangedEvent is an event that occurs when the client’s stream connection state changes. |
| TreeChange | TreeChange represents the change in the tree. |
| Variable | Description |
|---|---|
| converter | converter is a converter that converts the given model to protobuf format. is also used to convert models to bytes and vice versa. |
| yorkie | <p>The top-level yorkie namespace with additional properties.</p><p>In production, this will be called exactly once and the result assigned to the yorkie global.</p><p>e.g) new yorkie.Client(...);</p> |
| Type Alias | Description |
|---|---|
| ActorID | 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. |
| AddOpInfo | AddOpInfo represents the information of the add operation. |
| ArrayOperationInfo | ArrayOperationInfo represents the OperationInfo for the JSONArray. |
| ClientEvent | ClientEvent is an event that occurs in Client. It can be delivered using Client.subscribe(). |
| CompleteFn | |
| CounterOperationInfo | CounterOperationInfo represents the OperationInfo for the yorkie.Counter. |
| CRDTTreeNodeIDStruct | CRDTTreeNodeIDStruct represents the structure of CRDTTreeNodeID. It is used to serialize and deserialize the CRDTTreeNodeID. |
| DocEvent | DocEvent is an event that occurs in Document. It can be delivered using Document.subscribe(). |
| EditOpInfo | EditOpInfo represents the information of the edit operation. |
| ElementNode | ElementNode is a node that has children. |
| ErrorFn | |
| IncreaseOpInfo | IncreaseOpInfo represents the information of the increase operation. |
| Indexable | Indexable key, value |
| JSONArray | JSONArray represents JSON array, but unlike regular JSON, it has time tickets created by a logical clock to resolve conflicts. |
| JSONElement | JSONElement is a wrapper for CRDTElement that provides users with an easy-to-use interface for manipulating Documents. |
| JSONObject | JSONObject represents a JSON object, but unlike regular JSON, it has time tickets created by a logical clock to resolve conflicts. |
| MoveOpInfo | MoveOpInfo represents the information of the move operation. |
| NextFn | |
| ObjectOperationInfo | ObjectOperationInfo represents the OperationInfo for the JSONObject. |
| OperationInfo | OperationInfo represents the information of an operation. It is used to inform to the user what kind of operation was executed. |
| PrimitiveValue | PrimitiveValue represents a value of primitive type. Only values of type included in PrimitiveValue can be set to the document. |
| RemoveOpInfo | RemoveOpInfo represents the information of the remove operation. |
| SetOpInfo | SetOpInfo represents the information of the set operation. |
| StyleOpInfo | StyleOpInfo represents the information of the style operation. |
| TextNode | TextNode is a node that has a value. |
| TextOperationInfo | TextOperationInfo represents the OperationInfo for the yorkie.Text. |
| TextPosStruct | TextPosStruct represents the structure of RGATreeSplitPos. It is used to serialize and deserialize the RGATreeSplitPos. |
| TextPosStructRange | TextPosStructRange represents the structure of RGATreeSplitPosRange. It is used to serialize and deserialize the RGATreeSplitPosRange. |
| TimeTicketStruct | TimeTicketStruct is a structure represents the meta data of the ticket. It is used to serialize and deserialize the ticket. |
| TreeNode | |
| TreeOperationInfo | TreeOperationInfo represents the OperationInfo for the yorkie.Tree. |
| TreeRangeStruct | TreePosStructRange represents the structure of TreeRange. It is used to serialize and deserialize the TreeRange. |
| Unsubscribe | |
| WrappedElement | WrappedElement is a wrapper of JSONElement that provides getID(). |