Interface IDictionary<T>

Базовый контейнер для хранения ключ/значения.

Type Parameters

  • T = unknown

Hierarchy

Implemented by

Properties

[toStringTag] collectionChanged ignoreCase mapEnhancer observable size

Methods

[iterator] clear clone delete dispose entries forEach get getVersionRef has keys remove replaceWith set tryGet values

Properties

Readonly [toStringTag]

[toStringTag]: string

Readonly collectionChanged

collectionChanged: EventHandler<DictionaryChangedEventArgs<T>, IDictionary<T>>

Событие, вызываемое при добавлении/удалении объектов в хранилище.

Readonly ignoreCase

ignoreCase: boolean

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

Readonly mapEnhancer

mapEnhancer: null | IMapEnhancer<T, unknown>

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

Readonly observable

observable: boolean

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

Readonly size

size: number

Returns

the number of elements in the Map.

Methods

[iterator]

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

  • Returns an iterable of entries in the map.

    Returns IterableIterator<[string, T]>

clear

  • Returns void

clone

  • Создает новый объект, который является копией текущего экземпляра.

    Returns IDictionary<T>

delete

  • Returns

    true if an element in the Map existed and has been removed, or false if the element does not exist.

    Parameters

    • key: string

    Returns boolean

dispose

  • Вызывает функции очистки всех внутренних ресурсов конейтенера.

    Returns void

entries

  • Returns an iterable of key, value pairs for every entry in the map.

    Returns IterableIterator<[string, T]>

forEach

  • Executes a provided function once per each key/value pair in the Map, in insertion order.

    Parameters

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

        • Parameters

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

          Returns void

    • Optional thisArg: any

    Returns void

get

  • Returns a specified element from the Map object. If the value that is associated to the provided key is an object, then you will get a reference to that object and any change made to that object will effectively modify it inside the Map.

    Returns

    Returns the element associated with the specified key. If no element is associated with the specified key, undefined is returned.

    Parameters

    • key: string

    Returns undefined | T

getVersionRef

has

  • Returns

    boolean indicating whether an element with the specified key exists or not.

    Parameters

    • key: string

    Returns boolean

keys

  • Returns an iterable of keys in the map

    Returns IterableIterator<string>

remove

  • Удаляет значение из хранилища по ключу.

    Returns

    true, если значение было найдено и удалено из хранилища; false, если значение не удалось найти.

    Remarks

    Аналогичен методу StorageMap.delete.

    Parameters

    • key: string

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

    Returns boolean

replaceWith

  • Заменяет все значения в контейнере на новые.

    Parameters

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

      Значения, которые будут добавлены в контейнер.

    Returns void

set

  • Adds a new element with a specified key and value to the Map. If an element with the same key already exists, the element will be updated.

    Parameters

    • key: string
    • value: T

    Returns IDictionary<T>

tryGet

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

    Returns

    Значение, полученное по ключу key, или undefined, если значение отсутствует.

    Parameters

    • key: string

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

    Returns undefined | T

  • Type Parameters

    • T

    Parameters

    • key: string

    Returns undefined | T

values

  • Returns an iterable of values in the map

    Returns IterableIterator<T>

Generated using TypeDoc