Class ViewResultRow

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

Hierarchy (View Summary, Expand)

Constructors

constructor

Properties

[toStringTag] collectionChanged defaultValueFactory ignoreCase mapEnhancer observable [species]

Accessors

size

Methods

[iterator] add clear clone delete dispose ensureCacheResolved entries forEach get getBoolean getNumber getOrAdd getStorage getString getVersionRef has keys notifyStorageUpdated remove replaceWith set tryGet values groupBy

Constructors

constructor

Properties

Readonly[toStringTag]

"[toStringTag]": string

ReadonlycollectionChanged

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

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

Remarks

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

ReadonlydefaultValueFactory

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

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

ReadonlyignoreCase

ignoreCase: boolean

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

ReadonlymapEnhancer

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

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

Readonlyobservable

observable: boolean

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

Static Readonly[species]

"[species]": MapConstructor

Accessors

size

  • get size(): number

    Количество пар ключ/значение в хранилище.

    Returns number

Methods

[iterator]

  • "[iterator]"(): MapIterator<[string, null | Primitive]>

    Итератор по парам ключ/значение в хранилище.

    Returns MapIterator<[string, null | Primitive]>

add

  • add(key: string): null | Primitive

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

    Parameters

    • key: string

      Ключ, для которого требуется создать и добавить значение по умолчанию.

    Returns null | Primitive

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

    Remarks

    Если объект фабрики defaultValueFactory не задан, то будет выброшено исключение.

  • add(key: string, item: null | Primitive): null | Primitive

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

    Parameters

    • key: string

      Ключ, для которого требуется создать и добавить значение.

    • item: null | Primitive

      Добавляемое значение.

    Returns null | Primitive

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

clear

  • clear(): void

    Удаляет все значения из хранилища.

    Returns void

clone

  • clone<M = ViewResultRow>(): M

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

    Type Parameters

    Returns M

delete

  • delete(key: string): boolean

    Удаляет значение из хранилища по ключу.

    Parameters

    • key: string

      Ключ, по которому требуется удалить значение.

    Returns boolean

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

dispose

  • dispose(): void

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

    Returns void

ensureCacheResolved

  • ensureCacheResolved(): void

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

    Returns void

entries

  • entries(): MapIterator<[string, null | Primitive]>

    Итератор по парам ключ/значение в хранилище.

    Returns MapIterator<[string, null | Primitive]>

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

get

  • get<
        T extends FieldType = FieldType,
        V extends Primitive = JsTypeFromFieldType<T>,
    >(
        key: string,
        type?: T,
    ): null | V

    Возвращает значение, полученное по ключу key.

    Type Parameters

    Parameters

    • key: string

      Ключ, по которому требуется найти значение.

    • Optionaltype: T

    Returns null | V

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

    Remarks

    При отсутствии объекта в хранилище будет выброшено исключение.

getBoolean

  • getBoolean(key: string): null | boolean

    Parameters

    • key: string

    Returns null | boolean

getNumber

  • getNumber(key: string): null | number

    Parameters

    • key: string

    Returns null | number

getOrAdd

  • getOrAdd(key: string, defaultItem?: () => null | Primitive): null | Primitive

    Возвращает значение по заданному ключу или создаёт и добавляет значение по умолчанию, причём в хранилище добавляется новый объект IStorage.

    Parameters

    • key: string

      Ключ, для которого требуется вернуть или создать и добавить значение по умолчанию.

    • OptionaldefaultItem: () => null | Primitive

      Функция создания дефолтного значения.

    Returns null | Primitive

    Запрошенное или созданное значение.

  • getOrAdd<T>(key: string, defaultItem?: () => T): T

    Возвращает значение по заданному ключу или создаёт и добавляет значение по умолчанию, причём в хранилище добавляется новый объект IStorage.

    Type Parameters

    • T

    Parameters

    • key: string

      Ключ, для которого требуется вернуть или создать и добавить значение по умолчанию.

    • OptionaldefaultItem: () => T

      Функция создания дефолтного значения.

    Returns T

    Запрошенное или созданное значение.

getStorage

  • getStorage(): IStorage

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

    Returns IStorage

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

getString

  • getString(key: string): null | string

    Parameters

    • key: string

    Returns null | string

getVersionRef

  • getVersionRef(): unknown

    Returns unknown

has

  • has(key: string): boolean

    Проверяет наличие заданного ключа в хранилище.

    Parameters

    • key: string

      Ключ, наличие которого требуется проверить.

    Returns boolean

    true, если заданный ключ присутствует в коллекции; false в противном случае.

keys

  • keys(): MapIterator<string>

    Итератор по ключам в хранилище.

    Returns MapIterator<string>

notifyStorageUpdated

  • notifyStorageUpdated(): void

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

    Returns void

remove

  • remove(key: string): boolean

    Удаляет значение из хранилища по ключу.

    Parameters

    • key: string

      Ключ, по которому требуется удалить значение.

    Returns boolean

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

    Remarks

    Аналогичен методу StorageMap.delete.

replaceWith

  • replaceWith(items: Iterable<readonly [string, null | Primitive]>): void

    Заменяет все значения в контейнере на новые.

    Parameters

    • items: Iterable<readonly [string, null | Primitive]>

      Значения, которые будут добавлены в контейнер.

    Returns void

set

  • set(key: string, value: null | Primitive): this

    Устанавливает значение по ключу.

    Parameters

    • key: string

      Ключ, по которому устанавливается значение.

    • value: null | Primitive

      Значение, которое устанавливается в хранилище.

    Returns this

    Возвращает ссылку на объект хранилище.

tryGet

  • tryGet(key: string): undefined | null | Primitive

    Возвращает значение, полученное по ключу key, или undefined, если значение отсутствует.

    Parameters

    • key: string

      Ключ, по которому требуется найти значение.

    Returns undefined | null | Primitive

    Значение, полученное по ключу key, или undefined, если значение отсутствует.

  • tryGet<T>(key: string): undefined | T

    Type Parameters

    • T

    Parameters

    • key: string

    Returns undefined | T

values

  • values(): MapIterator<null | Primitive>

    Итератор по значениям в хранилище.

    Returns MapIterator<null | Primitive>

StaticgroupBy

  • 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[]>

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods
MMNEPVFCICPMFPCPTTAAATR