Class FieldStorageMap

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

Hierarchy

FieldStorageMap
- CardRow

Implements

Index

Constructors

constructor

new FieldStorageMap(storage: IStorage<unknown>): FieldStorageMap
Создаёт экземпляр класса с указанием хранилища, декоратором для которого является создаваемый объект и позволяющий явно работать с TypedField значениями.

Returns
Строго типизированный декоратор для объекта-хранилища.
Parameters
- storage: IStorage<unknown>
  
  Хранилище, декоратором для которого является создаваемый объект.
Returns FieldStorageMap
- Defined in @tessa/core/src/storage/fieldStorageMap.ts:42

Properties

`Readonly` [toStringTag]

[toStringTag]: "Map" = 'Map'

`Readonly` fieldChanged

fieldChanged: EventHandler<FieldStorageMapChangedEventArgs, FieldStorageMap>

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

Remarks

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

Accessors

size

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

Returns number
Implementation of Map.size
- Defined in @tessa/core/src/storage/fieldStorageMap.ts:82

Methods

[iterator]

[iterator]<T>(): IterableIterator<[string, T]>
Итератор по парам ключ/значение в хранилище.
Type Parameters
- T extends null | Primitive = Primitive
Returns IterableIterator<[string, T]>
Implementation of Map.__@iterator@11
- Defined in @tessa/core/src/storage/fieldStorageMap.ts:543

clear

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

Returns void
Implementation of Map.clear
- Defined in @tessa/core/src/storage/fieldStorageMap.ts:480

clone

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

Returns FieldStorageMap
Implementation of ICloneable.clone
- Defined in @tessa/core/src/storage/fieldStorageMap.ts:637

delete

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

Returns
true, если значение было найдено и удалено из хранилища; false, если значение не удалось найти.
Parameters
- key: string
  
  Ключ, по которому требуется удалить значение.
Returns boolean
Implementation of Map.delete
- Defined in @tessa/core/src/storage/fieldStorageMap.ts:444

ensureCacheResolved

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

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

entries

entries<T>(): IterableIterator<[string, T]>
Итератор по парам ключ/значение в хранилище.
Type Parameters
- T extends null | Primitive = Primitive
Returns IterableIterator<[string, T]>
Implementation of Map.entries
- Defined in @tessa/core/src/storage/fieldStorageMap.ts:553

entryFields

entryFields<T>(): IterableIterator<[string, T]>
Итератор по парам ключ/поле в хранилище.
Type Parameters
- T extends null | TypedField<FieldType, string | number | boolean> = TypedField<FieldType, string | number | boolean>
Returns IterableIterator<[string, T]>
- Defined in @tessa/core/src/storage/fieldStorageMap.ts:563

fields

fields<T>(): IterableIterator<T>
Итератор по полям в хранилище.
Type Parameters
- T extends null | TypedField<FieldType, string | number | boolean> = TypedField<FieldType, string | number | boolean>
Returns IterableIterator<T>
- Defined in @tessa/core/src/storage/fieldStorageMap.ts:593

forEach

forEach<T>(callbackfn: ((value: T, key: string, map: FieldStorageMap) => void), thisArg?: unknown): void
Вызывает колбек-функцию для каждого значения в хранилище.
Type Parameters
- T extends null | Primitive = Primitive
Parameters
- callbackfn: ((value: T, key: string, map: FieldStorageMap) => void)
  
  Колбек-функция, вызываемая для каждого объекта в хранилище. Ключ и значение передаются в качестве параметров.
  - - (value: T, key: string, map: FieldStorageMap): void
    - Parameters
      
      value: T
      
      key: string
      
      map: FieldStorageMap
      
      Returns void
- Optional thisArg: unknown
  
  Объект контекста вызова функции-колбека.
Returns void
Implementation of Map.forEach
- Defined in @tessa/core/src/storage/fieldStorageMap.ts:514

forEachFields

forEachFields<T>(callbackfn: ((value: null | T, key: string, map: FieldStorageMap) => void), thisArg?: unknown): void
Вызывает колбек-функцию для каждого поля в хранилище.
Type Parameters
- T extends null | TypedField<FieldType, string | number | boolean> = TypedField<FieldType, string | number | boolean>
Parameters
- callbackfn: ((value: null | T, key: string, map: FieldStorageMap) => void)
  
  Колбек-функция, вызываемая для каждого поля в хранилище. Ключ и поле передаются в качестве параметров.
  - - (value: null | T, key: string, map: FieldStorageMap): void
    - Parameters
      
      value: null | T
      
      key: string
      
      map: FieldStorageMap
      
      Returns void
- Optional thisArg: unknown
  
  Объект контекста вызова функции-колбека.
Returns void
- Defined in @tessa/core/src/storage/fieldStorageMap.ts:530

get

