Options
All
  • Public
  • Public/Protected
  • All
Menu

Class TextField

A field which represents collaborative text. The namespace for the TextField class statics.

Hierarchy

Index

Type aliases

Static Change

Change: ReadonlyArray<ChangePart>

A type alias for the text field change type.

Static ChangePart

ChangePart: object

A type alias for a text field change part.

Type declaration

Static Metadata

Metadata: object

A type alias for the text field metadata type.

Type declaration

Static Patch

Patch: ReadonlyArray<PatchPart>

A type alias for the text field patch type.

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 PatchPart

PatchPart: object

A type alias for the text field patch part.

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 Splice

Splice: object

A type alias for a text field splice.

Type declaration

Static Update

Update: Splice | ReadonlyArray<Splice>

A type alias for the text field update type.

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: string

A type alias for the value type of a text field.

Constructors

constructor

  • new TextField(options?: IOptions): TextField

Properties

ChangeType

ChangeType: Change

The change type for the field.

Notes

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

MetadataType

MetadataType: Metadata

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

The patch type for the field.

Notes

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

UpdateType

UpdateType: Update

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

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.

Accessors

type

  • get type(): "text"

Methods

applyPatch

applyUpdate

createMetadata

createValue

mergeChange

mergePatch

unapplyPatch

Generated using TypeDoc