Class JavascriptValidators`Abstract`

Creates validators for the Javascript API with an independent configuration.

A factory that creates different types of validators.

There are three kinds of validators:

`requireThat` for method preconditions.
`assertThat` for class invariants, and method postconditions.
`checkIf` for returning multiple validation failures.

Implements

Implemented by

JavascriptValidatorsImpl

Constructors

constructor

new JavascriptValidators(): JavascriptValidators
Returns JavascriptValidators

Methods

`Abstract`assertThat

assertThat<T>(value: T, name?: string): UnknownValidator<T>
Validates the state of an unknown value or a value that does not have a specialized validator.

The returned validator throws an error immediately if a validation fails. This error is then converted into an AssertionError. Errors unrelated to validation failures are not converted.
Type Parameters
- T
  the type of the value
Parameters
- value: T
  the value
- Optionalname: string
  the name of the value
Returns UnknownValidator<T>
a validator for the value

Throws
TypeError if name is undefined or null

Throws
RangeError if name contains whitespace or is empty
Implementation of JavascriptAssertThat.assertThat
- Defined in JavascriptValidators.mts:106

`Abstract`assertThatArray

assertThatArray<T extends undefined | null | E[], E>(
value: T,
name?: string,
): ArrayValidator<T, E>
Validates the state of an array.

The returned validator throws an error immediately if a validation fails. This error is then converted into an AssertionError. Errors unrelated to validation failures are not converted.
Type Parameters
- T extends undefined | null | E[]
  the type of the value
- E
  the type of elements in the collection
Parameters
- value: T
  the value
- Optionalname: string
  the name of the value
Returns ArrayValidator<T, E>
a validator for the value

Throws
TypeError if name is undefined or null

Throws
RangeError if name contains whitespace or is empty
Implementation of JavascriptAssertThat.assertThatArray
- Defined in JavascriptValidators.mts:94

`Abstract`assertThatBoolean

assertThatBoolean<T extends undefined | null | boolean>(
value: T,
name?: string,
): BooleanValidator<T>
Validates the state of a boolean.

The returned validator throws an error immediately if a validation fails. This error is then converted into an AssertionError. Errors unrelated to validation failures are not converted.
Type Parameters
- T extends undefined | null | boolean
  the type of the value
Parameters
- value: T
  the value
- Optionalname: string
  the name of the value
Returns BooleanValidator<T>
a validator for the value

Throws
TypeError if name is undefined or null

Throws
RangeError if name contains whitespace or is empty
Implementation of JavascriptAssertThat.assertThatBoolean
- Defined in JavascriptValidators.mts:91

`Abstract`assertThatMap

assertThatMap<T extends undefined | null | Map<K, V>, K, V>(
value: T,
name?: string,
): MapValidator<T, K, V>
Validates the state of a Map.

The returned validator throws an error immediately if a validation fails. This error is then converted into an AssertionError. Errors unrelated to validation failures are not converted.
Type Parameters
- T extends undefined | null | Map<K, V>
  the type of the value
- K
  the type of keys in the map
- V
  the type of values in the map
Parameters
- value: T
  the value
- Optionalname: string
  the name of the value
Returns MapValidator<T, K, V>
a validator for the value

Throws
TypeError if name is undefined or null

Throws
RangeError if name contains whitespace or is empty
Implementation of JavascriptAssertThat.assertThatMap
- Defined in JavascriptValidators.mts:100

`Abstract`assertThatNumber

assertThatNumber<T extends undefined | null | number>(
value: T,
name?: string,
): NumberValidator<T>
Validates the state of a number.

The returned validator throws an error immediately if a validation fails. This error is then converted into an AssertionError. Errors unrelated to validation failures are not converted.
Type Parameters
- T extends undefined | null | number
  the type of the value
Parameters
- value: T
  the value
- Optionalname: string
  the name of the value
Returns NumberValidator<T>
a validator for the value

Throws
TypeError if name is undefined or null

Throws
RangeError if name contains whitespace or is empty
Implementation of JavascriptAssertThat.assertThatNumber
- Defined in JavascriptValidators.mts:88

