Class BaseDataModel<TProps>Abstract

Base abstract class for data models. Use DataModel instead when extending.

Never override the constructor, use onLazyInit instead.

Typeparam

Data Props data type.

Type Parameters

Hierarchy (view full)

Constructors

constructor

Properties

$ [propsTypeSymbol]

Methods

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. This also allows access to the backed values of transformed properties.

[propsTypeSymbol]

[propsTypeSymbol]: TProps

Methods

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$[propsTypeSymbol]toStringtypeCheck