Class JavascriptValidatorsImpl

The default implementation of JavascriptValidators.

Hierarchy (View Summary)

AbstractValidators<JavascriptValidators>
- JavascriptValidatorsImpl

Implements

JavascriptValidators

Constructors

constructor

new JavascriptValidatorsImpl(
scope: ApplicationScope,
configuration: Configuration,
): JavascriptValidatorsImpl
Creates a new instance of this validator with an independent configuration.
Parameters
- scope: ApplicationScope
  the application configuration
- configuration: Configuration
  the configuration to use for new validators
Returns JavascriptValidatorsImpl
Throws
TypeError if any of the arguments are undefined or null
Overrides AbstractValidators.constructor
- Defined in internal/validator/JavascriptValidatorsImpl.mts:60
new JavascriptValidatorsImpl(
scope: ApplicationScope,
other: JavascriptValidatorsImpl,
): JavascriptValidatorsImpl
Creates a new instance of this validator with an independent configuration.
Parameters
- scope: ApplicationScope
  the application configuration
- other: JavascriptValidatorsImpl
  the factory to copy
Returns JavascriptValidatorsImpl
Throws
TypeError if any of the arguments are undefined or null
Overrides AbstractValidators<JavascriptValidators>.constructor
- Defined in internal/validator/JavascriptValidatorsImpl.mts:70

Properties

`Protected` `Readonly`context

context: Map<string, unknown> = ...

`Protected` `Readonly`scope

scope: ApplicationScope

`Static` `Readonly`INTERNAL

INTERNAL: JavascriptValidatorsImpl = ...

A validator factory that creates validators to check the arguments of validation methods.

Methods

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 captures exceptions on validation failure rather than throwing them immediately. The exceptions are converted into an AssertionError and can be retrieved or thrown once the validation completes. Exceptions unrelated to validation failures are thrown immediately.
Type Parameters
- T
  the type the value
Parameters
- value: T
  the value
- Optionalname: string
  the name of the value
Returns UnknownValidator<T>
validator for the value

Throws
TypeError if name is undefined or null

Throws
RangeError if name is empty
Implementation of JavascriptValidators.assertThat
- Defined in internal/validator/JavascriptValidatorsImpl.mts:366

assertThatArray

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

The returned validator captures exceptions on validation failure rather than throwing them immediately. The exceptions are converted into an AssertionError and can be retrieved or thrown once the validation completes. Exceptions unrelated to validation failures are thrown immediately.
Type Parameters
- T extends undefined | null | E[]
  the type the value
- E
  the type elements in the array
Parameters
- value: T
  the value
- Optionalname: string
  the name of the value
Returns ArrayValidator<T, E>
validator for the value

Throws
TypeError if name is undefined or null

Throws
RangeError if name is empty
Implementation of JavascriptValidators.assertThatArray
- Defined in internal/validator/JavascriptValidatorsImpl.mts:283

assertThatBoolean

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

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

Throws
TypeError if name is undefined or null

Throws
RangeError if name is empty
Implementation of JavascriptValidators.assertThatBoolean
- Defined in internal/validator/JavascriptValidatorsImpl.mts:262

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 captures exceptions on validation failure rather than throwing them immediately. The exceptions are converted into an AssertionError and can be retrieved or thrown once the validation completes. Exceptions unrelated to validation failures are thrown immediately.
Type Parameters
- T extends undefined | null | Map<K, V>
  the type 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>
validator for the value

Throws
TypeError if name is undefined or null

Throws
RangeError if name is empty
Implementation of JavascriptValidators.assertThatMap
- Defined in internal/validator/JavascriptValidatorsImpl.mts:326

assertThatNumber

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

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

Throws
TypeError if name is undefined or null

Throws
RangeError if name is empty
Implementation of JavascriptValidators.assertThatNumber
- Defined in internal/validator/JavascriptValidatorsImpl.mts:242

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 captures exceptions on validation failure rather than throwing them immediately. The exceptions are converted into an AssertionError and can be retrieved or thrown once the validation completes. Exceptions unrelated to validation failures are thrown immediately.
Type Parameters
- T extends undefined | null | Set<E>
  the type the value
- E
  the type elements in the set