`Abstract`assertThatSet

assertThatSet<T extends undefined | null | Set<E>, E>(
value: T,
name?: string,
): SetValidator<T, E>
Validates the state of a Set.

The returned validator throws an error immediately if a validation fails. This error is then converted into an AssertionError. Errors unrelated to validation failures are not converted.
Type Parameters
- T extends undefined | null | Set<E>
  the type of the value
- E
  the type of elements in the set
Parameters
- value: T
  the value
- Optionalname: string
  the name of the value
Returns SetValidator<T, E>
a validator for the value

Throws
TypeError if name is undefined or null

Throws
RangeError if name contains whitespace or is empty
Implementation of JavascriptAssertThat.assertThatSet
- Defined in JavascriptValidators.mts:97

`Abstract`assertThatString

assertThatString<T extends undefined | null | string>(
value: T,
name?: string,
): StringValidator<T>
Validates the state of a string.

The returned validator throws an error immediately if a validation fails. This error is then converted into an AssertionError. Errors unrelated to validation failures are not converted.
Type Parameters
- T extends undefined | null | string
  the type of the value
Parameters
- value: T
  the value
- Optionalname: string
  the name of the value
Returns StringValidator<T>
a validator for the value

Throws
TypeError if name is undefined or null

Throws
RangeError if name contains whitespace or is empty
Implementation of JavascriptAssertThat.assertThatString
- Defined in JavascriptValidators.mts:103

`Abstract`checkIf

checkIf<T>(value: T, name?: string): UnknownValidator<T>
Validates the state of an unknown value or a value that does not have a specialized validator.

The returned validator captures errors on validation failure rather than throwing them immediately. These errors can be retrieved or thrown once the validation completes. Errors unrelated to validation failures are thrown immediately.
Type Parameters
- T
  the type of the value
Parameters
- value: T
  the value
- Optionalname: string
  the name of the value
Returns UnknownValidator<T>
a validator for the value

Throws
TypeError if name is undefined or null

Throws
RangeError if name contains whitespace or is empty
Implementation of JavascriptCheckIf.checkIf
- Defined in JavascriptValidators.mts:126

`Abstract`checkIfArray

checkIfArray<T extends undefined | null | E[], E>(
value: T,
name?: string,
): ArrayValidator<T, E>
Validates the state of an array.

The returned validator captures errors on validation failure rather than throwing them immediately. These errors can be retrieved or thrown once the validation completes. Errors unrelated to validation failures are thrown immediately.
Type Parameters
- T extends undefined | null | E[]
  the type of the value
- E
  the type of elements in the collection
Parameters
- value: T
  the value
- Optionalname: string
  the name of the value
Returns ArrayValidator<T, E>
a validator for the value

Throws
TypeError if name is undefined or null

Throws
RangeError if name contains whitespace or is empty
Implementation of JavascriptCheckIf.checkIfArray
- Defined in JavascriptValidators.mts:114

`Abstract`checkIfBoolean

checkIfBoolean<T extends undefined | null | boolean>(
value: T,
name?: string,
): BooleanValidator<T>
Validates the state of a boolean.

The returned validator captures errors on validation failure rather than throwing them immediately. These errors can be retrieved or thrown once the validation completes. Errors unrelated to validation failures are thrown immediately.
Type Parameters
- T extends undefined | null | boolean
  the type of the value
Parameters
- value: T
  the value
- Optionalname: string
  the name of the value
Returns BooleanValidator<T>
a validator for the value

Throws
TypeError if name is undefined or null

Throws
RangeError if name contains whitespace or is empty
Implementation of JavascriptCheckIf.checkIfBoolean
- Defined in JavascriptValidators.mts:111

`Abstract`checkIfMap

checkIfMap<T extends undefined | null | Map<K, V>, K, V>(
value: T,
name?: string,
): MapValidator<T, K, V>
Validates the state of a Map.

