Class ValidationInfoStorageObject`Abstract`

Строго типизированный декоратор для хранилища IStorage, поддерживающий валидацию свойств и расширение произвольными данными через свойство info.

Hierarchy

ValidationStorageObject
- ValidationInfoStorageObject

Index

Constructors

Properties - Static Keys

Accessors

Methods

clean ensureCacheResolved getStorage getStorageSettings isValid notifyStorageUpdated removeSystemInfo removeUserInfo tryGetInfo validate

Constructors

constructor

new ValidationInfoStorageObject(storage?: IStorage<unknown>): ValidationInfoStorageObject
Parameters
- storage: IStorage<unknown> = {}
Returns ValidationInfoStorageObject
Overrides ValidationStorageObject.constructor
- Defined in @tessa/core/src/validation/validationInfoStorageObject.ts:13

Static Keys Properties

`Static` `Readonly` infoKey

infoKey: "Info" = 'Info'

Accessors

info

get info(): IStorage<unknown>
Дополнительная пользовательская информация.

Returns IStorage<unknown>
- Defined in @tessa/core/src/validation/validationInfoStorageObject.ts:31
set info(value: IStorage<unknown>): void
Parameters
- value: IStorage<unknown>
Returns void
- Defined in @tessa/core/src/validation/validationInfoStorageObject.ts:34

Methods

clean

clean(): void
Выполняет очистку хранилища от избыточных данных.

Returns void
Overrides ValidationStorageObject.clean
- Defined in @tessa/core/src/validation/validationInfoStorageObject.ts:98

ensureCacheResolved

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

Returns void
Inherited from ValidationStorageObject.ensureCacheResolved
- Defined in @tessa/core/src/storage/storageObject.ts:448

getStorage

getStorage(): IStorage<unknown>
Возвращает хранилище IStorage, декоратором для которого является текущий объект.

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

Returns IStorage<unknown>
Inherited from ValidationStorageObject.getStorage
- Defined in @tessa/core/src/storage/storageObject.ts:434

getStorageSettings

getStorageSettings(): Readonly<StorageSettings>
Возвращает настройки объекта-хранилища.

Returns Readonly<StorageSettings>
Inherited from ValidationStorageObject.getStorageSettings
- Defined in @tessa/core/src/storage/storageObject.ts:468

isValid

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

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

Returns boolean
Inherited from ValidationStorageObject.isValid
- Defined in @tessa/core/src/validation/validationStorageObject.ts:19

notifyStorageUpdated

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

Returns void
Inherited from ValidationStorageObject.notifyStorageUpdated
- Defined in @tessa/core/src/storage/storageObject.ts:454

removeSystemInfo

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

Returns void
- Defined in @tessa/core/src/validation/validationInfoStorageObject.ts:81

removeUserInfo

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

Returns void
- Defined in @tessa/core/src/validation/validationInfoStorageObject.ts:64

tryGetInfo

tryGetInfo(): null | IStorage<unknown>
Возвращает дополнительную пользовательскую информацию по текущему объекту или null, если информация ещё не была задана.

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

Returns null | IStorage<unknown>
- Defined in @tessa/core/src/validation/validationInfoStorageObject.ts:56

validate

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

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

Returns ValidationResult
Inherited from ValidationStorageObject.validate
- Defined in @tessa/core/src/validation/validationStorageObject.ts:13

Generated using TypeDoc