Class TweakablePrimitiveModel<T, M>

Type Parameters

Hierarchy

  • BaseModel<{
        value: ModelProp<T, T, T, T, IsNeverType<Extract<T, undefined>, string, never>, false, string, never, never>;
    }, never, never, never, this> & Omit<{
        value: T;
    }, BaseModelKeys> & {
        setValue: ((value) => void);
    }
    • TweakablePrimitiveModel

Constructors

constructor

Properties

$ $modelType [fromSnapshotOverrideTypeSymbol] [modelIdPropertyNameSymbol] [propsTypeSymbol] [toSnapshotOverrideTypeSymbol] defaultValue onAttachedComplete setValue value

Accessors

$modelId label metadata ownPropertyName valuePath

Methods

getRefId onAttachedToRootStore onInit reset toString typeCheck

Constructors

constructor

  • Type Parameters

    Parameters

    • data: ModelPropsToTransformedCreationData<{
          value: ModelProp<T, T, T, T, IsNeverType<Extract<T, undefined>, string, never>, false, string, never, never>;
      }>

    Returns TweakablePrimitiveModel<T, M>

Properties

Readonly $

$: {
    value: T;
}

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.

Type declaration

  • value: T

Readonly $modelType

$modelType: string

Model type name.

[fromSnapshotOverrideTypeSymbol]

[fromSnapshotOverrideTypeSymbol]: never

[modelIdPropertyNameSymbol]

[modelIdPropertyNameSymbol]: never

[propsTypeSymbol]

[propsTypeSymbol]: {
    value: ModelProp<T, T, T, T, IsNeverType<Extract<T, undefined>, string, never>, false, string, never, never>;
}

Type declaration

  • value: ModelProp<T, T, T, T, IsNeverType<Extract<T, undefined>, string, never>, false, string, never, never>

[toSnapshotOverrideTypeSymbol]

[toSnapshotOverrideTypeSymbol]: never

Private defaultValue

defaultValue: T

onAttachedComplete

onAttachedComplete: boolean = false

setValue

setValue: ((value) => void) = ...

Type declaration

    • (value): void

    • Parameters

      • value: T

      Returns void

value

value: T = ...

Accessors

$modelId

  • get $modelId(): ModelIdPropertyType<TProps, ModelIdPropertyName>

  • Model internal id. Can be modified inside a model action. It will return undefined if there's no id prop set.

    Returns ModelIdPropertyType<TProps, ModelIdPropertyName>

  • set $modelId(newId): void

  • Parameters

    • newId: ModelIdPropertyType<TProps, ModelIdPropertyName>

    Returns void

label

metadata

ownPropertyName

valuePath

Methods

getRefId

  • 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

onAttachedToRootStore

onInit

reset

toString

  • Parameters

    • Optional options: {
          withData?: boolean;
      }
      • Optional withData?: boolean

    Returns string

  • Returns a string representation of an object.

    Returns string

typeCheck

  • 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

Generated using TypeDoc