mobx-keystone
    Preparing search index...

    Interface AnyDataModel

    Any kind of data model instance.

    interface AnyDataModel {
        "[propsTypeSymbol]": any;
        $: { [key: string]: any };
        toString(options?: { withData?: boolean }): string;
        typeCheck(): null | TypeCheckError;
    }

    Hierarchy (View Summary)

    Index

    Properties

    [propsTypeSymbol] $

    Methods

    toString typeCheck

    Properties

    "[propsTypeSymbol]": any

    Readonly$

    $: { [key: string]: any }

    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.

    Methods

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

      A TypeCheckError or null if there is no error.

    Settings

    Member Visibility

    On This Page

    Properties
    Methods