Class Dictionary<T>

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

Type Parameters

T = unknown

Hierarchy

StorageMap<T>
- Dictionary
  - ViewResultRow

Implements

IDictionary<T>

Index

Constructors

constructor

new Dictionary<T>(values?: null | IStorage<unknown> | Iterable<readonly [string, T]>, options?: DictionaryCreateOptions<T>): Dictionary<T>
Type Parameters
- T = unknown
Parameters
- Optional values: null | IStorage<unknown> | Iterable<readonly [string, T]>
- Optional options: DictionaryCreateOptions<T>
Returns Dictionary<T>
Overrides StorageMap.constructor
- Defined in @tessa/core/src/common/dictionary.ts:123

Properties

`Readonly` [toStringTag]

[toStringTag]: string

`Readonly` collectionChanged

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

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

Remarks

Событие не будет вызвано при изменении внутреннего хранилища напрямую. Например через StorageMap.getStorage.

`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

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

`Static` `Readonly` [species]

[species]: MapConstructor

Accessors

size

get size(): number
Количество пар ключ/значение в хранилище.

Returns number
Implementation of IDictionary.size

Inherited from StorageMap.size
- Defined in @tessa/core/src/storage/storageMap.ts:587

Methods

[iterator]

[iterator](): IterableIterator<[string, T]>
Итератор по парам ключ/значение в хранилище.

Returns IterableIterator<[string, T]>
Implementation of IDictionary.[iterator]

Inherited from StorageMap.[iterator]
- Defined in @tessa/core/src/storage/storageMap.ts:595

add

add(key: string): T
Создаёт и добавляет значение по умолчанию с заданным ключом, причём в хранилище добавляется новый объект IStorage.

Returns
Созданное значение.

Remarks
Если объект фабрики defaultValueFactory не задан, то будет выброшено исключение.
Parameters
- key: string
  
  Ключ, для которого требуется создать и добавить значение по умолчанию.
Returns T
Inherited from StorageMap.add
- Defined in @tessa/core/src/storage/storageMap.ts:262
add(key: string, item: T): T
Создаёт и добавляет значение по умолчанию с заданным ключом, причём в хранилище добавляется новый объект IStorage.

Returns
Созданное значение.
Parameters
- key: string
  
  Ключ, для которого требуется создать и добавить значение.
- item: T
  
  Добавляемое значение.
Returns T
Inherited from StorageMap.add
- Defined in @tessa/core/src/storage/storageMap.ts:270

clear

clear(): void
Удаляет все значения из хранилища.

Returns void
Implementation of IDictionary.clear

Inherited from StorageMap.clear
- Defined in @tessa/core/src/storage/storageMap.ts:410

clone

clone<M>(): M
Создает новый объект, который является копией текущего экземпляра.
Type Parameters
- M = Dictionary<T>
Returns M
Implementation of IDictionary.clone

Overrides StorageMap.clone
- Defined in @tessa/core/src/common/dictionary.ts:218

delete

delete(key: string): boolean
Удаляет значение из хранилища по ключу.

Returns
true, если значение было найдено и удалено из хранилища; false, если значение не удалось найти.
Parameters
- key: string
  
  Ключ, по которому требуется удалить значение.
Returns boolean
Implementation of IDictionary.delete

Inherited from StorageMap.delete
- Defined in @tessa/core/src/storage/storageMap.ts:436

dispose

dispose(): void
Вызывает функции очистки всех внутренних ресурсов конейтенера.

Returns void
Implementation of IDictionary.dispose

Inherited from StorageMap.dispose
- Defined in @tessa/core/src/storage/storageMap.ts:397

ensureCacheResolved

ensureCacheResolved(): void
Выполняет резолв кеша декораторов для данных объекта-хранилища.

Returns void
Inherited from StorageMap.ensureCacheResolved
- Defined in @tessa/core/src/storage/storageMap.ts:668

entries

entries(): IterableIterator<[string, T]>
Итератор по парам ключ/значение в хранилище.

Returns IterableIterator<[string, T]>
Implementation of IDictionary.entries

Inherited from StorageMap.entries
- Defined in @tessa/core/src/storage/storageMap.ts:606

forEach

forEach(callbackfn: ((value: T, key: string, map: Dictionary<T>) => void), thisArg?: unknown): void
Вызывает колбек-функцию для каждого значения в хранилище.
Parameters
- callbackfn: ((value: T, key: string, map: Dictionary<T>) => void)
  
  Колбек-функция, вызываемая для каждого объекта в хранилище. Ключ и значение передаются в качестве параметров.
  - - (value: T, key: string, map: Dictionary<T>): void
    - Parameters
      
      value: T
      
      key: string
      
      map: Dictionary<T>
      
      Returns void
- Optional thisArg: unknown
  
  Объект контекста вызова функции-колбека.
Returns void
Implementation of IDictionary.forEach

Inherited from StorageMap.forEach
- Defined in @tessa/core/src/storage/storageMap.ts:468

get

get(key: string): undefined | T
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
Implementation of IDictionary.get

Overrides StorageMap.get
- Defined in @tessa/core/src/common/dictionary.ts:208
get<T>(key: string): undefined | T
Type Parameters
- T
Parameters
- key: string
Returns undefined | T
Implementation of IDictionary.get

Overrides StorageMap.get
- Defined in @tessa/core/src/common/dictionary.ts:209

getOrAdd

getOrAdd(key: string, defaultItem?: (() => T)): T
Возвращает значение по заданному ключу или создаёт и добавляет значение по умолчанию, причём в хранилище добавляется новый объект IStorage.

Returns
Запрошенное или созданное значение.
Parameters
- key: string
  
  Ключ, для которого требуется вернуть или создать и добавить значение по умолчанию.
- Optional defaultItem: (() => T)
  
  Функция создания дефолтного значения.
  - - (): T
    - Returns T
Returns T
Inherited from StorageMap.getOrAdd
- Defined in @tessa/core/src/storage/storageMap.ts:375
getOrAdd<T>(key: string, defaultItem?: (() => T)): T
Type Parameters
- T
Parameters
- key: string
- Optional defaultItem: (() => T)
  - - (): T
    - Returns T
Returns T
Inherited from StorageMap.getOrAdd
- Defined in @tessa/core/src/storage/storageMap.ts:376

getStorage

getStorage(): IStorage<unknown>
Возвращает хранилище IStorage, декоратором для которого является текущий объект.

Returns
Хранилище IStorage, декоратором для которого является текущий объект.

Returns IStorage<unknown>
Inherited from StorageMap.getStorage
- Defined in @tessa/core/src/storage/storageMap.ts:650

getVersionRef

getVersionRef(): unknown
Returns unknown
Implementation of IDictionary.getVersionRef

Inherited from StorageMap.getVersionRef
- Defined in @tessa/core/src/storage/storageMap.ts:697

has

has(key: string): boolean
Проверяет наличие заданного ключа в хранилище.

Returns
true, если заданный ключ присутствует в коллекции; false в противном случае.
Parameters
- key: string
  
  Ключ, наличие которого требуется проверить.
Returns boolean
Implementation of IDictionary.has

Inherited from StorageMap.has
- Defined in @tessa/core/src/storage/storageMap.ts:510

keys

keys(): IterableIterator<string>
Итератор по ключам в хранилище.

Returns IterableIterator<string>
Implementation of IDictionary.keys

Inherited from StorageMap.keys
- Defined in @tessa/core/src/storage/storageMap.ts:617

notifyStorageUpdated

notifyStorageUpdated(): void
Метод, уведомляющий объект о наличии изменений в его хранилище.

Returns void
Inherited from StorageMap.notifyStorageUpdated
- Defined in @tessa/core/src/storage/storageMap.ts:658

remove

remove(key: string): boolean
Удаляет значение из хранилища по ключу.

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

Remarks
Аналогичен методу StorageMap.delete.
Parameters
- key: string
  
  Ключ, по которому требуется удалить значение.
Returns boolean
Implementation of IDictionary.remove

Inherited from StorageMap.remove
- Defined in @tessa/core/src/storage/storageMap.ts:332

replaceWith

replaceWith(items: Iterable<readonly [string, T]>): void
Заменяет все значения в контейнере на новые.
Parameters
- items: Iterable<readonly [string, T]>
  
  Значения, которые будут добавлены в контейнер.
Returns void
Implementation of IDictionary.replaceWith

Inherited from StorageMap.replaceWith
- Defined in @tessa/core/src/storage/storageMap.ts:336

set

set(key: string, value: T): Dictionary<T>
Устанавливает значение по ключу.

Returns
Возвращает ссылку на объект хранилище.
Parameters
- key: string
  
  Ключ, по которому устанавливается значение.
- value: T
  
  Значение, которое устанавливается в хранилище.
Returns Dictionary<T>
Implementation of IDictionary.set

Inherited from StorageMap.set
- Defined in @tessa/core/src/storage/storageMap.ts:528

tryGet

tryGet(key: string): undefined | T
Возвращает значение, полученное по ключу key, или undefined, если значение отсутствует.

Returns
Значение, полученное по ключу key, или undefined, если значение отсутствует.
Parameters
- key: string
  
  Ключ, по которому требуется найти значение.
Returns undefined | T
Implementation of IDictionary.tryGet

Inherited from StorageMap.tryGet
- Defined in @tessa/core/src/storage/storageMap.ts:349
tryGet<T>(key: string): undefined | T
Type Parameters
- T
Parameters
- key: string
Returns undefined | T
Implementation of IDictionary.tryGet

Inherited from StorageMap.tryGet
- Defined in @tessa/core/src/storage/storageMap.ts:350

values

values(): IterableIterator<T>
Итератор по значениям в хранилище.

Returns IterableIterator<T>
Implementation of IDictionary.values

Inherited from StorageMap.values
- Defined in @tessa/core/src/storage/storageMap.ts:627

Class Dictionary<T>

Type Parameters

T = unknown

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

T = unknown

Parameters

Optional values: null | IStorage<unknown> | Iterable<readonly [string, T]>

Optional options: DictionaryCreateOptions<T>

Returns Dictionary<T>

Properties

Readonly [toStringTag]

Readonly collectionChanged

Remarks

Readonly defaultValueFactory

Readonly ignoreCase

Readonly mapEnhancer

Readonly observable

Static Readonly [species]

Accessors

size

Returns number

Methods

[iterator]

Returns IterableIterator<[string, T]>

add

Returns

Remarks

Parameters

key: string

Returns T

Returns

Parameters

key: string

item: T

Returns T

clear

Returns void

clone

Type Parameters

M = Dictionary<T>

Returns M

delete

Returns

Parameters

key: string

Returns boolean

dispose

Returns void

ensureCacheResolved

Returns void

entries

Returns IterableIterator<[string, T]>

forEach

Parameters

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

Parameters

value: T

key: string

map: Dictionary<T>

Returns void

Optional thisArg: unknown

Returns void

get

Returns

Parameters

key: string

Returns undefined | T

Type Parameters

T

Parameters

key: string

`Optional` values: null | IStorage<unknown> | Iterable<readonly [string, T]>

`Optional` options: DictionaryCreateOptions<T>

`Readonly` [toStringTag]

`Readonly` collectionChanged

`Readonly` defaultValueFactory

`Readonly` ignoreCase

`Readonly` mapEnhancer

`Readonly` observable

`Static` `Readonly` [species]

`Optional` thisArg: unknown

`Optional` defaultItem: (() => T)

`Optional` defaultItem: (() => T)