Class CardStoreRequestHeaderFile

Заголовок для файлов передаваемый вместе с запросом на сохранение карточки.

Hierarchy

Implements

Constructors

constructor

Properties - Other

id

Properties - Static Keys

hashKey infoKey orderKey sizeKey

Accessors

hash info order size

Methods

clean clone ensureCacheResolved getStorage getStorageSettings isValid notifyStorageUpdated removeSystemInfo removeUserInfo tryGetInfo validate

Constructors

constructor

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

    Parameters

    • id: string

      Уникальный идентификатор файла, для которого формируется заголовок.

    • storage: IStorage<unknown> = {}

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

    Returns CardStoreRequestHeaderFile

Other Properties

Readonly id

id: string

Static Keys Properties

Static Readonly hashKey

hashKey: "Hash" = 'Hash'

Static Readonly infoKey

infoKey: "Info" = 'Info'

Static Readonly orderKey

orderKey: "Order" = 'Order'

Static Readonly sizeKey

sizeKey: "Size" = 'Size'

Accessors

hash

  • get hash(): null | string

  • Returns null | string

  • set hash(value: null | string): void

  • Parameters

    • value: null | string

    Returns void

info

  • get info(): IStorage<unknown>

  • Дополнительная пользовательская информация.

    Returns IStorage<unknown>

  • set info(value: IStorage<unknown>): void

  • Parameters

    Returns void

order

  • get order(): number

  • Returns number

  • set order(value: number): void

  • Parameters

    • value: number

    Returns void

size

  • get size(): number

  • Returns number

  • set size(value: number): void

  • Parameters

    • value: number

    Returns void

Methods

clean

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

    Returns void

clone

ensureCacheResolved

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

    Returns void

getStorage

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

    Returns

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

    Returns IStorage<unknown>

getStorageSettings

isValid

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

    Returns

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

    Returns boolean

notifyStorageUpdated

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

    Returns void

removeSystemInfo

  • Удаляет системную информацию, которая может располагаться в любом месте в хранилище текущего объекта и может быть найдена по ключам с префиксом StorageHelper.systemKeyPrefix.

    Returns void

removeUserInfo

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

    Returns void

tryGetInfo

  • Возвращает дополнительную пользовательскую информацию по текущему объекту или null, если информация ещё не была задана.

    Returns

    Дополнительная пользовательская информацию по текущему объекту или null, если информация ещё не была задана.

    Returns null | IStorage<unknown>

validate

  • Выполняет валидацию текущего объекта и всех его дочерних объектов.

    Returns

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

    Returns ValidationResult

Generated using TypeDoc