get<T>(key: string, type?: FieldType): null | T
Возвращает значение, полученное по ключу key.

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

Remarks
При отсутствии объекта в хранилище будет выброшено исключение.
Type Parameters
- T extends undefined | null | Primitive = Primitive
Parameters
- key: string
  
  Ключ, по которому требуется найти значение.
- Optional type: FieldType
Returns null | T
Implementation of Map.get
- Defined in @tessa/core/src/storage/fieldStorageMap.ts:219

getBoolean

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

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

Remarks
При отсутствии объекта в хранилище будет выброшено исключение.
Parameters
- key: string
  
  Ключ, по которому требуется найти значение.
Returns null | boolean
- Defined in @tessa/core/src/storage/fieldStorageMap.ts:249

getField

getField<T>(key: string): null | T
Возвращает поле, полученное по ключу key.

Returns
Поле, полученное по ключу key.

Remarks
При отсутствии объекта в хранилище будет выброшено исключение.
Type Parameters
- T extends undefined | null | TypedField<FieldType, string | number | boolean> = TypedField<FieldType, string | number | boolean>
Parameters
- key: string
  
  Ключ, по которому требуется найти поле.
Returns null | T
- Defined in @tessa/core/src/storage/fieldStorageMap.ts:322

getNumber

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

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

Remarks
При отсутствии объекта в хранилище будет выброшено исключение.
Parameters
- key: string
  
  Ключ, по которому требуется найти значение.
Returns null | number
- Defined in @tessa/core/src/storage/fieldStorageMap.ts:239

getStorage

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

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

Returns IStorage<unknown>
Implementation of IStorageProvider.getStorage
- Defined in @tessa/core/src/storage/fieldStorageMap.ts:615

getString

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

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

Remarks
При отсутствии объекта в хранилище будет выброшено исключение.
Parameters
- key: string
  
  Ключ, по которому требуется найти значение.
Returns null | string
- Defined in @tessa/core/src/storage/fieldStorageMap.ts:229

has

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

Returns
true, если заданный ключ присутствует в коллекции; false в противном случае.
Parameters
- key: string
  
  Ключ, наличие которого требуется проверить.
Returns boolean
Implementation of Map.has
- Defined in @tessa/core/src/storage/fieldStorageMap.ts:359

init

init(stateProvider?: IStorageObjectStateProvider, changedAction?: VoidFunction): void
Инициализирует хранилище.
Parameters
- Optional stateProvider: IStorageObjectStateProvider
  
  Объект, предоставляющий информацию о наличии изменений в значениях объектов хранилища.
- Optional changedAction: VoidFunction
  
  Колбек-функция, вызываемая при изменении объекта-хранилища.
Returns void
- Defined in @tessa/core/src/storage/fieldStorageMap.ts:206

keys

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

Returns IterableIterator<string>
Implementation of Map.keys
- Defined in @tessa/core/src/storage/fieldStorageMap.ts:573

notifyStorageUpdated

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

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

rawSet

rawSet<T>(key: string, value: null | T | TypedFieldFromValue<NonNullable<T>, FieldTypeFromJsType<NonNullable<T>>>, type?: FieldTypeFromJsType<NonNullable<T>>): FieldStorageMap
Устанавливает значение по ключу. При этом не будут вызваны никакие уведомления об изменении.

Returns
Возвращает ссылку на объект хранилище.
Type Parameters
- T extends null | Primitive = Primitive
Parameters
- key: string
  
  Ключ, по которому устанавливается значение.
- value: null | T | TypedFieldFromValue<NonNullable<T>, FieldTypeFromJsType<NonNullable<T>>>
  
  Значение или типизированное поле.
- Optional type: FieldTypeFromJsType<NonNullable<T>>
  
  Тип значения.
Returns FieldStorageMap
- Defined in @tessa/core/src/storage/fieldStorageMap.ts:399

remove

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

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

Remarks
Аналогичен методу delete.
Parameters
- key: string
  
  Ключ, по которому требуется удалить значение.
Returns boolean
- Defined in @tessa/core/src/storage/fieldStorageMap.ts:473

set

set<T>(key: string, value: null | T | TypedFieldFromValue<NonNullable<T>, FieldTypeFromJsType<NonNullable<T>>>, type?: FieldTypeFromJsType<NonNullable<T>>): FieldStorageMap
Устанавливает значение по ключу.

Returns
Возвращает ссылку на объект хранилище.
Type Parameters
- T extends null | Primitive = Primitive
Parameters
- key: string
  
  Ключ, по которому устанавливается значение.
- value: null | T | TypedFieldFromValue<NonNullable<T>, FieldTypeFromJsType<NonNullable<T>>>
  
  Значение, которое устанавливается в хранилище.
- Optional type: FieldTypeFromJsType<NonNullable<T>>
Returns FieldStorageMap
Implementation of Map.set
- Defined in @tessa/core/src/storage/fieldStorageMap.ts:374

