Class StorageObjectStateProvider

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

Remarks

При отсутствии служебной информации в хранилище на момент создания объекта эта информация не будет добавлена в хранилища до тех пор, пока не произойдёт первый вызов метода setChanged.

Hierarchy

  • StorageObjectStateProvider

Implements

Constructors

constructor

Methods

clean clearChanges getAllChanges hasChanges isChanged notifyStorageUpdated setChanged

Constructors

constructor

  • Создаёт экземпляр класса с указанием хранилища storage, для которого объект предоставляет информацию, и ключа changedListKey, по которому будет размещаться служебная информация, необходимая объекту для отслеживания состояний.

    Parameters

    • storage: IStorage<unknown>

      Хранилище, для которого объект предоставляет информацию.

    • changedListKey: string

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

    • Optional enhancer: null | IListEnhancer<string, unknown>

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

    Returns StorageObjectStateProvider

Methods

clean

  • Выполняет очистку хранилища от избыточных данных.

    Returns void

clearChanges

getAllChanges

  • Возвращает коллекцию ключей всех объектов, значения которых были изменены.

    Returns

    Коллекция ключей всех объектов, значения которых были изменены.

    Returns string[]

hasChanges

  • Возвращает признак того, что объект содержит изменённые поля.

    Returns

    true, если объект содержит изменённые поля; false в противном случае.

    Returns boolean

isChanged

  • Возвращает признак того, что значение объекта с ключом key было изменено.

    Returns

    true, если значение объекта было изменено; false, если значение объекта осталось неизменным.

    Parameters

    • key: string

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

    Returns boolean

notifyStorageUpdated

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

    Returns void

setChanged

  • Устанавливает признак isChanged, определяющий, было ли изменено значение объекта с ключом key.

    Returns

    Текущий объект для цепочки вызовов.

    Parameters

    • key: string

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

    • isChanged: boolean = true

      Устанавливаемый признак наличия изменений в значении объекта с заданным ключом. Равен true, если значение объекта считается изменённым; false, если значение объекта считается неизменным.

    Returns IStorageObjectStateProvider

Generated using TypeDoc