Class ViewResultRow

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

Hierarchy

Dictionary<Primitive | null>
- ViewResultRow

Index

Constructors

constructor

new ViewResultRow(values?: null | IStorage<unknown> | Iterable<readonly [string, null | Primitive]>): ViewResultRow
Parameters
- Optional values: null | IStorage<unknown> | Iterable<readonly [string, null | Primitive]>
Returns ViewResultRow
Overrides Dictionary.constructor
- Defined in @tessa/platform/src/views/service/viewResultRow.ts:16

Properties

`Readonly` [toStringTag]

[toStringTag]: string

`Readonly` collectionChanged

collectionChanged: EventHandler<DictionaryChangedEventArgs<null | Primitive>, ViewResultRow>

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

Remarks

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

`Readonly` defaultValueFactory

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

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

`Readonly` ignoreCase

ignoreCase: boolean

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

`Readonly` mapEnhancer

mapEnhancer: null | IMapEnhancer<null | Primitive, unknown>

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

`Readonly` observable

observable: boolean

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

`Static` `Readonly` [species]

[species]: MapConstructor

Accessors

size

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

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

Methods

[iterator]

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

Returns IterableIterator<[string, null | Primitive]>
Inherited from Dictionary.[iterator]
- Defined in @tessa/core/src/storage/storageMap.ts:595

add

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

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

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

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

clear

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

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

clone

clone<M>(): M
Создает новый объект, который является копией текущего экземпляра.
Type Parameters
- M = ViewResultRow
Returns M
Overrides Dictionary.clone
- Defined in @tessa/platform/src/views/service/viewResultRow.ts:63

delete

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

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

dispose

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

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

ensureCacheResolved

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

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

entries

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

Returns IterableIterator<[string, null | Primitive]>
Inherited from Dictionary.entries
- Defined in @tessa/core/src/storage/storageMap.ts:606

forEach

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

get

get<T, V>(key: string, type?: T): null | V
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.
Type Parameters
- T extends FieldType = FieldType
- V extends Primitive = JsTypeFromFieldType<T>
Parameters
- key: string
- Optional type: T
Returns null | V
Overrides Dictionary.get
- Defined in @tessa/platform/src/views/service/viewResultRow.ts:35

getBoolean

getBoolean(key: string): null | boolean
Parameters
- key: string
Returns null | boolean
- Defined in @tessa/platform/src/views/service/viewResultRow.ts:55

getNumber

getNumber(key: string): null | number
Parameters
- key: string
Returns null | number
- Defined in @tessa/platform/src/views/service/viewResultRow.ts:51

getOrAdd

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

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

getStorage

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

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

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

getString

getString(key: string): null | string
Parameters
- key: string
Returns null | string
- Defined in @tessa/platform/src/views/service/viewResultRow.ts:47

getVersionRef

getVersionRef(): unknown
Returns unknown
Inherited from Dictionary.getVersionRef
- Defined in @tessa/core/src/storage/storageMap.ts:697

has

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

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

keys

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

Returns IterableIterator<string>
Inherited from Dictionary.keys
- Defined in @tessa/core/src/storage/storageMap.ts:617

notifyStorageUpdated

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

Returns void
Inherited from Dictionary.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
Inherited from Dictionary.remove
- Defined in @tessa/core/src/storage/storageMap.ts:332

replaceWith

replaceWith(items: Iterable<readonly [string, null | Primitive]>): void
Заменяет все значения в контейнере на новые.
Parameters
- items: Iterable<readonly [string, null | Primitive]>
  
  Значения, которые будут добавлены в контейнер.
Returns void
Inherited from Dictionary.replaceWith
- Defined in @tessa/core/src/storage/storageMap.ts:336

set

set(key: string, value: null | Primitive): ViewResultRow
Устанавливает значение по ключу.

Returns
Возвращает ссылку на объект хранилище.
Parameters
- key: string
  
  Ключ, по которому устанавливается значение.
- value: null | Primitive
  
  Значение, которое устанавливается в хранилище.
Returns ViewResultRow
Inherited from Dictionary.set
- Defined in @tessa/core/src/storage/storageMap.ts:528

tryGet

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

Returns
Значение, полученное по ключу key, или undefined, если значение отсутствует.
Parameters
- key: string
  
  Ключ, по которому требуется найти значение.
Returns undefined | null | Primitive
Inherited from Dictionary.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
Inherited from Dictionary.tryGet
- Defined in @tessa/core/src/storage/storageMap.ts:350

values

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

Returns IterableIterator<null | Primitive>
Inherited from Dictionary.values
- Defined in @tessa/core/src/storage/storageMap.ts:627

Class ViewResultRow

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

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

Returns ViewResultRow

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, null | Primitive]>

add

Returns

Remarks

Parameters

key: string

Returns null | Primitive

Returns

Parameters

key: string

item: null | Primitive

Returns null | Primitive

clear

Returns void

clone

Type Parameters

M = ViewResultRow

Returns M

delete

Returns

Parameters

key: string

Returns boolean

dispose

Returns void

ensureCacheResolved

Returns void

entries

Returns IterableIterator<[string, null | Primitive]>

forEach

Parameters

callbackfn: ((value: null | Primitive, key: string, map: ViewResultRow) => void)

Parameters

value: null | Primitive

key: string

map: ViewResultRow

Returns void

Optional thisArg: unknown

Returns void

get

Returns

Type Parameters

T extends FieldType = FieldType

V extends Primitive = JsTypeFromFieldType<T>

Parameters

key: string

Optional type: T

Returns null | V

getBoolean

Parameters

key: string

Returns null | boolean

getNumber

Parameters

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

`Readonly` [toStringTag]

`Readonly` collectionChanged

`Readonly` defaultValueFactory

`Readonly` ignoreCase

`Readonly` mapEnhancer

`Readonly` observable

`Static` `Readonly` [species]

`Optional` thisArg: unknown

`Optional` type: T

`Optional` defaultItem: (() => null | Primitive)

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