Class StorageMap<T, S>

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

Type Parameters

T = unknown
S extends IStorage | IStorageArray = IStorage

Hierarchy

Map
- StorageMap

Implements

Index

Constructors

constructor

new StorageMap<T, S>(storage: IStorage<unknown>, options?: {
    enhancer?: null | IMapEnhancer<T, unknown>;
    factory?: null | IKeyedStorageValueFactory<string, T, IStorage<unknown> | IStorageArray<unknown>>;
    ignoreCase?: boolean;
    mapLikeBehavior?: boolean;
    observable?: boolean;
}): StorageMap<T, S>
Создаёт экземпляр класса с указанием хранилища, декоратором для которого является создаваемый объект.
Type Parameters
- T = unknown
- S extends IStorage<unknown> | IStorageArray<unknown> = IStorage<unknown>
Parameters
- storage: IStorage<unknown>
  
  Хранилище, декоратором для которого является создаваемый объект.
- Optional options: {
      enhancer?: null | IMapEnhancer<T, unknown>;
      factory?: null | IKeyedStorageValueFactory<string, T, IStorage<unknown> | IStorageArray<unknown>>;
      ignoreCase?: boolean;
      mapLikeBehavior?: boolean;
      observable?: boolean;
  }
  
  Настройки объекта-декоратора.
  - Optional enhancer?: null | IMapEnhancer<T, unknown>
    
    Объект, позволяющий обрабатывать значения, добавляемые в объект-хранилище.
  - Optional factory?: null | IKeyedStorageValueFactory<string, T, IStorage<unknown> | IStorageArray<unknown>>
    
    Фабрика для создания значений по умолчанию.
  - Optional ignoreCase?: boolean
    
    Флаг, указывающий на то, что для доступа к элементам регистр ключа игнорируется.
  - Optional mapLikeBehavior?: boolean
    
    Флаг, указывающий на то, что объект, должен вести себя как дефолтный Map.
  - Optional observable?: boolean
    
    Флаг, включающий уведомления об изменении объектов. По умолчанию true.
Returns StorageMap<T, S>
Overrides Map.constructor
- Defined in @tessa/core/src/storage/storageMap.ts:53

Properties

`Readonly` [toStringTag]

[toStringTag]: string

`Readonly` collectionChanged

collectionChanged: EventHandler<DictionaryChangedEventArgs<T>, StorageMap<T, S>>

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

Remarks

Событие не будет вызвано при изменении внутреннего хранилища напрямую. Например через 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

Overrides Map.size
- Defined in @tessa/core/src/storage/storageMap.ts:587

Methods

[iterator]

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

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

Overrides Map.__@iterator@11
- Defined in @tessa/core/src/storage/storageMap.ts:595

add

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

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

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

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

clear

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

Returns void
Implementation of IDictionary.clear

Overrides Map.clear
- Defined in @tessa/core/src/storage/storageMap.ts:410

clone

clone<M>(): M
Создает новый объект, который является копией текущего экземпляра.
Type Parameters
- M = StorageMap<T, S>
Returns M
Implementation of ICloneable.clone
- Defined in @tessa/core/src/storage/storageMap.ts:686

delete

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

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

Overrides Map.delete
- Defined in @tessa/core/src/storage/storageMap.ts:436

dispose

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

Returns void
Implementation of IDictionary.dispose
- Defined in @tessa/core/src/storage/storageMap.ts:397

ensureCacheResolved

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

Returns void
Implementation of IStorageCachePolicyProvider.ensureCacheResolved
- Defined in @tessa/core/src/storage/storageMap.ts:668

entries

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

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

Overrides Map.entries
- Defined in @tessa/core/src/storage/storageMap.ts:606

forEach

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

Overrides Map.forEach
- Defined in @tessa/core/src/storage/storageMap.ts:468

get

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

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

Remarks
При отсутствии объекта в хранилище будет выброшено исключение.
Parameters
- key: string
  
  Ключ, по которому требуется найти значение.
Returns T
Implementation of IDictionary.get

Overrides Map.get
- Defined in @tessa/core/src/storage/storageMap.ts:482
get<T>(key: string): T
Type Parameters
- T
Parameters
- key: string
Returns T
Implementation of IDictionary.get

Overrides Map.get
- Defined in @tessa/core/src/storage/storageMap.ts:483

getOrAdd

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

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

getStorage

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

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

Returns S
Implementation of IStorageProvider.getStorage
- Defined in @tessa/core/src/storage/storageMap.ts:650

getVersionRef

getVersionRef(): unknown
Returns unknown
Implementation of IVersionRefProvider.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

Overrides Map.has
- Defined in @tessa/core/src/storage/storageMap.ts:510

keys

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

Returns IterableIterator<string>
Implementation of IDictionary.keys

Overrides Map.keys
- Defined in @tessa/core/src/storage/storageMap.ts:617

notifyStorageUpdated

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

Returns void
Implementation of IStorageNotificationReceiver.notifyStorageUpdated
- Defined in @tessa/core/src/storage/storageMap.ts:658

remove

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

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

Remarks
Аналогичен методу delete.
Parameters
- key: string
  
  Ключ, по которому требуется удалить значение.
Returns boolean
Implementation of IDictionary.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
- Defined in @tessa/core/src/storage/storageMap.ts:336

set

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

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

Overrides Map.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
- 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
- Defined in @tessa/core/src/storage/storageMap.ts:350

values

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

Returns IterableIterator<T>
Implementation of IDictionary.values

Overrides Map.values
- Defined in @tessa/core/src/storage/storageMap.ts:627

Class StorageMap<T, S>

Type Parameters

T = unknown

S extends IStorage | IStorageArray = IStorage

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

T = unknown

S extends IStorage<unknown> | IStorageArray<unknown> = IStorage<unknown>

Parameters

storage: IStorage<unknown>

Optional options: { enhancer?: null | IMapEnhancer<T, unknown>; factory?: null | IKeyedStorageValueFactory<string, T, IStorage<unknown> | IStorageArray<unknown>>; ignoreCase?: boolean; mapLikeBehavior?: boolean; observable?: boolean; }

Optional enhancer?: null | IMapEnhancer<T, unknown>

Optional factory?: null | IKeyedStorageValueFactory<string, T, IStorage<unknown> | IStorageArray<unknown>>

Optional ignoreCase?: boolean

Optional mapLikeBehavior?: boolean

Optional observable?: boolean

Returns StorageMap<T, S>

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 = StorageMap<T, S>

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: StorageMap<T, S>) => void)

Parameters

value: T

key: string

map: StorageMap<T, S>

Returns void

Optional thisArg: unknown

Returns void

get

Returns

`Optional` options: {
enhancer?: null | IMapEnhancer<T, unknown>;
factory?: null | IKeyedStorageValueFactory<string, T, IStorage<unknown> | IStorageArray<unknown>>;
ignoreCase?: boolean;
mapLikeBehavior?: boolean;
observable?: boolean;
}

`Optional` enhancer?: null | IMapEnhancer<T, unknown>

`Optional` factory?: null | IKeyedStorageValueFactory<string, T, IStorage<unknown> | IStorageArray<unknown>>

`Optional` ignoreCase?: boolean

`Optional` mapLikeBehavior?: boolean

`Optional` observable?: boolean

`Readonly` [toStringTag]

`Readonly` collectionChanged

`Readonly` defaultValueFactory

`Readonly` ignoreCase

`Readonly` mapEnhancer

`Readonly` observable

`Static` `Readonly` [species]

`Optional` thisArg: unknown

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

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