Class Primitive

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

Hierarchy

CRDTElement
- Primitive

Constructors

constructor

new Primitive(value, createdAt): Primitive
Parameters
- value: PrimitiveValue
- createdAt: TimeTicket
Returns Primitive
Overrides CRDTElement.constructor
- Defined in document/crdt/primitive.ts:52

Properties

`Private` value

value: PrimitiveValue

`Private` valueType

valueType: PrimitiveType

Methods

deepcopy

deepcopy(): Primitive
deepcopy copies itself deeply.

Returns Primitive
Overrides CRDTElement.deepcopy
- Defined in document/crdt/primitive.ts:178

getCreatedAt

getCreatedAt(): TimeTicket
getCreatedAt returns the creation time of this element.

Returns TimeTicket
Inherited from CRDTElement.getCreatedAt
- Defined in document/crdt/element.ts:39

getDataSize

getDataSize(): DataSize
getDataSize returns the data usage of this element.

Returns DataSize
Overrides CRDTElement.getDataSize
- Defined in document/crdt/primitive.ts:137

getID

getID(): TimeTicket
getID returns the creation time of this element.

Returns TimeTicket
Inherited from CRDTElement.getID
- Defined in document/crdt/element.ts:46

getMetaUsage

getMetaUsage(): number
getMetaUsage returns the meta usage of this element.

Returns number
Inherited from CRDTElement.getMetaUsage
- Defined in document/crdt/element.ts:131

getMovedAt

getMovedAt(): undefined | TimeTicket
getMovedAt returns the move time of this element.

Returns undefined | TimeTicket
Inherited from CRDTElement.getMovedAt
- Defined in document/crdt/element.ts:53

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
Inherited from CRDTElement.getPositionedAt
- Defined in document/crdt/element.ts:68

getRemovedAt

getRemovedAt(): undefined | TimeTicket
getRemovedAt returns the removal time of this element.

Returns undefined | TimeTicket
Inherited from CRDTElement.getRemovedAt
- Defined in document/crdt/element.ts:60

getType

getType(): PrimitiveType
getType returns the type of the value.

Returns PrimitiveType
- Defined in document/crdt/primitive.ts:188

getValue

getValue(): PrimitiveValue
getValue returns the value of Primitive.

Returns PrimitiveValue
- Defined in document/crdt/primitive.ts:257

`Private` getValueSize

getValueSize(): number
getValueSize returns the size of the value. The size is similar to the size of primitives in JavaScript.

Returns number
- Defined in document/crdt/primitive.ts:106

isNumericType

isNumericType(): boolean
isNumericType checks numeric type by JSONPrimitive

Returns boolean
- Defined in document/crdt/primitive.ts:245

isRemoved

isRemoved(): boolean
isRemoved check if this element was removed.

Returns boolean
Inherited from CRDTElement.isRemoved
- Defined in document/crdt/element.ts:124

remove

remove(removedAt?): boolean
remove removes this element.
Parameters
- Optional removedAt: TimeTicket
Returns boolean
Inherited from CRDTElement.remove
- Defined in document/crdt/element.ts:105

setCreatedAt

setCreatedAt(createdAt): void
setCreatedAt sets the creation time of this element manually.
Parameters
- createdAt: TimeTicket
Returns void
Inherited from CRDTElement.setCreatedAt
- Defined in document/crdt/element.ts:79

setMovedAt

setMovedAt(movedAt?): boolean
setMovedAt sets the move time of this element.
Parameters
- Optional movedAt: TimeTicket
Returns boolean
Inherited from CRDTElement.setMovedAt
- Defined in document/crdt/element.ts:86

setRemovedAt

setRemovedAt(removedAt?): void
setRemovedAt sets the remove time of this element.
Parameters
- Optional removedAt: TimeTicket
Returns void
Inherited from CRDTElement.setRemovedAt
- Defined in document/crdt/element.ts:98

toBytes

toBytes(): Uint8Array
toBytes creates an array representing the value.

Returns Uint8Array
- Defined in document/crdt/primitive.ts:264

toJSForTest

toJSForTest(): Devtools.JSONElement
toJSForTest returns value with meta data for testing.

Returns Devtools.JSONElement
Overrides CRDTElement.toJSForTest
- Defined in document/crdt/primitive.ts:167

toJSON

toJSON(): string
toJSON returns the JSON encoding of the value.

Returns string
Overrides CRDTElement.toJSON
- Defined in document/crdt/primitive.ts:147

toSortedJSON

toSortedJSON(): string
toSortedJSON returns the sorted JSON encoding of the value.

Returns string
Overrides CRDTElement.toSortedJSON
- Defined in document/crdt/primitive.ts:160

`Static` getPrimitiveType

getPrimitiveType(value): undefined | PrimitiveType
getPrimitiveType returns the primitive type of the value.
Parameters
- value: unknown
Returns undefined | PrimitiveType
- Defined in document/crdt/primitive.ts:195

`Static` isInteger

isInteger(num): boolean
isInteger checks if the given number is integer.
Parameters
- num: number
Returns boolean
- Defined in document/crdt/primitive.ts:238

`Static` isSupport

isSupport(value): boolean
isSupport check if the given value is supported type.
Parameters
- value: unknown
Returns boolean
- Defined in document/crdt/primitive.ts:227

`Static` of

of(value, createdAt): Primitive
of creates a new instance of Primitive.
Parameters
- value: PrimitiveValue
- createdAt: TimeTicket
Returns Primitive
- Defined in document/crdt/primitive.ts:61

`Static` valueFromBytes

valueFromBytes(primitiveType, bytes): PrimitiveValue
valueFromBytes parses the given bytes into value.
Parameters
- primitiveType: PrimitiveType
- bytes: Uint8Array
Returns PrimitiveValue
- Defined in document/crdt/primitive.ts:68