Class ValidationStorageResultBuilder

An object that builds the validation result in the storage IStorage.

Hierarchy

ValidationStorageObject
- ValidationStorageResultBuilder

Implements

IValidationResultBuilder

Index

Constructors

constructor

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

Static Keys Properties

`Static` `Readonly` itemsKey

itemsKey: "Items" = 'Items'

Accessors

hasData

get hasData(): boolean
Returns an indication that the object contains validation messages.

Returns boolean
Implementation of IValidationResultBuilder.hasData
- Defined in @tessa/core/src/validation/validationStorageResultBuilder.ts:44

isSuccessful

get isSuccessful(): boolean
Returns an indication that the validation result will succeed when built.

Returns boolean
Implementation of IValidationResultBuilder.isSuccessful
- Defined in @tessa/core/src/validation/validationStorageResultBuilder.ts:39

items

get items(): StorageArray<ValidationStorageResultItem>
Validation messages.

Returns StorageArray<ValidationStorageResultItem>
Implementation of IValidationResultBuilder.items
- Defined in @tessa/core/src/validation/validationStorageResultBuilder.ts:53
set items(value: ValidationStorageResultItem[]): void
Validation messages.
Parameters
- value: ValidationStorageResultItem[]
Returns void
Implementation of IValidationResultBuilder.items
- Defined in @tessa/core/src/validation/validationStorageResultBuilder.ts:64

Methods

add

add(key: ValidationKey, type: ValidationResultType, message: string | Error, fieldName?: null | string, objectName?: null | string, objectType?: null | string, details?: null | string): IValidationResultBuilder
Adds an informational message with the specified text.

Returns
Текущий объект IValidationResultBuilder.
Parameters
- key: ValidationKey
  
  Key of the validation message.
- type: ValidationResultType
  
  Type of the validation message.
- message: string | Error
  
  Text of the message or error object that occurred during validation.
- Optional fieldName: null | string
  
  Name of the field of the object to which the validation message refers, or null if the field is unknown.
- Optional objectName: null | string
  
  Name of the object to which the validation message refers, or null if name is unknown.
- Optional objectType: null | string
  
  Type of the object to which the validation message refers, or null if type is unknown.
- Optional details: null | string
  
  Additional information about the message, such as full text of exception, or null if there is no additional information.
Returns IValidationResultBuilder
Implementation of IValidationResultBuilder.add
- Defined in @tessa/core/src/validation/validationStorageResultBuilder.ts:91
add(validationResult: ValidationResult): IValidationResultBuilder
Добавляет копию указанного сообщения валидации.

Returns
Текущий объект IValidationResultBuilder.
Parameters
- validationResult: ValidationResult
  
  Сообщение валидации, копия которого добавляется.
Returns IValidationResultBuilder
Implementation of IValidationResultBuilder.add
- Defined in @tessa/core/src/validation/validationStorageResultBuilder.ts:100
add(validationResultBuilder: IValidationResultBuilder): IValidationResultBuilder
Добавляет сообщения валидации, которые были добавлены в заданный объект, выполняющий построение результата валидации.

Returns
Текущий объект IValidationResultBuilder.
Parameters
- validationResultBuilder: IValidationResultBuilder
  
  Объект, выполняющий построение результата валидации. Нельзя передать текущий объект в качестве параметра.
Returns IValidationResultBuilder
Implementation of IValidationResultBuilder.add
- Defined in @tessa/core/src/validation/validationStorageResultBuilder.ts:101

build

build(): ValidationResult
Выполняет построение объекта, содержащего результат валидации.

Returns
Результат валидации.

Returns ValidationResult
Implementation of IValidationResultBuilder.build
- Defined in @tessa/core/src/validation/validationStorageResultBuilder.ts:121

clean

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

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

clear

clear(): void
Удаляет все сообщения валидации.

Returns void
Implementation of IValidationResultBuilder.clear
- Defined in @tessa/core/src/validation/validationStorageResultBuilder.ts:137

ensureCacheResolved

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

Returns void
Overrides ValidationStorageObject.ensureCacheResolved
- Defined in @tessa/core/src/validation/validationStorageResultBuilder.ts:152

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

tryGetItems

tryGetItems(): null | StorageArray<ValidationStorageResultItem>
Returns a list of validation messages, or null if the list has not yet been initialized.

Returns null | StorageArray<ValidationStorageResultItem>
- Defined in @tessa/core/src/validation/validationStorageResultBuilder.ts:75

validate

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

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

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

Class ValidationStorageResultBuilder

Hierarchy

Implements

Index

Constructors

Properties - Static Keys

Accessors

Methods

Constructors

constructor

Parameters

storage: IStorage<unknown> = {}

Returns ValidationStorageResultBuilder

Static Keys Properties

Static Readonly itemsKey

Accessors

hasData

Returns boolean

isSuccessful

Returns boolean

items

Returns StorageArray<ValidationStorageResultItem>

Parameters

value: ValidationStorageResultItem[]

Returns void

Methods

add

Returns

Parameters

key: ValidationKey

type: ValidationResultType

message: string | Error

Optional fieldName: null | string

Optional objectName: null | string

Optional objectType: null | string

Optional details: null | string

Returns IValidationResultBuilder

Returns

Parameters

validationResult: ValidationResult

Returns IValidationResultBuilder

Returns

Parameters

validationResultBuilder: IValidationResultBuilder

Returns IValidationResultBuilder

build

Returns

Returns ValidationResult

clean

Returns void

clear

Returns void

ensureCacheResolved

Returns void

getStorage

Returns

Returns IStorage<unknown>

getStorageSettings

Returns Readonly<StorageSettings>

isValid

Returns

Returns boolean

notifyStorageUpdated

Returns void

tryGetItems

Returns null | StorageArray<ValidationStorageResultItem>

validate

Returns

Returns ValidationResult

`Static` `Readonly` itemsKey

`Optional` fieldName: null | string

`Optional` objectName: null | string

`Optional` objectType: null | string

`Optional` details: null | string