Class ViewResultRow

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

Hierarchy (View Summary)

Dictionary<Primitive | null>
- ViewResultRow

Index

Constructors

constructor

new ViewResultRow(
    values?:
        | null
        | IStorage
        | Iterable<readonly [string, null | Primitive], any, any>,
): ViewResultRow
Parameters
- Optionalvalues: null | IStorage | Iterable<readonly [string, null | Primitive], any, any>
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 | IStorageArray,
    >

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

`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:597

Methods

[iterator]

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

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

add

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

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

clear

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

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

clone

clone<M = ViewResultRow>(): 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
Удаляет значение из хранилища по ключу.
Parameters
- key: string
  Ключ, по которому требуется удалить значение.
Returns boolean
true, если значение было найдено и удалено из хранилища; false, если значение не удалось найти.
Inherited from Dictionary.delete
- Defined in @tessa/core/src/storage/storageMap.ts:446

dispose

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

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

ensureCacheResolved

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

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

entries

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

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

forEach

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

get

get<
    T extends FieldType = FieldType,
    V extends Primitive = JsTypeFromFieldType<T>,
>(
    key: string,
    type?: T,
): null | V
Возвращает значение, полученное по ключу key.
Type Parameters
- T extends FieldType = FieldType
- V extends Primitive = JsTypeFromFieldType<T>
Parameters
- key: string
  Ключ, по которому требуется найти значение.
- Optionaltype: T
Returns null | V
Значение, полученное по ключу key.

Remarks
При отсутствии объекта в хранилище будет выброшено исключение.
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.
Parameters
- key: string
  Ключ, для которого требуется вернуть или создать и добавить значение по умолчанию.
- OptionaldefaultItem: () => null | Primitive
  Функция создания дефолтного значения.
Returns null | Primitive
Запрошенное или созданное значение.
Inherited from Dictionary.getOrAdd
- Defined in @tessa/core/src/storage/storageMap.ts:385
getOrAdd<T>(key: string, defaultItem?: () => T): T
Возвращает значение по заданному ключу или создаёт и добавляет значение по умолчанию, причём в хранилище добавляется новый объект IStorage.
Type Parameters
- T
Parameters
- key: string
  Ключ, для которого требуется вернуть или создать и добавить значение по умолчанию.
- OptionaldefaultItem: () => T
  Функция создания дефолтного значения.
Returns T
Запрошенное или созданное значение.
Inherited from Dictionary.getOrAdd
- Defined in @tessa/core/src/storage/storageMap.ts:386

getStorage

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

Returns IStorage
Хранилище IStorage, декоратором для которого является текущий объект.
Inherited from Dictionary.getStorage
- Defined in @tessa/core/src/storage/storageMap.ts:707

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:754

has

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

keys

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

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

notifyStorageUpdated

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

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

remove

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

Remarks
Аналогичен методу StorageMap.delete.
Inherited from Dictionary.remove
- Defined in @tessa/core/src/storage/storageMap.ts:342

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:346

set

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

tryGet

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

values

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

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

`Static`groupBy

groupBy<K, T>(
items: Iterable<T>,
keySelector: (item: T, index: number) => K,
): Map<K, T[]>
Groups members of an iterable according to the return value of the passed callback.
Type Parameters
- K
- T
Parameters
- items: Iterable<T>
  An iterable.
- keySelector: (item: T, index: number) => K
  A callback which will be invoked for each item in items.
Returns Map<K, T[]>
Inherited from Dictionary.groupBy
- Defined in ../../node_modules/typescript/lib/lib.es2024.collection.d.ts:25

Class ViewResultRow

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns ViewResultRow

Properties

Readonly[toStringTag]

ReadonlycollectionChanged

Remarks

ReadonlydefaultValueFactory

ReadonlyignoreCase

ReadonlymapEnhancer

Readonlyobservable

Static Readonly[species]

Accessors

size

Returns number

Methods

[iterator]

Returns MapIterator<[string, null | Primitive]>

add

Parameters

Returns null | Primitive

Remarks

Parameters

Returns null | Primitive

clear

Returns void

clone

Type Parameters

Returns M

delete

Parameters

Returns boolean

dispose

Returns void

ensureCacheResolved

Returns void

entries

Returns MapIterator<[string, null | Primitive]>

forEach

Parameters

Returns void

get

Type Parameters

Parameters

Returns null | V

Remarks

getBoolean

Parameters

Returns null | boolean

getNumber

Parameters

Returns null | number

getOrAdd

Parameters

Returns null | Primitive

Type Parameters

Parameters

Returns T

getStorage

Returns IStorage

getString

Parameters

Returns null | string

getVersionRef

Returns unknown

has

Parameters

Returns boolean

keys

Returns MapIterator<string>

notifyStorageUpdated

Returns void

`Readonly`[toStringTag]

`Readonly`collectionChanged

`Readonly`defaultValueFactory

`Readonly`ignoreCase

`Readonly`mapEnhancer

`Readonly`observable

`Static` `Readonly`[species]

`Static`groupBy