Class FieldStorageMap

constructor

• new FieldStorageMap(storage: IStorage): FieldStorageMap

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

  Parameters

  • storage: IStorage

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

  Returns FieldStorageMap

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

Readonly[toStringTag]

ReadonlyfieldChanged

size

• get size(): number

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

  Returns number

[iterator]

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

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

  Type Parameters

  • T extends null | Primitive = Primitive

  Returns MapIterator<[string, T]>

clear

• clear(): void

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

  Returns void

clone

• clone(): FieldStorageMap

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

  Returns FieldStorageMap

delete

• delete(key: string): boolean

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

  Parameters

  • key: string

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

  Returns boolean

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

ensureCacheResolved

• ensureCacheResolved(): void

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

  Returns void

entries

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

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

  Type Parameters

  • T extends null | Primitive = Primitive

  Returns MapIterator<[string, T]>

entryFields

• entryFields<T extends null | TypedField = TypedField>(): MapIterator<
      [string, T],
  >

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

  Type Parameters

  • T extends null | TypedField = TypedField

  Returns MapIterator<[string, T]>

fields

• fields<T extends null | TypedField = TypedField>(): MapIterator<T>

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

  Type Parameters

  • T extends null | TypedField = TypedField

  Returns MapIterator<T>

forEach

• forEach<T extends null | Primitive = Primitive>(
      callbackfn: (value: T, key: string, map: this) => void,
      thisArg?: unknown,
  ): void

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

  Type Parameters

  • T extends null | Primitive = Primitive

  Parameters

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

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

  • OptionalthisArg: unknown

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

  Returns void

forEachFields

• forEachFields<T extends null | TypedField = TypedField>(
      callbackfn: (value: null | T, key: string, map: this) => void,
      thisArg?: unknown,
  ): void

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

  Type Parameters

  • T extends null | TypedField = TypedField

  Parameters

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

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

  • OptionalthisArg: unknown

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

  Returns void

get

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

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

  Type Parameters

  • T extends undefined | null | Primitive = Primitive

  Parameters

  • key: string

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

  • Optionaltype: FieldType

  Returns null | T

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

  Remarks

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

getBoolean

• getBoolean(key: string): null | boolean

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

  Parameters

  • key: string

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

  Returns null | boolean

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

  Remarks

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

getField

• getField<T extends undefined | null | TypedField = TypedField>(
      key: string,
  ): null | T

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

  Type Parameters

  • T extends undefined | null | TypedField = TypedField

  Parameters

  • key: string

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

  Returns null | T

  Поле, полученное по ключу key.

  Remarks

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

getNumber

• getNumber(key: string): null | number

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

  Parameters

  • key: string

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

  Returns null | number

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

  Remarks

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

getStorage

• getStorage(): IStorage

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

  Returns IStorage

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

getString

• getString(key: string): null | string

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

  Parameters

  • key: string

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

  Returns null | string

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

  Remarks

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

has

• has(key: string): boolean

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

  Parameters

  • key: string

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

  Returns boolean

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

init

• init(
      stateProvider?: IStorageObjectStateProvider,
      changedAction?: VoidFunction,
  ): void

  Инициализирует хранилище.

  Parameters

  • OptionalstateProvider: IStorageObjectStateProvider

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

  • OptionalchangedAction: VoidFunction

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

  Returns void

keys

• keys(): MapIterator<string>

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

  Returns MapIterator<string>

notifyStorageUpdated

• notifyStorageUpdated(): void

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

  Returns void

rawSet

• rawSet<T extends null | Primitive = Primitive>(
      key: string,
      value: null | T | TypedFieldFromValue<NonNullable<T>>,
      type?: FieldTypeFromJsType<NonNullable<T>>,
  ): this

  Устанавливает значение по ключу. При этом не будут вызваны никакие уведомления об изменении.

  Type Parameters

  • T extends null | Primitive = Primitive

  Parameters

  • key: string

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

  • value: null | T | TypedFieldFromValue<NonNullable<T>>

    Значение или типизированное поле.

  • Optionaltype: FieldTypeFromJsType<NonNullable<T>>

    Тип значения.

  Returns this

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

remove

• remove(key: string): boolean

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

  Parameters

  • key: string

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

  Returns boolean

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

  Remarks

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

set

• set<T extends null | Primitive = Primitive>(
      key: string,
      value: null | T | TypedFieldFromValue<NonNullable<T>>,
      type?: FieldTypeFromJsType<NonNullable<T>>,
  ): this

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

  Type Parameters

  • T extends null | Primitive = Primitive

  Parameters

  • key: string

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

  • value: null | T | TypedFieldFromValue<NonNullable<T>>

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

  • Optionaltype: FieldTypeFromJsType<NonNullable<T>>

  Returns this

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

systemSet

• systemSet<T extends null | Primitive = Primitive>(
      key: string,
      value: null | T | TypedFieldFromValue<NonNullable<T>>,
      type?: FieldTypeFromJsType<NonNullable<T>>,
  ): this

  Устанавливает значение по ключу. При этом не будут вызваны уведомления о изменении состояния через IStorageObjectStateProvider.

  Type Parameters

  • T extends null | Primitive = Primitive

  Parameters

  • key: string

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

  • value: null | T | TypedFieldFromValue<NonNullable<T>>

    Значение или типизированное поле.

  • Optionaltype: FieldTypeFromJsType<NonNullable<T>>

    Тип значения.

  Returns this

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

tryGet

• tryGet<T extends undefined | null | Primitive = Primitive>(
      key: string,
      type?: FieldType,
  ): null | T

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

  Type Parameters

  • T extends undefined | null | Primitive = Primitive

  Parameters

  • key: string

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

  • Optionaltype: FieldType

  Returns null | T

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

tryGetBoolean

• tryGetBoolean(key: string): null | boolean

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

  Parameters

  • key: string

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

  Returns null | boolean

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

tryGetField

• tryGetField<T extends undefined | null | TypedField = TypedField>(
      key: string,
  ): null | T

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

  Type Parameters

  • T extends undefined | null | TypedField = TypedField

  Parameters

  • key: string

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

  Returns null | T

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

tryGetNumber

• tryGetNumber(key: string): null | number

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

  Parameters

  • key: string

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

  Returns null | number

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

tryGetString

• tryGetString(key: string): null | string

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

  Parameters

  • key: string

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

  Returns null | string

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

values

• values<T extends null | Primitive = Primitive>(): MapIterator<T>

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

  Type Parameters

  • T extends null | Primitive = Primitive

  Returns MapIterator<T>