mobx-keystone
    Preparing search index...

    Class BaseDataModel<TProps>Abstract

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

    Never override the constructor, use onLazyInit instead.

    Props data type.

    Type Parameters

    Hierarchy (View Summary)

    Index
    constructor
    [propsTypeSymbol] $
    toString typeCheck
    "[propsTypeSymbol]": TProps

    Readonly$

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

    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.

    • Parameters

      • Optionaloptions: { withData?: boolean }

      Returns string

    • 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 TypeCheckError | null

      A TypeCheckError or null if there is no error.

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Methods