The returned validator captures errors on validation failure rather than throwing them immediately. These errors can be retrieved or thrown once the validation completes. Errors unrelated to validation failures are thrown immediately.
Type Parameters
- T extends undefined | null | Map<K, V>
  the type of the value
- K
  the type of keys in the map
- V
  the type of values in the map
Parameters
- value: T
  the value
- Optionalname: string
  the name of the value
Returns MapValidator<T, K, V>
a validator for the value

Throws
TypeError if name is undefined or null

Throws
RangeError if name contains whitespace or is empty
Implementation of JavascriptCheckIf.checkIfMap
- Defined in JavascriptValidators.mts:120

`Abstract`checkIfNumber

checkIfNumber<T extends undefined | null | number>(
value: T,
name?: string,
): NumberValidator<T>
Validates the state of a number.

The returned validator captures errors on validation failure rather than throwing them immediately. These errors can be retrieved or thrown once the validation completes. Errors unrelated to validation failures are thrown immediately.
Type Parameters
- T extends undefined | null | number
  the type of the value
Parameters
- value: T
  the value
- Optionalname: string
  the name of the value
Returns NumberValidator<T>
a validator for the value

Throws
TypeError if name is undefined or null

Throws
RangeError if name contains whitespace or is empty
Implementation of JavascriptCheckIf.checkIfNumber
- Defined in JavascriptValidators.mts:108

`Abstract`checkIfSet

checkIfSet<T extends undefined | null | Set<E>, E>(
value: T,
name?: string,
): SetValidator<T, E>
Validates the state of a Set.

The returned validator captures errors on validation failure rather than throwing them immediately. These errors can be retrieved or thrown once the validation completes. Errors unrelated to validation failures are thrown immediately.
Type Parameters
- T extends undefined | null | Set<E>
  the type of the value
- E
  the type of elements in the set
Parameters
- value: T
  the value
- Optionalname: string
  the name of the value
Returns SetValidator<T, E>
a validator for the value

Throws
TypeError if name is undefined or null

Throws
RangeError if name contains whitespace or is empty
Implementation of JavascriptCheckIf.checkIfSet
- Defined in JavascriptValidators.mts:117

`Abstract`checkIfString

checkIfString<T extends undefined | null | string>(
value: T,
name?: string,
): StringValidator<T>
Validates the state of a string.

The returned validator captures errors on validation failure rather than throwing them immediately. These errors can be retrieved or thrown once the validation completes. Errors unrelated to validation failures are thrown immediately.
Type Parameters
- T extends undefined | null | string
  the type of the value
Parameters
- value: T
  the value
- Optionalname: string
  the name of the value
Returns StringValidator<T>
a validator for the value

Throws
TypeError if name is undefined or null

Throws
RangeError if name contains whitespace or is empty
Implementation of JavascriptCheckIf.checkIfString
- Defined in JavascriptValidators.mts:123

`Abstract`copy

copy(): JavascriptValidators
Returns a new factory instance with an independent configuration. This method is commonly used to inherit and update contextual information from the original factory before passing it into a nested operation. For example,
```
JavascriptValidators copy = validators.copy();
copy.getContext().put(json.toString(), "json");
nestedOperation(copy);
```
Returns JavascriptValidators
a copy of this factory
Implementation of Validators.copy
- Defined in JavascriptValidators.mts:58

`Abstract`getContext

getContext(): Map<string, unknown>
Returns the contextual information inherited by validators created out by this factory. The contextual information is a map of key-value pairs that can provide more details about validation failures. For example, if the message is "Password may not be empty" and the map contains the key-value pair {"username": "john.smith"}, the error message would be:
```
Password may not be empty
username: john.smith
```
Returns Map<string, unknown>
an unmodifiable map from each entry's name to its value
Implementation of Validators.getContext
- Defined in JavascriptValidators.mts:60

`Abstract`getGlobalConfiguration

getGlobalConfiguration(): GlobalConfiguration
Returns the global configuration shared by all validators.

NOTE: Updating this configuration affects existing and new validators.
Returns GlobalConfiguration
the global configuration updater
Implementation of Validators.getGlobalConfiguration
- Defined in JavascriptValidators.mts:64

