Class BaseModel<TProps, FromSnapshotOverride, ToSnapshotOverride, ModelIdPropertyName>Abstract

Base abstract class for models. Use Model instead when extending.

Never override the constructor, use onInit or onAttachedToRootStore instead.

Typeparam

Data Data type.

Typeparam

CreationData Creation data type.

Typeparam

ModelIdPropertyName Model id property name.

Type Parameters

  • TProps extends ModelProps
  • FromSnapshotOverride extends Record<string, any>
  • ToSnapshotOverride extends Record<string, any>
  • ModelIdPropertyName extends string = never

Hierarchy (view full)

Constructors

constructor

Properties

$ $modelType [fromSnapshotOverrideTypeSymbol] [modelIdPropertyNameSymbol] [propsTypeSymbol] [toSnapshotOverrideTypeSymbol]

Accessors

$modelId

Methods

getRefId toString typeCheck

Constructors

constructor

Properties

Readonly $

$: Flatten<{
    [k in string | number | symbol]: TProps[k]["$valueType"]
}>

Data part of the model, which is observable and will be serialized in snapshots. Use it if one of the data properties matches one of the model properties/functions.

Readonly $modelType

$modelType: string

Model type name.

[fromSnapshotOverrideTypeSymbol]

[fromSnapshotOverrideTypeSymbol]: FromSnapshotOverride

[modelIdPropertyNameSymbol]

[modelIdPropertyNameSymbol]: ModelIdPropertyName

[propsTypeSymbol]

[propsTypeSymbol]: TProps

[toSnapshotOverrideTypeSymbol]

[toSnapshotOverrideTypeSymbol]: ToSnapshotOverride

Accessors

$modelId

Methods

getRefId

  • getRefId(): undefined | string

  • Can be overridden to offer a reference id to be used in reference resolution. By default it will use the idProp if available or return undefined otherwise.

    Returns undefined | string

toString

  • toString(options?): string

  • Parameters

    • Optional options: {
          withData?: boolean;
      }
      • Optional withData?: boolean

    Returns string

typeCheck

  • typeCheck(): null | TypeCheckError

  • Performs a type check over the model instance. For this to work a data type has to be declared as part of the model properties.

    Returns null | TypeCheckError

    A TypeCheckError or null if there is no error.

Settings

Member Visibility

Theme

On This Page

constructor$$modelType[fromSnapshotOverrideTypeSymbol][modelIdPropertyNameSymbol][propsTypeSymbol][toSnapshotOverrideTypeSymbol]$modelIdgetRefIdtoStringtypeCheck