Class ValidationResultBuilder

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

Implements

IValidationResultBuilder

Index

Constructors

Accessors

hasData isSuccessful items

Methods

add build clear

Constructors

constructor

new ValidationResultBuilder(): ValidationResultBuilder
Returns ValidationResultBuilder
- Defined in @tessa/core/src/validation/validationResultBuilder.ts:14

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/validationResultBuilder.ts:36

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/validationResultBuilder.ts:32

items

get items(): readonly ValidationResultItem[]
Validation messages.

Returns readonly ValidationResultItem[]
Implementation of IValidationResultBuilder.items
- Defined in @tessa/core/src/validation/validationResultBuilder.ts:28

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.
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.
- OptionalfieldName: null | string
  Name of the field of the object to which the validation message refers, or null if the field is unknown.
- OptionalobjectName: null | string
  Name of the object to which the validation message refers, or null if name is unknown.
- OptionalobjectType: null | string
  Type of the object to which the validation message refers, or null if type is unknown.
- Optionaldetails: null | string
  Additional information about the message, such as full text of exception, or null if there is no additional information.
Returns IValidationResultBuilder
Текущий объект IValidationResultBuilder.
Implementation of IValidationResultBuilder.add
- Defined in @tessa/core/src/validation/validationResultBuilder.ts:44
add(validationResult: ValidationResult): IValidationResultBuilder
Добавляет копию указанного сообщения валидации.
Parameters
- validationResult: ValidationResult
  Сообщение валидации, копия которого добавляется.
Returns IValidationResultBuilder
Текущий объект IValidationResultBuilder.
Implementation of IValidationResultBuilder.add
- Defined in @tessa/core/src/validation/validationResultBuilder.ts:53
add(validationResultBuilder: IValidationResultBuilder): IValidationResultBuilder
Добавляет сообщения валидации, которые были добавлены в заданный объект, выполняющий построение результата валидации.
Parameters
- validationResultBuilder: IValidationResultBuilder
  Объект, выполняющий построение результата валидации. Нельзя передать текущий объект в качестве параметра.
Returns IValidationResultBuilder
Текущий объект IValidationResultBuilder.
Implementation of IValidationResultBuilder.add
- Defined in @tessa/core/src/validation/validationResultBuilder.ts:54

build

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

Returns ValidationResult
Результат валидации.
Implementation of IValidationResultBuilder.build
- Defined in @tessa/core/src/validation/validationResultBuilder.ts:74

clear

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

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