systemSet

systemSet<T>(key: string, value: null | T | TypedFieldFromValue<NonNullable<T>, FieldTypeFromJsType<NonNullable<T>>>, type?: FieldTypeFromJsType<NonNullable<T>>): FieldStorageMap
Устанавливает значение по ключу. При этом не будут вызваны уведомления о изменении состояния через IStorageObjectStateProvider.

Returns
Возвращает ссылку на объект хранилище.
Type Parameters
- T extends null | Primitive = Primitive
Parameters
- key: string
  
  Ключ, по которому устанавливается значение.
- value: null | T | TypedFieldFromValue<NonNullable<T>, FieldTypeFromJsType<NonNullable<T>>>
  
  Значение или типизированное поле.
- Optional type: FieldTypeFromJsType<NonNullable<T>>
  
  Тип значения.
Returns FieldStorageMap
- Defined in @tessa/core/src/storage/fieldStorageMap.ts:422

tryGet

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

Returns
Значение, полученное по ключу key, или null, если значение отсутствует.
Type Parameters
- T extends undefined | null | Primitive = Primitive
Parameters
- key: string
  
  Ключ, по которому требуется найти значение.
- Optional type: FieldType
Returns null | T
- Defined in @tessa/core/src/storage/fieldStorageMap.ts:260

tryGetBoolean

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

Returns
Значение, полученное по ключу key, или null, если значение отсутствует.
Parameters
- key: string
  
  Ключ, по которому требуется найти значение.
Returns null | boolean
- Defined in @tessa/core/src/storage/fieldStorageMap.ts:304

tryGetField

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

Returns
Поле, полученное по ключу key, или undefined, если поле отсутствует.
Type Parameters
- T extends undefined | null | TypedField<FieldType, string | number | boolean> = TypedField<FieldType, string | number | boolean>
Parameters
- key: string
  
  Ключ, по которому требуется найти поле.
Returns null | T
- Defined in @tessa/core/src/storage/fieldStorageMap.ts:342

tryGetNumber

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

Returns
Значение, полученное по ключу key, или null, если значение отсутствует.
Parameters
- key: string
  
  Ключ, по которому требуется найти значение.
Returns null | number
- Defined in @tessa/core/src/storage/fieldStorageMap.ts:290

tryGetString

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

Returns
Значение, полученное по ключу key, или null, если значение отсутствует.
Parameters
- key: string
  
  Ключ, по которому требуется найти значение.
Returns null | string
- Defined in @tessa/core/src/storage/fieldStorageMap.ts:276

values

values<T>(): IterableIterator<T>
Итератор по значениям в хранилище.
Type Parameters
- T extends null | Primitive = Primitive
Returns IterableIterator<T>
Implementation of Map.values
- Defined in @tessa/core/src/storage/fieldStorageMap.ts:583

Class FieldStorageMap

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns

Parameters

storage: IStorage<unknown>

Returns FieldStorageMap

Properties

Readonly [toStringTag]

Readonly fieldChanged

Remarks

Accessors

size

Returns number

Methods

[iterator]

Type Parameters

T extends null | Primitive = Primitive

Returns IterableIterator<[string, T]>

clear

Returns void

clone

Returns FieldStorageMap

delete

Returns

Parameters

key: string

Returns boolean

ensureCacheResolved

Returns void

entries

Type Parameters

T extends null | Primitive = Primitive

Returns IterableIterator<[string, T]>

entryFields

Type Parameters

T extends null | TypedField<FieldType, string | number | boolean> = TypedField<FieldType, string | number | boolean>

Returns IterableIterator<[string, T]>

fields

Type Parameters

T extends null | TypedField<FieldType, string | number | boolean> = TypedField<FieldType, string | number | boolean>

Returns IterableIterator<T>

forEach

Type Parameters

T extends null | Primitive = Primitive

Parameters

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

Parameters

value: T

key: string

map: FieldStorageMap

Returns void

Optional thisArg: unknown

Returns void

forEachFields

Type Parameters

T extends null | TypedField<FieldType, string | number | boolean> = TypedField<FieldType, string | number | boolean>

Parameters

callbackfn: ((value: null | T, key: string, map: FieldStorageMap) => void)

Parameters

value: null | T

key: string

map: FieldStorageMap

Returns void

Optional thisArg: unknown

Returns void

get

Returns

Remarks

Type Parameters

T extends undefined | null | Primitive = Primitive

Parameters

key: string

`Readonly` [toStringTag]

`Readonly` fieldChanged

`Optional` thisArg: unknown

`Optional` thisArg: unknown

`Optional` type: FieldType

`Optional` stateProvider: IStorageObjectStateProvider

`Optional` changedAction: VoidFunction

`Optional` type: FieldTypeFromJsType<NonNullable<T>>