Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace Model

Is also a namespace for scoping Model based interfaces and types.

Index

Classes

Interfaces

Type aliases

Functions

Type aliases

ModelCore

ModelCore: {}

Model input type used in most Model methods.

Type declaration

ModelCoreT

ModelCoreT<T>: { [ P in keyof T]: Exclude<T[P], Function> }

Model input type used in most ModelT methods.

Type parameters

  • T

ModelData

ModelData: {}

Item data supported by the Model.

Type declaration

ModelOut

ModelOut: {}

Model output type used in most Model methods.

Type declaration

ModelOutT

ModelOutT<T>: { [ P in keyof T]: Exclude<T[P], Function> }

Model output type used in most ModelT methods.

Type parameters

  • T

ModelSchema

ModelSchema: {}

Type for the Model schema which contains a Field for each Model property.

Type declaration

ModelSchemaT

ModelSchemaT<T>: { [ P in keyof Required<T>]: Field }

Type for the ModelT schema which contains a Field for each Model property.

Type parameters

  • T: {}

ModelType

ModelType: number | string | boolean | null | object

Types supported by the Model.

ModelUpdate

ModelUpdate: {}

Model input type used for update Model methods.

Type declaration

ModelUpdateT

ModelUpdateT<KEY, INPUT>: { [ P in keyof Optional<INPUT>]: ModelUpdateValue<INPUT[P]> } & KEY

Model input type used for update Model methods.

Type parameters

  • KEY

  • INPUT

ModelUpdateValue

ModelUpdateValue<T>: Extract<T, ModelType | Update.Resolver<Table.AttributeTypes>> | null

Model property value used for item updates.

Type parameters

  • T

Functions

createModel

  • See Table.createTable reasoning for having a createTable over support 'new TableT'.

    Type parameters

    • KEY: {}

    • INPUT: {} = KEY

    • OUTPUT: {} & {} = INPUT & KEY

    Parameters

    • params: ModelParamsT<KEY, OUTPUT>

      Options to used when creating Model.

    Returns Model.ModelT<KEY, INPUT, OUTPUT>

Generated using TypeDoc