Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RegisterField<T>

A field which represents a collaborative atomic value. The namespace for the RegisterField class statics.

Type parameters

  • T: ReadonlyJSONValue

Hierarchy

Index

Type aliases

Static Change

Change<T>: object

A type alias for the register field change type.

Type parameters

  • T: ReadonlyJSONValue

Type declaration

Static Metadata

Metadata<T>: object

A type alias for the register field metadata type.

Type parameters

  • T: ReadonlyJSONValue

Type declaration

Static Patch

Patch<T>: object

A type alias for the register field patch type.

Type parameters

  • T: ReadonlyJSONValue

Type declaration

Static PatchArgs

PatchArgs<Value, Patch, Metadata>: object

A type alias for the arguments to a patch operation.

Type parameters

  • Value

  • Patch

  • Metadata

Type declaration

Static PatchResult

PatchResult<Value, Change>: object

A type alias for the result of a patch operation.

Type parameters

  • Value

  • Change

Type declaration

Static Update

Update<T>: T

A type alias for the register field update type.

Type parameters

  • T: ReadonlyJSONValue

Static UpdateArgs

UpdateArgs<Value, Update, Metadata>: object

A type alias for the arguments to an update operation.

Type parameters

  • Value

  • Update

  • Metadata

Type declaration

Static UpdateResult

UpdateResult<Value, Change, Patch>: object

A type alias for the result of an update operation.

Type parameters

  • Value

  • Change

  • Patch

Type declaration

Static Value

Value<T>: T

A type alias for the register field value type.

Type parameters

  • T: ReadonlyJSONValue

Constructors

constructor

Properties

ChangeType

ChangeType: Change<T>

The change type for the field.

Notes

This type represents the user-facing change to the field's value.

MetadataType

MetadataType: Metadata<T>

The metadata type for the field.

Notes

This type represents extra bookeeping data needed by the field to accurately apply updates and patches.

This type extends the ReadonlyJSONValue type so that it may hold readonly JSON data. However, the metadata is intended to be mutated in-place and thus may also contain mutable data.

PatchType

PatchType: Patch<T>

The patch type for the field.

Notes

This type represents the system-facing patch to the field's value.

UpdateType

UpdateType: Update<T>

The update type for the field.

Notes

This type represents the data the user passes to the update method of a table to update the field of a particular record.

ValueType

ValueType: Value<T>

The value type for the field.

Notes

This type represents the user-facing value stored in the record.

description

description: string

The human-readable description of the field.

value

value: T

The initial value for the field.

Accessors

type

  • get type(): "register"

Methods

applyPatch

applyUpdate

createMetadata

createValue

  • createValue(): Value<T>

mergeChange

mergePatch

unapplyPatch

Generated using TypeDoc