Interface Result

Input validation result.

Combines messages sent by all registered validators.

Implements Iterable interface by iterating over all validation messages.

Hierarchy

Iterable<Message>
- Result
  - Ok
  - InValidation.Errors

Index

Properties

Methods

[iterator] has hasBut messages

Properties

`Readonly` ok

ok: boolean

Whether validation succeed.

This is true when there is no validation messages, or false otherwise.

Methods

[iterator]

[iterator](): IterableIterator<Message>
Returns IterableIterator<Message>
Overrides Iterable.[iterator]
- Defined in frontmeans/input-aspects/src/validation/validation.aspect.ts:204

has

has(code?): boolean
Checks whether there are errors with the given code.
Parameters
- Optional code: string
  
  Target code. Any message matches when absent.
Returns boolean
true if there is at least one message with the given code, or false otherwise.
- Defined in frontmeans/input-aspects/src/validation/validation.aspect.ts:193

hasBut

hasBut(...codes): boolean
Checks whether there are errors without the given codes.
Parameters
- Rest ...codes: string[]
  
  Excluded codes. Any message matches when empty.
Returns boolean
true is there is at least one message without any of the given codes, or false otherwise.
- Defined in frontmeans/input-aspects/src/validation/validation.aspect.ts:202

messages

messages(code?): readonly Message[]
Returns messages with the given code.
Parameters
- Optional code: string
  
  Target code. All messages reported when absent.
Returns readonly Message[]
An array of matching messages. Possibly empty.
- Defined in frontmeans/input-aspects/src/validation/validation.aspect.ts:184

Generated using TypeDoc