Class Counter

Counter is a custom data type that is used to counter.

Index

Constructors

Properties

context? counter? value valueType

Methods

getID getValue getValueType increase initialize toJSForTest

Constructors

constructor

new Counter(valueType, value): Counter
Parameters
- valueType: CounterType
- value: number | Long
Returns Counter
- Defined in document/json/counter.ts:38

Properties

`Private` `Optional` context

context?: ChangeContext<Indexable>

`Private` `Optional` counter

counter?: CRDTCounter

`Private` value

value: number | Long

`Private` valueType

valueType: CounterType

Methods

getID

getID(): TimeTicket
getID returns the ID of this text.

Returns TimeTicket
- Defined in document/json/counter.ts:57

getValue

getValue(): number | Long
Internal
getValue returns the value of this counter;

Returns number | Long
- Defined in document/json/counter.ts:65

getValueType

getValueType(): CounterType
getValueType returns the value type of this counter.

Returns CounterType
- Defined in document/json/counter.ts:72

increase

increase(v): Counter
increase increases numeric data.
Parameters
- v: number | Long
Returns Counter
- Defined in document/json/counter.ts:79

initialize

initialize(context, counter): void
Internal
initialize initialize this text with context and internal text.
Parameters
- context: ChangeContext<Indexable>
- counter: CRDTCounter
Returns void
- Defined in document/json/counter.ts:47

toJSForTest

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

Returns Devtools.JSONElement
- Defined in document/json/counter.ts:107