Interface AnyDataModel

Any kind of data model instance.

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

Hierarchy (view full)

Properties

$ [propsTypeSymbol]

Methods

toString typeCheck

Properties

Readonly $

$: {}

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.

Type declaration

    [propsTypeSymbol]

    [propsTypeSymbol]: any

    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

    $[propsTypeSymbol]toStringtypeCheck