TESSA Web API
    Preparing search index...

    Interface ReadonlyStorageMap<T, S>

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

    interface ReadonlyStorageMap<
        T = unknown,
        S extends IStorage | IStorageArray = IStorage,
    > {
        "[toStringTag]": string;
        defaultValueFactory:
            | null
            | IKeyedStorageValueFactory<string, T, IStorage | IStorageArray>;
        ignoreCase: boolean;
        mapEnhancer: null | IMapEnhancer<T, unknown>;
        observable: boolean;
        size: number;
        "[iterator]"(): MapIterator<[string, T]>;
        clone<M = StorageMap<T, S>>(): M;
        dispose(): void;
        ensureCacheResolved(): void;
        entries(): MapIterator<[string, T]>;
        forEach(
            callbackfn: (value: T, key: string, map: this) => void,
            thisArg?: unknown,
        ): void;
        get(key: string): T;
        get<T>(key: string): T;
        getStorage(): S;
        getVersionRef(): unknown;
        has(key: string): boolean;
        keys(): MapIterator<string>;
        notifyStorageUpdated(): void;
        replaceWith(items: Iterable<readonly [string, T]>): void;
        tryGet(key: string): undefined | T;
        tryGet<T>(key: string): undefined | T;
        values(): MapIterator<T>;
    }

    Type Parameters

    Hierarchy (View Summary)

    Index

    Properties

    [toStringTag] defaultValueFactory ignoreCase mapEnhancer observable size

    Methods

    [iterator] clone dispose ensureCacheResolved entries forEach get getStorage getVersionRef has keys notifyStorageUpdated replaceWith tryGet values

    Properties

    "[toStringTag]": string
    defaultValueFactory:
        | null
        | IKeyedStorageValueFactory<string, T, IStorage | IStorageArray>

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

    ignoreCase: boolean

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

    mapEnhancer: null | IMapEnhancer<T, unknown>

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

    observable: boolean

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

    size: number

    Methods

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

      Returns MapIterator<[string, T]>

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

      Type Parameters

      Returns M

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

      Returns void

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

      Returns void

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

      Returns MapIterator<[string, T]>

    • Вызывает колбек-функцию для каждого значения в хранилище.

      Parameters

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

        Колбек-функция, вызываемая для каждого объекта в хранилище. Ключ и значение передаются в качестве параметров.

      • OptionalthisArg: unknown

        Объект контекста вызова функции-колбека.

      Returns void

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

      Parameters

      • key: string

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

      Returns T

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

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

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

      Type Parameters

      • T

      Parameters

      • key: string

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

      Returns T

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

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

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

      Returns S

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

    • Returns unknown

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

      Parameters

      • key: string

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

      Returns boolean

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

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

      Returns MapIterator<string>

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

      Returns void

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

      Parameters

      • items: Iterable<readonly [string, T]>

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

      Returns void

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

      Parameters

      • key: string

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

      Returns undefined | T

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

    • Type Parameters

      • T

      Parameters

      • key: string

      Returns undefined | T

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

      Returns MapIterator<T>

    Settings

    Member Visibility

    On This Page

    Properties
    Methods