Module Fields

The namespace for the Fields factory functions.

Index

Functions

Functions

Boolean

Boolean(options?: Partial<IOptions<boolean>>): RegisterField<boolean>

- Defined in datastore/src/fields.ts:32
A factory function which creates a boolean register field.

Parameters
- Default value options: Partial<IOptions<boolean>> = {}
  
  The options for the field. The default value option is false.
Returns RegisterField<boolean>

A new boolean register field.

List

List<T>(options?: IOptions<T>): ListField<T>

- Defined in datastore/src/fields.ts:73
A factory function which creates a list field.

Type parameters
- T: ReadonlyJSONValue
Parameters
- Default value options: IOptions<T> = {}
  
  The options for the field.
Returns ListField<T>

A new list field.

Map

Map<T>(options?: IOptions<T>): MapField<T>

- Defined in datastore/src/fields.ts:86
A factory function which creates a map field.

Type parameters
- T: ReadonlyJSONValue
Parameters
- Default value options: IOptions<T> = {}
  
  The options for the field.
Returns MapField<T>

A new map field.

Number

Number(options?: Partial<IOptions<number>>): RegisterField<number>

- Defined in datastore/src/fields.ts:46
A factory function which creates a number register field.

Parameters
- Default value options: Partial<IOptions<number>> = {}
  
  The options for the field. The default value option is 0.
Returns RegisterField<number>

A new number register field.

Register

Register<T>(options: IOptions<T>): RegisterField<T>

- Defined in datastore/src/fields.ts:99
A factory function which creates a register field.

Type parameters
- T: ReadonlyJSONValue
Parameters
- options: IOptions<T>
  
  The options for the field.
Returns RegisterField<T>

A new register field.

String

String(options?: Partial<IOptions<string>>): RegisterField<string>

- Defined in datastore/src/fields.ts:60
A factory function which creates a string register field.

Parameters
- Default value options: Partial<IOptions<string>> = {}
  
  The options for the field. The default value option is ''.
Returns RegisterField<string>

A new string register field.

Text

Text(options?: IOptions): TextField

- Defined in datastore/src/fields.ts:112
A factory function which creates a text field.

Parameters
- Default value options: IOptions = {}
  
  The options for the field.
Returns TextField

A new text field.

Generated using TypeDoc