Class ObjectMap<V>

A map that is backed by an object-like map. Use objectMap to create it.

Type Parameters

  • V

Hierarchy

  • BaseModel<{
        $modelId: ModelIdProp<string> & {
            typedAs<T>(): ModelIdProp<T>;
        };
        items: OptionalModelProp<{
            [k: string]: TypeToData<S> extends infer R
                ? R
                : never;
        }>;
    }, never, never, "$modelId", this> & Omit<{
        $modelId: string;
        items: {
            [k: string]: TypeToData<S> extends infer R
                ? R
                : never;
        };
    }, BaseModelKeys> & {}
    • ObjectMap

Implements

  • Map<string, V>

Constructors

constructor

Properties

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

Accessors

$modelId size

Methods

[iterator] clear delete entries forEach get getRefId has keys set toString typeCheck values

Constructors

constructor

  • new ObjectMap<V>(data): ObjectMap<V>

  • Type Parameters

    • V

    Parameters

    Returns ObjectMap<V>

Properties

Readonly $

$: {
    $modelId: string;
    items: {
        [k: string]: TypeToData<S> extends infer R
            ? R
            : never;
    };
}

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

  • $modelId: string
  • items: {
        [k: string]: TypeToData<S> extends infer R
            ? R
            : never;
    }
    • [k: string]: TypeToData<S> extends infer R
          ? R
          : never

Readonly $modelType

$modelType: string

Model type name.

[fromSnapshotOverrideTypeSymbol]

[fromSnapshotOverrideTypeSymbol]: never

[modelIdPropertyNameSymbol]

[modelIdPropertyNameSymbol]: "$modelId"

[propsTypeSymbol]

[propsTypeSymbol]: {
    $modelId: ModelIdProp<string> & {
        typedAs<T>(): ModelIdProp<T>;
    };
    items: OptionalModelProp<{
        [k: string]: TypeToData<S> extends infer R
            ? R
            : never;
    }>;
}

Type declaration

[toSnapshotOverrideTypeSymbol]

[toSnapshotOverrideTypeSymbol]: never

Readonly [toStringTag]

[toStringTag]: "ObjectMap" = "ObjectMap"

items

items: {
    [k: string]: TypeToData<S> extends infer R
        ? R
        : never;
} = ...

Type declaration

  • [k: string]: TypeToData<S> extends infer R
        ? R
        : never

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

    Returns void

size

  • get size(): number

  • Returns number

Methods

[iterator]

  • [iterator](): IterableIterator<[string, V]>

  • Returns IterableIterator<[string, V]>

clear

  • clear(): void

  • Returns void

delete

  • delete(key): boolean

  • Parameters

    • key: string

    Returns boolean

entries

  • entries(): IterableIterator<[string, V]>

  • Returns IterableIterator<[string, V]>

forEach

  • forEach(callbackfn, thisArg?): void

  • Parameters

    • callbackfn: ((value, key, map) => void)
        • (value, key, map): void

        • Parameters

          • value: V
          • key: string
          • map: Map<string, V>

          Returns void

    • Optional thisArg: any

    Returns void

get

  • get(key): undefined | V

  • Parameters

    • key: string

    Returns undefined | V

getRefId

  • getRefId(): undefined | string

  • 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

has

  • has(key): boolean

  • Parameters

    • key: string

    Returns boolean

keys

  • keys(): IterableIterator<string>

  • Returns IterableIterator<string>

set

  • set(key, value): this

  • Parameters

    • key: string
    • value: V

    Returns this

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.

values

  • values(): IterableIterator<V>

  • Returns IterableIterator<V>

Settings

Member Visibility

Theme

On This Page

constructor$$modelType[fromSnapshotOverrideTypeSymbol][modelIdPropertyNameSymbol][propsTypeSymbol][toSnapshotOverrideTypeSymbol][toStringTag]items$modelIdsize[iterator]cleardeleteentriesforEachgetgetRefIdhaskeyssettoStringtypeCheckvalues