mobx-keystone

    Interface AnyModel

    Any kind of model instance.

    interface AnyModel {
        "[fromSnapshotOverrideTypeSymbol]": any;
        "[modelIdPropertyNameSymbol]": any;
        "[propsTypeSymbol]": any;
        "[toSnapshotOverrideTypeSymbol]": any;
        $: { [key: string]: any };
        $modelType: string;
        get $modelId(): ModelIdPropertyType<TProps, ModelIdPropertyName>;
        set $modelId(newId: ModelIdPropertyType<TProps, ModelIdPropertyName>): void;
        getRefId(): undefined | string;
        toString(options?: { withData?: boolean }): string;
        typeCheck(): null | TypeCheckError;
    }

    Hierarchy (View Summary)

    Index

    Properties

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

    Accessors

    $modelId

    Methods

    getRefId toString typeCheck

    Properties

    "[fromSnapshotOverrideTypeSymbol]": any
    "[modelIdPropertyNameSymbol]": any
    "[propsTypeSymbol]": any
    "[toSnapshotOverrideTypeSymbol]": 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.

    $modelType: string

    Model type name.

    Accessors

    Methods

    • 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

    • 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
    Accessors
    Methods
    MMNEPVFCICPMFPCPTTAAATR