Class ValidationTarget<T>

Represents a value that is being validated.

This class is not intended to replace undefined or null references but to record additional information alongside them.

Instead of throwing an error when an undefined or null value is accessed, the system marks it as invalid and continues to record validation failures.

Type Parameters

T
the type of the value

Index

Constructors

constructor

Methods

ifValid isNull isUndefined isValid map or orGet orThrow toString undefinedOrNullToInvalid validationFailed invalid valid

Constructors

constructor

new ValidationTarget<T>(valid: boolean, value: T): ValidationTarget<T>
Creates a value that may be invalid.
Type Parameters
- T
Parameters
- valid: boolean
  true if the value is valid, or false if invalid
- value: T
  the value
Returns ValidationTarget<T>
- Defined in internal/util/ValidationTarget.mts:30

Methods

ifValid

ifValid(consumer: (value: T) => void): void
Consumes the value if it is valid. If the value is invalid, no action is taken.
Parameters
- consumer: (value: T) => void
  consumes the value if it is valid
Returns void
- Defined in internal/util/ValidationTarget.mts:94

isNull

isNull(): boolean
Checks if the value is null.

Returns boolean
true if the value is null; false otherwise
- Defined in internal/util/ValidationTarget.mts:173

isUndefined

isUndefined(): boolean
Checks if the value is null.

Returns boolean
true if the value is undefined; false otherwise
- Defined in internal/util/ValidationTarget.mts:163

isValid

isValid(): boolean
Checks if the value is valid.

Returns boolean
true if the value is valid; false otherwise
- Defined in internal/util/ValidationTarget.mts:153

map

map<U>(mapper: (value: T) => U): ValidationTarget<U>
Applies a function to the value if it is valid. If the value is invalid, no action is taken.
Type Parameters
- U
  the type of value returned by the mapper
Parameters
- mapper: (value: T) => U
  the function to apply to the value if it is valid
Returns ValidationTarget<U>
this if the value is invalid; otherwise, a MaybeInvalid instance wrapping the result of applying the mapper to the value
- Defined in internal/util/ValidationTarget.mts:108

or

or(defaultValue: T): T
Returns the valid value, or a default value if invalid. A value of null does not hold any special significance. It does not imply that the value is invalid.
Parameters
- defaultValue: T
  a value
Returns T
the valid value, or defaultValue if the value is invalid
- Defined in internal/util/ValidationTarget.mts:66
or(defaultValue: null | T): null | T
Returns the valid value, or a default value if invalid. A value of null does not hold any special significance. It does not imply that the value is invalid.
Parameters
- defaultValue: null | T
  a value
Returns null | T
the valid value, or defaultValue if the value is invalid
- Defined in internal/util/ValidationTarget.mts:67

orGet

orGet(defaultValue: () => T): T
Returns the valid value, or a default value if invalid. A value of null does not hold any special significance. It does not imply that the value is invalid.
Parameters
- defaultValue: () => T
  a supplier that returns the default value
Returns T
the valid value, or defaultValue if the value is invalid
- Defined in internal/util/ValidationTarget.mts:82

orThrow

orThrow(errorSupplier: () => Error): T
Returns the value or throws an error if invalid.
Parameters
- errorSupplier: () => Error
  returns the error to throw if the value is invalid
Returns T
the value

Throws
U if the value is invalid
- Defined in internal/util/ValidationTarget.mts:140

toString

toString(): string
Returns string
- Defined in internal/util/ValidationTarget.mts:190

undefinedOrNullToInvalid

undefinedOrNullToInvalid(): ValidationTarget<NonUndefinable<NonNullable<T>>>
Converts an undefined or null value to an invalid value. If the value is invalid or non-null, no action is taken.

Returns ValidationTarget<NonUndefinable<NonNullable<T>>>
an invalid value if the original value was undefined or null; otherwise, returns this with T excluding undefined and null
- Defined in internal/util/ValidationTarget.mts:125

validationFailed

validationFailed(
condition: (value: NonUndefinable<NonNullable<T>>) => boolean,
): boolean
Evaluates a condition on the value.
Parameters
- condition: (value: NonUndefinable<NonNullable<T>>) => boolean
  the condition to evaluate
Returns boolean
true if the value is invalid, undefined, null or if the condition returns false; otherwise, returns false
- Defined in internal/util/ValidationTarget.mts:185

`Static`invalid

invalid<T>(): ValidationTarget<T>
Returns an invalid value.
Type Parameters
- T
  the type of the value
Returns ValidationTarget<T>
an invalid value
- Defined in internal/util/ValidationTarget.mts:42

`Static`valid

valid<T>(value: T): ValidationTarget<T>
Returns a valid value.
Type Parameters
- T
  the type of the value
Parameters
- value: T
  a value
Returns ValidationTarget<T>
a valid value
- Defined in internal/util/ValidationTarget.mts:54

Class ValidationTarget<T>

Type Parameters

Index

Constructors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns ValidationTarget<T>

Methods

ifValid

Parameters

Returns void

isNull

Returns boolean

isUndefined

Returns boolean

isValid

Returns boolean

map

Type Parameters

Parameters

Returns ValidationTarget<U>

or

Parameters

Returns T

Parameters

Returns null | T

orGet

Parameters

Returns T

orThrow

Parameters

Returns T

Throws

toString

Returns string

undefinedOrNullToInvalid

Returns ValidationTarget<NonUndefinable<NonNullable<T>>>

validationFailed

Parameters

Returns boolean

Staticinvalid

Type Parameters

Returns ValidationTarget<T>

Staticvalid

Type Parameters

Parameters

Returns ValidationTarget<T>

Settings

On This Page

`Static`invalid

`Static`valid