Interface PerNodeStateOptions<V, P>

Options for PerNodeState.

Type parameters

V
P = any

Hierarchy

PerNodeStateOptions

Index

Properties

defaultValue

Methods

Properties

Optional defaultValue

defaultValue?: V

Default value to initialize this node to.

Methods

Optional applyPatch

applyPatch(currentValue: undefined | V, patch: P): V

- Defined in packages/core/src/state/PerNodeState.ts:22
Apply a patch to the current value. Used to apply incoming patches from remote nodes.

Parameters
- currentValue: undefined | V
- patch: P
Returns V

Optional generatePatch

generatePatch(currentValue: V, previousVersion: number): P

- Defined in packages/core/src/state/PerNodeState.ts:28
Generate a patch which describes changes from the previous version. Will be sent to remote nodes which then use applyPatch to apply it.

Parameters
- currentValue: V
- previousVersion: number
Returns P

Generated using TypeDoc