Interface ReadonlyStorageMap<T, S>

Базовый класс, являющийся строго типизированным декоратором для хранилища IStorage.

Type Parameters

Hierarchy

Properties

[toStringTag] defaultValueFactory ignoreCase mapEnhancer observable size

Methods

[iterator] clone dispose ensureCacheResolved entries forEach get getStorage getVersionRef has keys notifyStorageUpdated replaceWith tryGet values

Properties

Readonly [toStringTag]

[toStringTag]: string

Readonly defaultValueFactory

defaultValueFactory: null | IKeyedStorageValueFactory<string, T, IStorage<unknown> | IStorageArray<unknown>>

Фабрика для создания значений по умолчанию.

Readonly ignoreCase

ignoreCase: boolean

Флаг, указывающий на то, что для доступа к элементам регистр ключа игнорируется.

Readonly mapEnhancer

mapEnhancer: null | IMapEnhancer<T, unknown>

Объект, позволяющий обрабатывать значения, добавляемые в объект-хранилище.

Readonly observable

observable: boolean

Флаг, включающий уведомления об изменении объектов.

size

size: number

Methods

[iterator]

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

  • Итератор по парам ключ/значение в хранилище.

    Returns IterableIterator<[string, T]>

clone

  • Type Parameters

    Returns M

dispose

  • Returns void

ensureCacheResolved

  • Returns void

entries

  • Итератор по парам ключ/значение в хранилище.

    Returns IterableIterator<[string, T]>

forEach

  • Вызывает колбек-функцию для каждого значения в хранилище.

    Parameters

    • callbackfn: ((value: T, key: string, map: StorageMap<T, S>) => void)

      Колбек-функция, вызываемая для каждого объекта в хранилище. Ключ и значение передаются в качестве параметров.

        • (value: T, key: string, map: StorageMap<T, S>): void

        • Parameters

          Returns void

    • Optional thisArg: unknown

      Объект контекста вызова функции-колбека.

    Returns void

get

  • Возвращает значение, полученное по ключу key.

    Returns

    Значение, полученное по ключу key.

    Remarks

    При отсутствии объекта в хранилище будет выброшено исключение.

    Parameters

    • key: string

      Ключ, по которому требуется найти значение.

    Returns T

  • Type Parameters

    • T

    Parameters

    • key: string

    Returns T

getStorage

  • Returns S

getVersionRef

  • Returns unknown

has

  • Проверяет наличие заданного ключа в хранилище.

    Returns

    true, если заданный ключ присутствует в коллекции; false в противном случае.

    Parameters

    • key: string

      Ключ, наличие которого требуется проверить.

    Returns boolean

keys

  • Итератор по ключам в хранилище.

    Returns IterableIterator<string>

notifyStorageUpdated

  • Returns void

replaceWith

  • Parameters

    • items: Iterable<readonly [string, T]>

    Returns void

tryGet

  • Parameters

    • key: string

    Returns undefined | T

  • Type Parameters

    • T

    Parameters

    • key: string

    Returns undefined | T

values

  • Итератор по значениям в хранилище.

    Returns IterableIterator<T>

Generated using TypeDoc