Parameters
- value: T
  the value
- Optionalname: string
  the name of the value
Returns SetValidator<T, E>
validator for the value

Throws
TypeError if name is undefined or null

Throws
RangeError if name is empty
Implementation of JavascriptValidators.assertThatSet
- Defined in internal/validator/JavascriptValidatorsImpl.mts:304

assertThatString

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

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

Throws
TypeError if name is undefined or null

Throws
RangeError if name is empty
Implementation of JavascriptValidators.assertThatString
- Defined in internal/validator/JavascriptValidatorsImpl.mts:346

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 throws an error immediately if a validation fails.
Type Parameters
- T
  the type the value
Parameters
- value: T
  the value
- Optionalname: string
  the name of the value
Returns UnknownValidator<T>
validator for the value

Throws
TypeError if name is undefined or null

Throws
RangeError if name is empty
Implementation of JavascriptValidators.checkIf
- Defined in internal/validator/JavascriptValidatorsImpl.mts:498

checkIfArray

checkIfArray<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 the value
- E
  the type elements in the array
Parameters
- value: T
  the value
- Optionalname: string
  the name of the value
Returns ArrayValidator<T, E>
validator for the value

Throws
TypeError if name is undefined or null

Throws
RangeError if name is empty
Implementation of JavascriptValidators.checkIfArray
- Defined in internal/validator/JavascriptValidatorsImpl.mts:420

checkIfBoolean

checkIfBoolean<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 the value
Parameters
- value: T
  the value
- Optionalname: string
  the name of the value
Returns BooleanValidator<T>
validator for the value

Throws
TypeError if name is undefined or null

Throws
RangeError if name is empty
Implementation of JavascriptValidators.checkIfBoolean
- Defined in internal/validator/JavascriptValidatorsImpl.mts:401

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 throws an error immediately if a validation fails.
Type Parameters
- T extends undefined | null | Map<K, V>
  the type 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>
validator for the value

Throws
TypeError if name is undefined or null

Throws
RangeError if name is empty
Implementation of JavascriptValidators.checkIfMap
- Defined in internal/validator/JavascriptValidatorsImpl.mts:459

checkIfNumber

checkIfNumber<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 the value
Parameters
- value: T
  the value
- Optionalname: string
  the name of the value
Returns NumberValidator<T>
validator for the value

Throws
TypeError if name is undefined or null

Throws
RangeError if name is empty
Implementation of JavascriptValidators.checkIfNumber
- Defined in internal/validator/JavascriptValidatorsImpl.mts:383

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

Throws
TypeError if name is undefined or null

Throws
RangeError if name is empty
Implementation of JavascriptValidators.checkIfSet
- Defined in internal/validator/JavascriptValidatorsImpl.mts:439

checkIfString

checkIfString<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 the value
Parameters
- value: T
  the value
- Optionalname: string
  the name of the value
Returns StringValidator<T>
validator for the value

Throws
TypeError if name is undefined or null

Throws
RangeError if name is empty
Implementation of JavascriptValidators.checkIfString
- Defined in internal/validator/JavascriptValidatorsImpl.mts:477

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 JavascriptValidators.copy
Overrides AbstractValidators.copy
- Defined in internal/validator/JavascriptValidatorsImpl.mts:623

`Protected`getAssertThatConfiguration

getAssertThatConfiguration(): Configuration
Returns the configuration for assertThat factory methods.

Returns Configuration
the configuration for assertThat factory methods
Inherited from AbstractValidators.getAssertThatConfiguration
- Defined in internal/validator/AbstractValidators.mts:184

`Protected`getCheckIfConfiguration

getCheckIfConfiguration(): Configuration
Returns the configuration for checkIf factory methods.

Returns Configuration
the configuration for checkIf factory methods
Inherited from AbstractValidators.getCheckIfConfiguration
- Defined in internal/validator/AbstractValidators.mts:194

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 JavascriptValidators.getContext
Inherited from AbstractValidators.getContext
- Defined in internal/validator/AbstractValidators.mts:229

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 JavascriptValidators.getGlobalConfiguration
Inherited from AbstractValidators.getGlobalConfiguration
- Defined in internal/validator/AbstractValidators.mts:234