`Abstract`removeContext

removeContext(name: string): this
Removes the contextual information of validators created by this factory.
Parameters
- name: string
  the parameter name
Returns this
this
Throws
TypeError if name is undefined or null
Throws
RangeError if name:
- contains whitespace
- is empty
Implementation of Validators.removeContext
- Defined in JavascriptValidators.mts:66

`Abstract`requireThat

requireThat<T>(value: T, name: string): UnknownValidator<T>
Validates the state of an unknown value or a value that does not have a specialized validator.

The returned validator throws an error immediately if a validation fails.
Type Parameters
- T
  the type of the value
Parameters
- value: T
  the value
- name: string
  the name of the value
Returns UnknownValidator<T>
a validator for the value

Throws
TypeError if name is undefined or null

Throws
RangeError if name contains whitespace or is empty
Implementation of JavascriptRequireThat.requireThat
- Defined in JavascriptValidators.mts:86

`Abstract`requireThatArray

requireThatArray<T extends undefined | null | E[], E>(
value: T,
name: string,
): ArrayValidator<T, E>
Validates the state of an array.

The returned validator throws an error immediately if a validation fails.
Type Parameters
- T extends undefined | null | E[]
  the type of the value
- E
  the type of elements in the collection
Parameters
- value: T
  the value
- name: string
  the name of the value
Returns ArrayValidator<T, E>
a validator for the value

Throws
TypeError if name is undefined or null

Throws
RangeError if name contains whitespace or is empty
Implementation of JavascriptRequireThat.requireThatArray
- Defined in JavascriptValidators.mts:74

`Abstract`requireThatBoolean

requireThatBoolean<T extends undefined | null | boolean>(
value: T,
name: string,
): BooleanValidator<T>
Validates the state of a boolean.

The returned validator throws an error immediately if a validation fails.
Type Parameters
- T extends undefined | null | boolean
  the type of the value
Parameters
- value: T
  the value
- name: string
  the name of the value
Returns BooleanValidator<T>
a validator for the value

Throws
TypeError if name is undefined or null

Throws
RangeError if name contains whitespace or is empty
Implementation of JavascriptRequireThat.requireThatBoolean
- Defined in JavascriptValidators.mts:71

`Abstract`requireThatMap

requireThatMap<T extends undefined | null | Map<K, V>, K, V>(
value: T,
name: string,
): MapValidator<T, K, V>
Validates the state of a Map.

The returned validator throws an error immediately if a validation fails.
Type Parameters
- T extends undefined | null | Map<K, V>
  the type of the value
- K
  the type of keys in the map
- V
  the type of values in the map
Parameters
- value: T
  the value
- name: string
  the name of the value
Returns MapValidator<T, K, V>
a validator for the value

Throws
TypeError if name is undefined or null

Throws
RangeError if name contains whitespace or is empty
Implementation of JavascriptRequireThat.requireThatMap
- Defined in JavascriptValidators.mts:80

`Abstract`requireThatNumber

requireThatNumber<T extends undefined | null | number>(
value: T,
name: string,
): NumberValidator<T>
Validates the state of a number.

The returned validator throws an error immediately if a validation fails.
Type Parameters
- T extends undefined | null | number
  the type of the value
Parameters
- value: T
  the value
- name: string
  the name of the value
Returns NumberValidator<T>
a validator for the value

Throws
TypeError if name is undefined or null

Throws
RangeError if name contains whitespace or is empty
Implementation of JavascriptRequireThat.requireThatNumber
- Defined in JavascriptValidators.mts:68

`Abstract`requireThatSet

requireThatSet<T extends undefined | null | Set<E>, E>(
value: T,
name: string,
): SetValidator<T, E>
Validates the state of a Set.

The returned validator throws an error immediately if a validation fails.
Type Parameters
- T extends undefined | null | Set<E>
  the type of the value
- E
  the type of elements in the set
Parameters
- value: T
  the value
- name: string
  the name of the value
