Class ValidationStorageResultItem

Validation message contained in the storage IStorage.

Hierarchy

ValidationInfoStorageObject
- ValidationStorageResultItem

Implements

IValidationResultItem

Index

Constructors

constructor

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

Static Keys Properties

`Static` `Readonly` detailsKey

detailsKey: "Details" = 'Details'

`Static` `Readonly` fieldNameKey

fieldNameKey: "FieldName" = 'FieldName'

`Static` `Readonly` infoKey

infoKey: "Info" = 'Info'

`Static` `Readonly` keyKey

keyKey: "Key" = 'Key'

`Static` `Readonly` messageKey

messageKey: "Message" = 'Message'

`Static` `Readonly` objectNameKey

objectNameKey: "ObjectName" = 'ObjectName'

`Static` `Readonly` objectTypeKey

objectTypeKey: "ObjectType" = 'ObjectType'

`Static` `Readonly` typeKey

typeKey: "Type" = 'Type'

Accessors

details

get details(): string
Additional information about the message, such as the full text of the exception, or '' if there is no additional information.

Returns string
Implementation of IValidationResultItem.details
- Defined in @tessa/core/src/validation/validationStorageResultItem.ts:103
set details(value: string): void
Additional information about the message, such as the full text of the exception, or '' if there is no additional information.
Parameters
- value: string
Returns void
Implementation of IValidationResultItem.details
- Defined in @tessa/core/src/validation/validationStorageResultItem.ts:106

fieldName

get fieldName(): string
The name of the field of the object to which the validation message refers, or '' if the field is unknown.

Returns string
Implementation of IValidationResultItem.fieldName
- Defined in @tessa/core/src/validation/validationStorageResultItem.ts:82
set fieldName(value: string): void
The name of the field of the object to which the validation message refers, or '' if the field is unknown.
Parameters
- value: string
Returns void
Implementation of IValidationResultItem.fieldName
- Defined in @tessa/core/src/validation/validationStorageResultItem.ts:85

info

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

Returns IStorage<unknown>
Implementation of IValidationResultItem.info

Inherited from ValidationInfoStorageObject.info
- Defined in @tessa/core/src/validation/validationInfoStorageObject.ts:31
set info(value: IStorage<unknown>): void
Additional info.
Parameters
- value: IStorage<unknown>
Returns void
Implementation of IValidationResultItem.info

Inherited from ValidationInfoStorageObject.info
- Defined in @tessa/core/src/validation/validationInfoStorageObject.ts:34

key

get key(): ValidationKey
The key of the message that occurred during validation.

Returns ValidationKey
Implementation of IValidationResultItem.key
- Defined in @tessa/core/src/validation/validationStorageResultItem.ts:60
set key(value: ValidationKey): void
The key of the message that occurred during validation.
Parameters
- value: ValidationKey
Returns void
Implementation of IValidationResultItem.key
- Defined in @tessa/core/src/validation/validationStorageResultItem.ts:64

message

get message(): string
The text of the message that occurred during validation.

Returns string
Implementation of IValidationResultItem.message
- Defined in @tessa/core/src/validation/validationStorageResultItem.ts:75
set message(value: string): void
The text of the message that occurred during validation.
Parameters
- value: string
Returns void
Implementation of IValidationResultItem.message
- Defined in @tessa/core/src/validation/validationStorageResultItem.ts:78

objectName

get objectName(): string
The name of the object to which the validation message refers, or '' if the name is unknown.

Returns string
Implementation of IValidationResultItem.objectName
- Defined in @tessa/core/src/validation/validationStorageResultItem.ts:89
set objectName(value: string): void
The name of the object to which the validation message refers, or '' if the name is unknown.
Parameters
- value: string
Returns void
Implementation of IValidationResultItem.objectName
- Defined in @tessa/core/src/validation/validationStorageResultItem.ts:92

objectType

get objectType(): string
The type of the object to which the validation message refers, or '' if the type is unknown.

Returns string
Implementation of IValidationResultItem.objectType
- Defined in @tessa/core/src/validation/validationStorageResultItem.ts:96
set objectType(value: string): void
The type of the object to which the validation message refers, or '' if the type is unknown.
Parameters
- value: string
Returns void
Implementation of IValidationResultItem.objectType
- Defined in @tessa/core/src/validation/validationStorageResultItem.ts:99

type

get type(): ValidationResultType
The type of message that occurred during validation.

Returns ValidationResultType
Implementation of IValidationResultItem.type
- Defined in @tessa/core/src/validation/validationStorageResultItem.ts:68
set type(value: ValidationResultType): void
The type of message that occurred during validation.
Parameters
- value: ValidationResultType
Returns void
Implementation of IValidationResultItem.type
- Defined in @tessa/core/src/validation/validationStorageResultItem.ts:71

Methods

clean

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

Returns void
Inherited from ValidationInfoStorageObject.clean
- Defined in @tessa/core/src/validation/validationInfoStorageObject.ts:98

ensureCacheResolved

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

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

getStorage

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

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

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

getStorageSettings

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

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

isEmpty

isEmpty(): boolean
Returns an indication that the object does not contain meaningful data for the cleanup method.

Returns
true if the object does not contain data that is meaningful to the cleanup method; false otherwise.

Returns boolean
- Defined in @tessa/core/src/validation/validationStorageResultItem.ts:120

isValid

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

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

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

notifyStorageUpdated

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

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

removeSystemInfo

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

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

removeUserInfo

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

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

tryGetInfo

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

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

Returns null | IStorage<unknown>
Implementation of IValidationResultItem.tryGetInfo

Inherited from ValidationInfoStorageObject.tryGetInfo
- Defined in @tessa/core/src/validation/validationInfoStorageObject.ts:56

validate

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

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

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

Class ValidationStorageResultItem

Hierarchy

Implements

Index

Constructors

Properties - Static Keys

Accessors

Methods

Constructors

constructor

Parameters

storage: IStorage<unknown> = {}

Returns ValidationStorageResultItem

Static Keys Properties

Static Readonly detailsKey

Static Readonly fieldNameKey

Static Readonly infoKey

Static Readonly keyKey

Static Readonly messageKey

Static Readonly objectNameKey

Static Readonly objectTypeKey

Static Readonly typeKey

Accessors

details

Returns string

Parameters

value: string

Returns void

fieldName

Returns string

Parameters

value: string

Returns void

info

Returns IStorage<unknown>

Parameters

value: IStorage<unknown>

Returns void

key

Returns ValidationKey

Parameters

value: ValidationKey

Returns void

message

Returns string

Parameters

value: string

Returns void

objectName

Returns string

Parameters

value: string

Returns void

objectType

Returns string

Parameters

value: string

Returns void

type

Returns ValidationResultType

Parameters

value: ValidationResultType

Returns void

Methods

clean

Returns void

ensureCacheResolved

Returns void

getStorage

Returns

Returns IStorage<unknown>

getStorageSettings

Returns Readonly<StorageSettings>

isEmpty

Returns

Returns boolean

isValid

Returns

Returns boolean

notifyStorageUpdated

`Static` `Readonly` detailsKey

`Static` `Readonly` fieldNameKey

`Static` `Readonly` infoKey

`Static` `Readonly` keyKey

`Static` `Readonly` messageKey

`Static` `Readonly` objectNameKey

`Static` `Readonly` objectTypeKey

`Static` `Readonly` typeKey