getRequireThatConfiguration

getRequireThatConfiguration(): Configuration
Returns Configuration
Inherited from AbstractValidators.getRequireThatConfiguration
- Defined in internal/validator/AbstractValidators.mts:174

getScope

getScope(): ApplicationScope
Returns ApplicationScope
the application configuration
Inherited from AbstractValidators.getScope
- Defined in internal/validator/AbstractValidators.mts:169

removeContext

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

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 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 is empty
Implementation of JavascriptValidators.requireThat
- Defined in internal/validator/JavascriptValidatorsImpl.mts:222

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 the value
- E
  the type elements in the array
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 is empty
Implementation of JavascriptValidators.requireThatArray
- Defined in internal/validator/JavascriptValidatorsImpl.mts:143

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 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 is empty
Implementation of JavascriptValidators.requireThatBoolean
- Defined in internal/validator/JavascriptValidatorsImpl.mts:123

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 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 is empty
Implementation of JavascriptValidators.requireThatMap
- Defined in internal/validator/JavascriptValidatorsImpl.mts:184

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 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 is empty
Implementation of JavascriptValidators.requireThatNumber
- Defined in internal/validator/JavascriptValidatorsImpl.mts:104

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 the value
- E
  the type 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 is empty
Implementation of JavascriptValidators.requireThatSet
- Defined in internal/validator/JavascriptValidatorsImpl.mts:163

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 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 is empty
Implementation of JavascriptValidators.requireThatString
- Defined in internal/validator/JavascriptValidatorsImpl.mts:203

setConfiguration

setConfiguration(configuration: Configuration): void
Set the configuration used by new validators.
Parameters
- configuration: Configuration
  the updated configuration
Returns void
Throws
TypeError if configuration is null
Inherited from AbstractValidators.setConfiguration
- Defined in internal/validator/AbstractValidators.mts:218

updateConfiguration

updateConfiguration(): ConfigurationUpdater
Returns ConfigurationUpdater
Inherited from AbstractValidators.updateConfiguration
- Defined in internal/validator/AbstractValidators.mts:199
updateConfiguration(
updater: (configuration: ConfigurationUpdater) => void,
): this
Parameters
- updater: (configuration: ConfigurationUpdater) => void
Returns this
Inherited from AbstractValidators.updateConfiguration
- Defined in internal/validator/AbstractValidators.mts:200

withContext

withContext(value: unknown, name: string): JavascriptValidatorsImpl
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 JavascriptValidatorsImpl
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 JavascriptValidators.withContext
Overrides AbstractValidators.withContext
- Defined in internal/validator/JavascriptValidatorsImpl.mts:628

Class JavascriptValidatorsImpl

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns JavascriptValidatorsImpl

Throws

Parameters

Returns JavascriptValidatorsImpl

Throws

Properties

Protected Readonlycontext

Protected Readonlyscope

Static ReadonlyINTERNAL

Methods

assertThat

Type Parameters

Parameters

Returns UnknownValidator<T>

Throws

Throws

assertThatArray

Type Parameters

Parameters

Returns ArrayValidator<T, E>

Throws

Throws

assertThatBoolean

Type Parameters

Parameters

Returns BooleanValidator<T>

Throws

Throws

assertThatMap

Type Parameters

Parameters

Returns MapValidator<T, K, V>

Throws

Throws

assertThatNumber

Type Parameters

Parameters

Returns NumberValidator<T>

Throws

Throws

assertThatSet

Type Parameters

Parameters

Returns SetValidator<T, E>

Throws

Throws

assertThatString

Type Parameters

Parameters

Returns StringValidator<T>

Throws

Throws

checkIf

Type Parameters

Parameters

Returns UnknownValidator<T>

Throws

Throws

checkIfArray

Type Parameters

Parameters

Returns ArrayValidator<T, E>

Throws

Throws

checkIfBoolean

Type Parameters

Parameters

Returns BooleanValidator<T>

Throws

Throws

`Protected` `Readonly`context

`Protected` `Readonly`scope

`Static` `Readonly`INTERNAL

`Protected`getAssertThatConfiguration

`Protected`getCheckIfConfiguration