Returns SetValidator<T, E>
a validator for the value

Throws
TypeError if name is undefined or null

Throws
RangeError if name contains whitespace or is empty
Implementation of JavascriptRequireThat.requireThatSet
- Defined in JavascriptValidators.mts:77

`Abstract`requireThatString

requireThatString<T extends undefined | null | string>(
value: T,
name: string,
): StringValidator<T>
Validates the state of a string.

The returned validator throws an error immediately if a validation fails.
Type Parameters
- T extends undefined | null | string
  the type of the value
Parameters
- value: T
  the value
- name: string
  the name of the value
Returns StringValidator<T>
a validator for the value

Throws
TypeError if name is undefined or null

Throws
RangeError if name contains whitespace or is empty
Implementation of JavascriptRequireThat.requireThatString
- Defined in JavascriptValidators.mts:83

`Abstract`withContext

withContext(value: unknown, name: string): this
Sets the contextual information for validators created by this factory.

This method adds contextual information to error messages. The contextual information is stored as key-value pairs in a map. Values set by this method may be overridden by ValidatorComponent.withContext.
Parameters
- value: unknown
  the value of the entry
- name: string
  the name of an entry
Returns this
this
Throws
TypeError if name is undefined or null
Throws
RangeError if:
- name is empty
- name contains whitespace
- name is already in use by the value being validated or the validator context
Implementation of Validators.withContext
- Defined in JavascriptValidators.mts:62

`Static`newInstance

newInstance(): JavascriptValidators
Creates a new instance using the default configuration.

Returns JavascriptValidators
an instance of this interface
- Defined in JavascriptValidators.mts:53

Class JavascriptValidatorsAbstract

Implements

Implemented by

Index

Constructors

Methods

Constructors

constructor

Returns JavascriptValidators

Methods

AbstractassertThat

Type Parameters

Parameters

Returns UnknownValidator<T>

Throws

Throws

AbstractassertThatArray

Type Parameters

Parameters

Returns ArrayValidator<T, E>

Throws

Throws

AbstractassertThatBoolean

Type Parameters

Parameters

Returns BooleanValidator<T>

Throws

Throws

AbstractassertThatMap

Type Parameters

Parameters

Returns MapValidator<T, K, V>

Throws

Throws

AbstractassertThatNumber

Type Parameters

Parameters

Returns NumberValidator<T>

Throws

Throws

AbstractassertThatSet

Type Parameters

Parameters

Returns SetValidator<T, E>

Throws

Throws

AbstractassertThatString

Type Parameters

Parameters

Returns StringValidator<T>

Throws

Throws

AbstractcheckIf

Type Parameters

Parameters

Returns UnknownValidator<T>

Throws

Throws

AbstractcheckIfArray

Type Parameters

Parameters

Returns ArrayValidator<T, E>

Throws

Throws

AbstractcheckIfBoolean

Type Parameters

Parameters

Returns BooleanValidator<T>

Throws

Throws

AbstractcheckIfMap

Type Parameters

Parameters

Returns MapValidator<T, K, V>

Throws

Throws

AbstractcheckIfNumber

Type Parameters

Parameters

Returns NumberValidator<T>

Class JavascriptValidators`Abstract`

`Abstract`assertThat

`Abstract`assertThatArray

`Abstract`assertThatBoolean

`Abstract`assertThatMap

`Abstract`assertThatNumber

`Abstract`assertThatSet

`Abstract`assertThatString

`Abstract`checkIf

`Abstract`checkIfArray

`Abstract`checkIfBoolean

`Abstract`checkIfMap

`Abstract`checkIfNumber

`Abstract`checkIfSet

`Abstract`checkIfString

`Abstract`copy

`Abstract`getContext

`Abstract`getGlobalConfiguration

`Abstract`removeContext

`Abstract`requireThat

`Abstract`requireThatArray

`Abstract`requireThatBoolean

`Abstract`requireThatMap

`Abstract`requireThatNumber

`Abstract`requireThatSet

`Abstract`requireThatString

`Abstract`withContext