Class AbstractValidator<T>Abstract
Type Parameters
Implements
Index
Constructors
Properties
Methods
Constructors
Protectedconstructor
- new
Abstract Validator<T>(scope, configuration, name, value, context, failures): AbstractValidator<T> Type Parameters
Parameters
- scope: ApplicationScope
the application configuration
+ - configuration: Configuration
the validator configuration
+ - name: string
the name of the value
+ - value: ValidationTarget<T>
the value being validated
+ - context: Map<string, unknown>
the contextual information set by a parent validator or the user
+ - failures: ValidationFailure[]
the list of validation failures
+
Returns AbstractValidator<T>
- scope: ApplicationScope
Properties
Protected Readonly_configuration
The validator configuration.
+Protected Readonlycontext
The contextual information of this validator.
+Protected Readonlyfailures
The list of validation failures.
+Protected Readonlyname
The name of the value.
+Protected Readonlyscope
The application configuration.
+Readonlyvalue
The value being validated.
+ Methods
add
- add
Failure(message, errorBuilder): void Adds a validation failure and throws an error if the validator is configured to throw an error on +failure.
+Parameters
- message: string
a message that explains what went wrong
+ - errorBuilder: ErrorBuilder
creates the error associated with this failure
+
Returns void
- message: string
Protectedadd
add
and
- and(validation): this
Facilitates the validation of related properties. For example,
++```ts +requireThat(nameToFrequency, "nameToFrequency"). + and(m => m.size().isPositive()). + and(m => m.keySet().contains("John")); +``` +
+Any changes made during the validation process will impact this validator.
Parameters
- validation: ((validator: this) => void)
the nested validation
+- (validator): void
Parameters
- validator: this
Returns void
Returns this
this
+- validation: ((validator: this) => void)
configuration
- configuration(): Configuration
Returns Configuration
else
else
- else
Get Failures(): ValidationFailures Returns the array of failed validations.
+Returns ValidationFailures
an array of failed validations
+
else
Protectedfail
get
- get
Context(): Map<string, unknown> Returns the contextual information for upcoming validations carried out by this validator. 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
+
get
get
get
- get
Name Or Value(namePrefix, name, valuePrefix, value): string Parameters
- namePrefix: string
the string to prepend to the name if the name is null
+ - name: null | string
the name of the value
+ - valuePrefix: string
the string to prepend to the value if the name is null
+ - value: unknown
a value
+
Returns string
the prefixed name if it is defined; otherwise, the prefixed string representation of the value
+- namePrefix: string
get
- get
Scope(): ApplicationScope Returns ApplicationScope
the application configuration
+
get
get
- get
Value Or Default(defaultValue): T Returns the value that is being validated.
+Parameters
- defaultValue: T
the fallback value to use if the value is invalid
+
Returns T
the validated value, or
+defaultValueif the value is invalid (e.g. due to dereferencing a +property of anullobject)- defaultValue: T
- get
Value Or Default(defaultValue): null | T Returns the value that is being validated.
+Parameters
- defaultValue: null | T
the fallback value to use if the value is invalid
+
Returns null | T
the validated value, or
+defaultValueif the value is invalid (e.g. due to dereferencing a +property of anullobject)- defaultValue: null | T
is
is
- is
Instance Of<U>(expected): UnknownValidator<U> Ensures that the object is an instance of a class.
+Type Parameters
Parameters
- expected: ClassConstructor<U>
the desired class
+
Returns UnknownValidator<U>
a validator for an object of the desired class
+- expected: ClassConstructor<U>
is
is
- is
Not Instance Of<U>(expected): this Ensures that the object is not an instance of a class.
+Type Parameters
Parameters
- expected: ClassConstructor<U>
Returns this
this
+
is
- is
Not Null(): UnknownValidator<NonNullable<T>> Ensures that the value is not
+null.+This method should be used to validate method arguments that are assigned to class fields but not +accessed right away (such as constructor and setter arguments). It should also be used to validate any +method arguments when the validator contains +additional contextual information.
Returns UnknownValidator<NonNullable<T>>
this
+
is
- is
Not Undefined(): UnknownValidator<Exclude<T, undefined>> Ensures that the value is not undefined.
++This method should be used to validate method arguments that are assigned to class fields but not +accessed right away (such as constructor and setter arguments). It should also be used to validate any +method arguments when the validator contains +additional contextual information.
Returns UnknownValidator<Exclude<T, undefined>>
this
+
is
- is
Null(): UnknownValidator<null> Ensures that the value is
+null.Returns UnknownValidator<null>
this
+
is
- is
Type(expected): this Ensures that the value has the specified type.
+Parameters
- expected: Type
the expected type of the value
+
Returns this
this
+- expected: Type
is
- is
Undefined(): UnknownValidator<undefined> Ensures that the value is undefined.
+Returns UnknownValidator<undefined>
this
+
Protectedrequire
- require
That Name Is Unique(name, checkContext?): JavascriptValidatorsImpl Ensures that a name does not conflict with other variable names already in use by the validator.
+Parameters
- name: string
the name of the parameter
+ - checkContext: boolean = true
+falseto allow the name to be used even if it conflicts with an +existing name in the validator context
Returns JavascriptValidatorsImpl
the internal validator of the name
+- name: string
validation
with
- with
Context(value, name): this Sets the contextual information for upcoming validations.
++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 override any values that are set using +Validators.withContext. +
+There is no way to remove contextual information from a validator. Thread-level contextual information is +removed automatically.
Parameters
- value: unknown
the value of the entry
+ - name: string
the name of an entry
+
Returns this
this
+- value: unknown
Protected Static ReadonlyVALUE_
- VALUE_
IS_ UNDEFINED(): IllegalStateError Returns IllegalStateError
Class AbstractValidators<S>Abstract
Type Parameters
Hierarchy (view full)
- AbstractValidators
Implements
Index
Constructors
Properties
Methods
Constructors
Protectedconstructor
- new
Abstract Validators<S>(scope, configuration): AbstractValidators<S> Creates a new instance.
+Type Parameters
Parameters
- scope: ApplicationScope
the application configuration
+ - configuration: Configuration
the configuration to use for new validators
+
Returns AbstractValidators<S>
- scope: ApplicationScope
Methods
Abstractcopy
- copy(): S
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 S
a copy of this factory
+
Protectedget
- get
Assert That Configuration(): Configuration Returns the configuration for
+assertThatfactory methods.Returns Configuration
the configuration for
+assertThatfactory methods
Protectedget
- get
Check If Configuration(): Configuration Returns the configuration for
+checkIffactory methods.Returns Configuration
the configuration for
+checkIffactory methods
get
- get
Context(): 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
+
get
- get
Global Configuration(): GlobalConfiguration Returns the global configuration shared by all validators.
++NOTE: Updating this configuration affects existing and new validators.
Returns GlobalConfiguration
the global configuration updater
+
get
- get
Require That Configuration(): Configuration Returns Configuration
get
- get
Scope(): ApplicationScope Returns ApplicationScope
the application configuration
+
Abstractremove
set
- set
Configuration(configuration): void Set the configuration used by new validators.
+Parameters
- configuration: Configuration
the updated configuration
+
Returns void
- configuration: Configuration
update
- update
Configuration(): ConfigurationUpdater Returns ConfigurationUpdater
- update
Configuration(updater): this Parameters
- updater: ((configuration: ConfigurationUpdater) => void)
- (configuration): void
Parameters
- configuration: ConfigurationUpdater
Returns void
Returns this
- updater: ((configuration: ConfigurationUpdater) => void)
Abstractwith
- with
Context(value, name): 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
+- value: unknown
Class IllegalStateError
Thrown when a method is invoked at an illegal or inappropriate time.
+Hierarchy
- Error
- IllegalStateError
Index
Constructors
Constructors
constructor
- new
Illegal State Error(message): IllegalStateError Creates a new error.
+Parameters
- message: string
an explanation of what went wrong
+
Returns IllegalStateError
- message: string
Class JavascriptValidatorsImpl
The default implementation of JavascriptValidators.
+Hierarchy (view full)
- AbstractValidators<JavascriptValidators>
- JavascriptValidatorsImpl
Implements
Index
Constructors
Properties
Methods
Constructors
constructor
- new
Javascript Validators Impl(scope, 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
- scope: ApplicationScope
- new
Javascript Validators Impl(scope, other): 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
- scope: ApplicationScope
Properties
Protected Readonlycontext
Protected Readonlyscope
Static ReadonlyINTERNAL
A validator factory that creates validators to check the arguments of validation methods.
+ Methods
assert
- assert
That<T>(value, name?): 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
Parameters
- value: T
the value
+ Optionalname: stringthe name of the value
+
Returns UnknownValidator<T>
validator for the value
+- value: T
assert
- assert
That Array<T, E>(value, name?): 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: stringthe name of the value
+
Returns ArrayValidator<T, E>
validator for the value
+- T extends undefined | null | E[]
assert
- assert
That Boolean<T>(value, name?): 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
Parameters
- value: T
the value
+ Optionalname: stringthe name of the value
+
Returns BooleanValidator<T>
validator for the value
+- value: T
assert
- assert
That Map<T, K, V>(value, name?): 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
Parameters
- value: T
the value
+ Optionalname: stringthe name of the value
+
Returns MapValidator<T, K, V>
validator for the value
+- value: T
assert
- assert
That Number<T>(value, name?): 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
Parameters
- value: T
the value
+ Optionalname: stringthe name of the value
+
Returns NumberValidator<T>
validator for the value
+- value: T
assert
- assert
That Set<T, E>(value, name?): 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
Parameters
- value: T
the value
+ Optionalname: stringthe name of the value
+
Returns SetValidator<T, E>
validator for the value
+- value: T
assert
- assert
That String<T>(value, name?): 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
Parameters
- value: T
the value
+ Optionalname: stringthe name of the value
+
Returns StringValidator<T>
validator for the value
+- value: T
check
- check
If<T>(value, name?): 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
Parameters
- value: T
the value
+ Optionalname: stringthe name of the value
+
Returns UnknownValidator<T>
validator for the value
+- value: T
check
- check
If Array<T, E>(value, name?): 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: stringthe name of the value
+
Returns ArrayValidator<T, E>
validator for the value
+- T extends undefined | null | E[]
check
- check
If Boolean<T>(value, name?): BooleanValidator<T> Validates the state of a boolean.
++The returned validator throws an error immediately if a validation fails.
Type Parameters
Parameters
- value: T
the value
+ Optionalname: stringthe name of the value
+
Returns BooleanValidator<T>
validator for the value
+- value: T
check
- check
If Map<T, K, V>(value, name?): MapValidator<T, K, V> Validates the state of a map.
++The returned validator throws an error immediately if a validation fails.
Type Parameters
Parameters
- value: T
the value
+ Optionalname: stringthe name of the value
+
Returns MapValidator<T, K, V>
validator for the value
+- value: T
check
- check
If Number<T>(value, name?): NumberValidator<T> Validates the state of a number.
++The returned validator throws an error immediately if a validation fails.
Type Parameters
Parameters
- value: T
the value
+ Optionalname: stringthe name of the value
+
Returns NumberValidator<T>
validator for the value
+- value: T
check
- check
If Set<T, E>(value, name?): SetValidator<T, E> Validates the state of a set.
++The returned validator throws an error immediately if a validation fails.
Type Parameters
Parameters
- value: T
the value
+ Optionalname: stringthe name of the value
+
Returns SetValidator<T, E>
validator for the value
+- value: T
check
- check
If String<T>(value, name?): StringValidator<T> Validates the state of a string.
++The returned validator throws an error immediately if a validation fails.
Type Parameters
Parameters
- value: T
the value
+ Optionalname: stringthe name of the value
+
Returns StringValidator<T>
validator for the value
+- value: T
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
+
Protectedget
- get
Assert That Configuration(): Configuration Returns the configuration for
+assertThatfactory methods.Returns Configuration
the configuration for
+assertThatfactory methods
Protectedget
- get
Check If Configuration(): Configuration Returns the configuration for
+checkIffactory methods.Returns Configuration
the configuration for
+checkIffactory methods
get
- get
Context(): 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
+
get
- get
Global Configuration(): GlobalConfiguration Returns the global configuration shared by all validators.
++NOTE: Updating this configuration affects existing and new validators.
Returns GlobalConfiguration
the global configuration updater
+
get
- get
Require That Configuration(): Configuration Returns Configuration
get
- get
Scope(): ApplicationScope Returns ApplicationScope
the application configuration
+
remove
- remove
Context(name): JavascriptValidatorsImpl Removes the contextual information of validators created by this factory.
+Parameters
- name: string
the parameter name
+
Returns JavascriptValidatorsImpl
this
+- name: string
require
- require
That<T>(value, name): 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
Parameters
- value: T
the value
+ - name: string
the name of the value
+
Returns UnknownValidator<T>
a verifier
+- value: T
require
- require
That Array<T, E>(value, name): 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 verifier
+- T extends undefined | null | E[]
require
- require
That Boolean<T>(value, name): BooleanValidator<T> Validates the state of a boolean.
++The returned validator throws an error immediately if a validation fails.
Type Parameters
Parameters
- value: T
the value
+ - name: string
the name of the value
+
Returns BooleanValidator<T>
a verifier
+- value: T
require
require
- require
That Number<T>(value, name): NumberValidator<T> Validates the state of a number.
++The returned validator throws an error immediately if a validation fails.
Type Parameters
Parameters
- value: T
the value
+ - name: string
the name of the value
+
Returns NumberValidator<T>
a verifier
+- value: T
require
- require
That Set<T, E>(value, name): SetValidator<T, E> Validates the state of a set.
++The returned validator throws an error immediately if a validation fails.
Type Parameters
Parameters
- value: T
the value
+ - name: string
the name of the value
+
Returns SetValidator<T, E>
a verifier
+- value: T
require
- require
That String<T>(value, name): StringValidator<T> Validates the state of a string.
++The returned validator throws an error immediately if a validation fails.
Type Parameters
Parameters
- value: T
the value
+ - name: string
the name of the value
+
Returns StringValidator<T>
a verifier
+- value: T
set
- set
Configuration(configuration): void Set the configuration used by new validators.
+Parameters
- configuration: Configuration
the updated configuration
+
Returns void
- configuration: Configuration
update
- update
Configuration(): ConfigurationUpdater Returns ConfigurationUpdater
- update
Configuration(updater): this Parameters
- updater: ((configuration: ConfigurationUpdater) => void)
- (configuration): void
Parameters
- configuration: ConfigurationUpdater
Returns void
Returns this
- updater: ((configuration: ConfigurationUpdater) => void)
with
- with
Context(value, name): 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
+- value: unknown
Class Terminal
The terminal associated with the process.
+ Index
Constructors
Methods
Methods
get
- get
Encoding(): TerminalEncoding Returns TerminalEncoding
the encoding that the terminal should use (defaults to the best available encoding)
+
get
- get
Supported Types(): Set<TerminalEncoding> Returns Set<TerminalEncoding>
the encodings supported by the terminal
+
set
- set
Encoding(encoding): void Indicates the type of encoding that the terminal should use.
++This feature can be used to force the use of colors even when their support is not detected.
Parameters
- encoding: TerminalEncoding
the type of encoding that the terminal should use
+
Returns void
- encoding: TerminalEncoding
use
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
Index
Constructors
Methods
Constructors
constructor
- new
Validation Target<T>(valid, value): ValidationTarget<T> Creates a value that may be invalid.
+Type Parameters
Parameters
- valid: boolean
+trueif the value is valid, orfalseif invalid - value: T
the value
+
Returns ValidationTarget<T>
- valid: boolean
Methods
if
is
is
is
map
- map<U>(mapper): ValidationTarget<U>
Applies a function to the value if it is valid. If the value is invalid, no action is taken.
+Type Parameters
Parameters
Returns ValidationTarget<U>
+thisif the value is invalid; otherwise, aMaybeInvalidinstance wrapping the +result of applying the mapper to the value
or
- or(defaultValue): T
Returns the valid value, or a default value if invalid. A value of
+nulldoes 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
+defaultValueif the value is invalid- defaultValue: T
- or(defaultValue): null | T
Parameters
- defaultValue: null | T
Returns null | T
or
or
to
undefined
- undefined
Or Null To Invalid(): ValidationTarget<NonUndefinable<NonNullable<T>>> Converts an
+undefinedornullvalue 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
+undefinedornull; otherwise, returnsthis+withTexcludingundefinedandnull
validation
- validation
Failed(condition): boolean Evaluates a condition on the value.
+Parameters
- condition: ((value: NonUndefinable<NonNullable<T>>) => boolean)
the condition to evaluate
+- (value): boolean
Parameters
- value: NonUndefinable<NonNullable<T>>
Returns boolean
Returns boolean
+trueif the value is invalid,undefined,nullor if theconditionreturnsfalse; +otherwise, returnsfalse- condition: ((value: NonUndefinable<NonNullable<T>>) => boolean)
Staticinvalid
- invalid<T>(): ValidationTarget<T>
Returns an invalid value.
+Type Parameters
Returns ValidationTarget<T>
an invalid value
+
Staticvalid
- valid<T>(value): ValidationTarget<T>
Returns a valid value.
+Type Parameters
Parameters
- value: T
a value
+
Returns ValidationTarget<T>
a valid value
+- value: T
Class JavascriptValidatorsAbstract
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
Index
Constructors
Methods
Constructors
constructor
- new
Javascript Validators(): JavascriptValidators Returns JavascriptValidators
Methods
Abstractassert
- assert
That<T>(value, name?): 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
Parameters
- value: T
the value
+ Optionalname: stringthe name of the value
+
Returns UnknownValidator<T>
a validator for the value
+- value: T
Abstractassert
- assert
That Array<T, E>(value, name?): 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: stringthe name of the value
+
Returns ArrayValidator<T, E>
a validator for the value
+- T extends undefined | null | E[]
Abstractassert
- assert
That Boolean<T>(value, name?): 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
Parameters
- value: T
the value
+ Optionalname: stringthe name of the value
+
Returns BooleanValidator<T>
a validator for the value
+- value: T
Abstractassert
- assert
That Map<T, K, V>(value, name?): 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
Parameters
- value: T
the value
+ Optionalname: stringthe name of the value
+
Returns MapValidator<T, K, V>
a validator for the value
+- value: T
Abstractassert
- assert
That Number<T>(value, name?): 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
Parameters
- value: T
the value
+ Optionalname: stringthe name of the value
+
Returns NumberValidator<T>
a validator for the value
+- value: T
Abstractassert
- assert
That Set<T, E>(value, name?): 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
Parameters
- value: T
the value
+ Optionalname: stringthe name of the value
+
Returns SetValidator<T, E>
a validator for the value
+- value: T
Abstractassert
- assert
That String<T>(value, name?): 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
Parameters
- value: T
the value
+ Optionalname: stringthe name of the value
+
Returns StringValidator<T>
a validator for the value
+- value: T
Abstractcheck
- check
If<T>(value, name?): 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
Parameters
- value: T
the value
+ Optionalname: stringthe name of the value
+
Returns UnknownValidator<T>
a validator for the value
+- value: T
Abstractcheck
- check
If Array<T, E>(value, name?): 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: stringthe name of the value
+
Returns ArrayValidator<T, E>
a validator for the value
+- T extends undefined | null | E[]
Abstractcheck
- check
If Boolean<T>(value, name?): 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
Parameters
- value: T
the value
+ Optionalname: stringthe name of the value
+
Returns BooleanValidator<T>
a validator for the value
+- value: T
Abstractcheck
- check
If Map<T, K, V>(value, name?): 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
Parameters
- value: T
the value
+ Optionalname: stringthe name of the value
+
Returns MapValidator<T, K, V>
a validator for the value
+- value: T
Abstractcheck
- check
If Number<T>(value, name?): 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
Parameters
- value: T
the value
+ Optionalname: stringthe name of the value
+
Returns NumberValidator<T>
a validator for the value
+- value: T
Abstractcheck
- check
If Set<T, E>(value, name?): 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
Parameters
- value: T
the value
+ Optionalname: stringthe name of the value
+
Returns SetValidator<T, E>
a validator for the value
+- value: T
Abstractcheck
- check
If String<T>(value, name?): 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
Parameters
- value: T
the value
+ Optionalname: stringthe name of the value
+
Returns StringValidator<T>
a validator for the value
+- value: T
Abstractcopy
- 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
+
Abstractget
- get
Context(): 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
+
Abstractget
- get
Global Configuration(): GlobalConfiguration Returns the global configuration shared by all validators.
++NOTE: Updating this configuration affects existing and new validators.
Returns GlobalConfiguration
the global configuration updater
+
Abstractremove
Abstractrequire
- require
That<T>(value, name): 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
Parameters
- value: T
the value
+ - name: string
the name of the value
+
Returns UnknownValidator<T>
a validator for the value
+- value: T
Abstractrequire
- require
That Array<T, E>(value, name): 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
+- T extends undefined | null | E[]
Abstractrequire
- require
That Boolean<T>(value, name): BooleanValidator<T> Validates the state of a
+boolean.+The returned validator throws an error immediately if a validation fails.
Type Parameters
Parameters
- value: T
the value
+ - name: string
the name of the value
+
Returns BooleanValidator<T>
a validator for the value
+- value: T
Abstractrequire
- require
That Map<T, K, V>(value, name): MapValidator<T, K, V> Validates the state of a
+Map.+The returned validator throws an error immediately if a validation fails.
Type Parameters
Parameters
- value: T
the value
+ - name: string
the name of the value
+
Returns MapValidator<T, K, V>
a validator for the value
+- value: T
Abstractrequire
- require
That Number<T>(value, name): NumberValidator<T> Validates the state of a
+number.+The returned validator throws an error immediately if a validation fails.
Type Parameters
Parameters
- value: T
the value
+ - name: string
the name of the value
+
Returns NumberValidator<T>
a validator for the value
+- value: T
Abstractrequire
- require
That Set<T, E>(value, name): SetValidator<T, E> Validates the state of a
+Set.+The returned validator throws an error immediately if a validation fails.
Type Parameters
Parameters
- value: T
the value
+ - name: string
the name of the value
+
Returns SetValidator<T, E>
a validator for the value
+- value: T
Abstractrequire
- require
That String<T>(value, name): StringValidator<T> Validates the state of a
+string.+The returned validator throws an error immediately if a validation fails.
Type Parameters
Parameters
- value: T
the value
+ - name: string
the name of the value
+
Returns StringValidator<T>
a validator for the value
+- value: T
Abstractwith
- with
Context(value, name): 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
+- value: unknown
Staticnew
- new
Instance(): JavascriptValidators Creates a new instance using the default configuration.
+Returns JavascriptValidators
an instance of this interface
+
Class MultipleFailuresError
Thrown if multiple validations have failed.
+Hierarchy
- Error
- MultipleFailuresError
Index
Constructors
Methods
Constructors
constructor
- new
Multiple Failures Error(failures): MultipleFailuresError Creates a new error.
+Parameters
- failures: ValidationFailure[]
the list of validation failures
+
Returns MultipleFailuresError
- failures: ValidationFailure[]
Methods
get
- get
Failures(): ValidationFailure[] Returns the list of validation failures.
+Returns ValidationFailure[]
the list of validation failures
+
Class Type
Describes the type of a value.
+ Index
Properties
Methods
Properties
Readonlycategory
Readonlyname
Optional Readonlytype
Static ReadonlyANONYMOUS_
An anonymous or arrow function.
+Static ReadonlyARRAY
Static ReadonlyBIGINT
Static ReadonlyBOOLEAN
Static ReadonlyNULL
Static ReadonlyNUMBER
Static ReadonlySTRING
Static ReadonlySYMBOL
Static ReadonlyUNDEFINED
Methods
equals
- equals(other): boolean
Indicates if this type is equal to another type.
+Parameters
- other: Type
another type
+
Returns boolean
true if this type matches
+other- other: Type
get
is
is
- is
Subtype Of(parent): boolean Indicates whether this type is a subtype of another type. Note that types are considered subtypes of +themselves.
+Parameters
- parent: Type
the parent type
+
Returns boolean
-
+
- `true` if `child` extends `parent` +
- `false` if `parent` or `child` are `undefined`, `null` or an object +
- `false` if `child` does not extend `parent` +
- parent: Type
to
Staticget
Staticnamed
- named
Class(name, typeGuard?): Type Returns the type of a named class.
+Parameters
- name: null | string
the name of the class, or
+nullto represent any class. OptionaltypeGuard: ((value: unknown) => boolean)(optional) for certain types, such as Typescript interfaces, runtime validation is +not possible. In such a case, use a type guard to check if the value satisfies the type condition.
+- (value): boolean
Parameters
- value: unknown
Returns boolean
Returns Type
the type
+- name: null | string
Staticnamed
Staticof
- of(value): Type
Returns the type of a value.
+Parameters
- value: unknown
a value
+
Returns Type
the value's type
+See
-
+
- http://stackoverflow.com/a/332429/14731 +
- Type.isPrimitive +
- value: unknown
Class ValidationFailures
A collection of validation failures.
+ Index
Constructors
constructor
- new
Validation Failures(failures): ValidationFailures Creates a new instance.
+Parameters
- failures: ValidationFailure[]
the validation failures
+
Returns ValidationFailures
- failures: ValidationFailure[]
Methods
add
- add
All(failures): ValidationFailures Adds validation failures into this collection.
+Parameters
- failures: ValidationFailures
the failures to add
+
Returns ValidationFailures
this
+- failures: ValidationFailures
get
- get
Error(): null | Error Returns the error for the validation failures, if any.
+-
+
- Returns `null` if no validation has failed. +
- Returns `MultipleFailuresError` if there were multiple failures. +
- Returns `Throwable` if there was one failure. +
Returns null | Error
the error or
+nullif no validation has failed
get
- get
Failures(): ValidationFailure[] Returns the list of failed validations.
+Returns ValidationFailure[]
an unmodifiable list of failed validations
+
get
is
throw
Class AssertionError
Thrown when assertion has failed or a condition thought to be impossible has occurred.
+Hierarchy
- Error
- AssertionError
Index
Constructors
Constructors
constructor
- new
Assertion Error(message?, options?): AssertionError Creates a new error.
+Parameters
Optionalmessage: stringan explanation of what went wrong
+Optionaloptions: {
cause: unknown;
}configuration options
+cause: unknown
Returns AssertionError
Class Configuration
Determines the behavior of a validator.
+ Index
Constructors
constructor
- new
Configuration(allowDiff?, stringMappers?, recordStacktrace?, throwOnFailure?, errorTransformer?): Configuration Creates a new configuration that:
+-
+
- Has an empty context. +
- Throws an error on failure. +
- Records the error stack trace when a validation failure occurs. +
- May include a diff that compares the actual and expected values. +
Parameters
- allowDiff: boolean = true
+trueif error messages may include a diff that compares actual and expected values - stringMappers: StringMappers = StringMappers.DEFAULT
the configuration used to map contextual values to a string
+ - recordStacktrace: boolean = true
+trueif the error stack trace must be recorded when a validation failure +occurs. Iffalse, the error type remains the same, but the stack trace points to the invocation +ofelseGetError(). Users who only plan to +list of failure messages instead of retrieving an error +may see a performance improvement if this value is set tofalse. - throwOnFailure: boolean = true
+trueif an error is thrown on validation failure - errorTransformer: ((error: Error) => Error) = ...
a function that transforms the validation error before it is thrown or +returned
+
Returns Configuration
Methods
allow
error
record
- record
Stacktrace(): boolean Returns
+trueif the error stack trace must be recorded when a validation failure occurs. Iffalse, +the error type remains the same, but the stack trace points to the invocation of +elseGetError(). Users who only plan to +list of failure messages instead of retrieving an error +may see a performance improvement if this value is set tofalse.Returns boolean
+trueif error stack traces must be recorded when a validation failure occurs
string
- string
Mappers(): StringMappers Returns the configuration used to map contextual values to a String. Supports common types such as +arrays, numbers, collections, maps, paths and errors.
+Returns StringMappers
a function that takes an object and returns the
+stringrepresentation of the object
throw
to
Class MutableStringMappers
Returns the String representation of
+ Index
Constructors
Methods
Constructors
constructor
- new
Mutable String Mappers(typeToMapper): MutableStringMappers Creates a new instance.
+Parameters
- typeToMapper: Map<Type, StringMapper>
a mapping from the name of a type to the string representation of its values
+
Returns MutableStringMappers
- typeToMapper: Map<Type, StringMapper>
Methods
put
- put(type, mapper): MutableStringMappers
Sets the function that maps a value of the given type to a string. This method is useful for customizing +the formatting of validation failure messages.
+Parameters
- type: Type
a type
+ - mapper: StringMapper
a function that returns the String representation of the type's instances
+
Returns MutableStringMappers
this
+- type: Type
remove
- remove(type): MutableStringMappers
Removes a mapper for a type.
+Parameters
- type: Type
the type
+
Returns MutableStringMappers
this
+- type: Type
to
- to
Immutable(): StringMappers Returns an immutable copy of the mapper configuration.
+Returns StringMappers
an immutable copy of the mapper configuration
+
to
Staticfrom
- from(mappers): MutableStringMappers
Returns a mutable copy of the StringMappers.
+Parameters
- mappers: StringMappers
a
+StringMappersobject
Returns MutableStringMappers
a mutable copy of the StringMappers
+- mappers: StringMappers
Class StringMappers
Returns the String representation of an object.
+ Index
Constructors
constructor
- new
String Mappers(typeToMapper?): StringMappers Creates a new instance. If
+typeToMapperisundefinedthe new instance uses the +default mappings. Otherwise, it contains a copy of thetypeToMappermappings.Parameters
OptionaltypeToMapper: Map<Type, StringMapper>a mapping from the name of a type to the string representation of its values
+
Returns StringMappers
Methods
to
- to
String(): string Returns the string representation of the mappers.
+Returns string
the string representation of the mappers
+- to
String(value): string Returns the string representation of a value using the mappers.
+Parameters
- value: unknown
a value
+
Returns string
the string representation of the value
+- value: unknown
Enumeration TerminalEncoding
The encodings supported by the terminal.
+ Index
Enumeration Members
Enumeration Members
NODE_
Node terminal supports a 16-color palette.
+NODE_
Node terminal supports a 24-bit color palette.
+NODE_
Node terminal supports a 256-color palette.
+NONE
A terminal that does not support any colors.
+Function assertThat
- assert
That<T>(value, name?): UnknownValidator<T> Validates the state of an unknown value or a value that does not have a specialized validator.
++The returned validator throws an exception immediately if a validation fails. This exception is then +converted into an AssertionError. Exceptions unrelated to validation failures are not converted.
Type Parameters
Parameters
- value: T
the value
+ Optionalname: stringthe name of the value
+
Returns UnknownValidator<T>
validator for the value
+- value: T
Function assertThatArray
- assert
That Array<T, E>(value, name?): ArrayValidator<T, E> Validates the state of an array.
++The returned validator throws an exception immediately if a validation fails. This exception is then +converted into an AssertionError. Exceptions unrelated to validation failures are not converted.
Type Parameters
- T extends undefined | null | E[]
the type the value
+ - E
the type elements in the array
+
Parameters
- value: T
the value
+ Optionalname: stringthe name of the value
+
Returns ArrayValidator<T, E>
validator for the value
+- T extends undefined | null | E[]
Function assertThatBoolean
- assert
That Boolean<T>(value, name?): BooleanValidator<T> Validates the state of a boolean.
++The returned validator throws an exception immediately if a validation fails. This exception is then +converted into an AssertionError. Exceptions unrelated to validation failures are not converted.
Type Parameters
Parameters
- value: T
the value
+ Optionalname: stringthe name of the value
+
Returns BooleanValidator<T>
validator for the value
+- value: T
Function assertThatMap
- assert
That Map<T, K, V>(value, name?): MapValidator<T, K, V> Validates the state of a map.
++The returned validator throws an exception immediately if a validation fails. This exception is then +converted into an AssertionError. Exceptions unrelated to validation failures are not converted.
Type Parameters
Parameters
- value: T
the value
+ Optionalname: stringthe name of the value
+
Returns MapValidator<T, K, V>
validator for the value
+- value: T
Function assertThatNumber
- assert
That Number<T>(value, name?): NumberValidator<T> Validates the state of a number.
++The returned validator throws an exception immediately if a validation fails. This exception is then +converted into an AssertionError. Exceptions unrelated to validation failures are not converted.
Type Parameters
Parameters
- value: T
the value
+ Optionalname: stringthe name of the value
+
Returns NumberValidator<T>
validator for the value
+- value: T
Function assertThatSet
- assert
That Set<T, E>(value, name?): SetValidator<T, E> Validates the state of a set.
++The returned validator throws an exception immediately if a validation fails. This exception is then +converted into an AssertionError. Exceptions unrelated to validation failures are not converted.
Type Parameters
Parameters
- value: T
the value
+ Optionalname: stringthe name of the value
+
Returns SetValidator<T, E>
validator for the value
+- value: T
Function assertThatString
- assert
That String<T>(value, name?): StringValidator<T> Validates the state of a string.
++The returned validator throws an exception immediately if a validation fails. This exception is then +converted into an AssertionError. Exceptions unrelated to validation failures are not converted.
Type Parameters
Parameters
- value: T
the value
+ Optionalname: stringthe name of the value
+
Returns StringValidator<T>
validator for the value
+- value: T
Function checkIf
- check
If<T>(value, name): 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
Parameters
- value: T
the value
+ - name: string
the name of the value
+
Returns UnknownValidator<T>
validator for the value
+- value: T
Function checkIfArray
- check
If Array<T, E>(value, name): 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>
validator for the value
+- T extends undefined | null | E[]
Function checkIfBoolean
- check
If Boolean<T>(value, name): BooleanValidator<T> Validates the state of a boolean.
++The returned validator throws an error immediately if a validation fails.
Type Parameters
Parameters
- value: T
the value
+ - name: string
the name of the value
+
Returns BooleanValidator<T>
validator for the value
+- value: T
Function checkIfMap
Function checkIfNumber
- check
If Number<T>(value, name): NumberValidator<T> Validates the state of a number.
++The returned validator throws an error immediately if a validation fails.
Type Parameters
Parameters
- value: T
the value
+ - name: string
the name of the value
+
Returns NumberValidator<T>
validator for the value
+- value: T
Function checkIfSet
- check
If Set<T, E>(value, name): SetValidator<T, E> Validates the state of a set.
++The returned validator throws an error immediately if a validation fails.
Type Parameters
Parameters
- value: T
the value
+ - name: string
the name of the value
+
Returns SetValidator<T, E>
validator for the value
+- value: T
Function checkIfString
- check
If String<T>(value, name): StringValidator<T> Validates the state of a string.
++The returned validator throws an error immediately if a validation fails.
Type Parameters
Parameters
- value: T
the value
+ - name: string
the name of the value
+
Returns StringValidator<T>
validator for the value
+- value: T
Function getContext
- get
Context(): Map<string, unknown> Returns the contextual information for 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:+```console +Password may not be empty +username: john.smith +```
Returns Map<string, unknown>
an unmodifiable map from each entry's name to its value
+
Function globalConfiguration
- global
Configuration(): GlobalConfiguration Returns the global configuration shared by all validators.
++NOTE: Updating this configuration affects existing and new validators.
Returns GlobalConfiguration
the global configuration updater
+
Function removeContext
- remove
Context(name): JavascriptValidatorsImpl Removes the contextual information of validators created by this factory.
+Parameters
- name: string
the parameter name
+
Returns JavascriptValidatorsImpl
the underlying validator factory
+- name: string
Function requireThat
- require
That<T>(value, name): UnknownValidator<T> Validates the state of an unknown value or a value that does not have a specialized validator.
++The returned validator throws an exception immediately if a validation fails. This exception is then +converted into an AssertionError. Exceptions unrelated to validation failures are not converted.
Type Parameters
Parameters
- value: T
the value
+ - name: string
the name of the value
+
Returns UnknownValidator<T>
validator for the value
+- value: T
Function requireThatArray
- require
That Array<T, E>(value, name): ArrayValidator<T, E> Validates the state of an array.
++The returned validator throws an exception immediately if a validation fails. This exception is then +converted into an AssertionError. Exceptions unrelated to validation failures are not converted.
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>
validator for the value
+- T extends undefined | null | E[]
Function requireThatBoolean
- require
That Boolean<T>(value, name): BooleanValidator<T> Validates the state of a boolean.
++The returned validator throws an error immediately if a validation fails.
Type Parameters
Parameters
- value: T
the value
+ - name: string
the name of the value
+
Returns BooleanValidator<T>
a verifier
+- value: T
Function requireThatMap
- require
That Map<T, K, V>(value, name): MapValidator<T, K, V> Validates the state of a map.
++The returned validator throws an exception immediately if a validation fails. This exception is then +converted into an AssertionError. Exceptions unrelated to validation failures are not converted.
Type Parameters
Parameters
- value: T
the value
+ - name: string
the name of the value
+
Returns MapValidator<T, K, V>
validator for the value
+- value: T
Function requireThatNumber
- require
That Number<T>(value, name): NumberValidator<T> Validates the state of a number.
++The returned validator throws an error immediately if a validation fails.
Type Parameters
Parameters
- value: T
the value
+ - name: string
the name of the value
+
Returns NumberValidator<T>
a verifier
+- value: T
Function requireThatSet
- require
That Set<T, E>(value, name): SetValidator<T, E> Validates the state of a set.
++The returned validator throws an exception immediately if a validation fails. This exception is then +converted into an AssertionError. Exceptions unrelated to validation failures are not converted.
Type Parameters
Parameters
- value: T
the value
+ - name: string
the name of the value
+
Returns SetValidator<T, E>
validator for the value
+- value: T
Function requireThatString
- require
That String<T>(value, name): StringValidator<T> Validates the state of a string.
++The returned validator throws an exception immediately if a validation fails. This exception is then +converted into an AssertionError. Exceptions unrelated to validation failures are not converted.
Type Parameters
Parameters
- value: T
the value
+ - name: string
the name of the value
+
Returns StringValidator<T>
validator for the value
+- value: T
Function updateConfiguration
- update
Configuration(updater): JavascriptValidatorsImpl Updates the configuration that will be used by new validators.
+Parameters
- updater: ((configuration: ConfigurationUpdater) => void)
a function that updates the configuration
+- (configuration): void
Parameters
- configuration: ConfigurationUpdater
Returns void
Returns JavascriptValidatorsImpl
this
+- updater: ((configuration: ConfigurationUpdater) => void)
Function withContext
- with
Context(value, name): 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
the underlying validator factory
+- value: unknown
Function sortByDecreasingRank
Returns a comparator that sorts encodings based on the number of colors that they support, from the most +to the least number of colors.
+- sort
By Decreasing Rank(first, second): number Parameters
- first: TerminalEncoding
the first encoding
+ - second: TerminalEncoding
the second encoding
+
Returns number
a negative number if
+firstsupports more colors thansecond. +0if the encodings support the same number of colors. A positive number if +firstsupports fewer colors thansecond.- first: TerminalEncoding
Function isValidationFailure
- is
Validation Failure(value): value is ValidationFailure Parameters
- value: unknown
a value
+
Returns value is ValidationFailure
true if the value is an instance of
+ValidationFailure- value: unknown
@cowwoc/requirements - v4.0.6
+
Requirements API
+
+
A fluent API for enforcing +design contracts with +automatic message generation:
+✔️ Easy to use
+✔️ Fast
+✔️ Production-ready
To get started, add this dependency:
+npm install --save @cowwoc/requirements@4.0.5
+or pnpm:
+pnpm add @cowwoc/requirements@4.0.5
+Usage Example
import {requireThatString} from "@cowwoc/requirements";
class Cake
{
private bitesTaken = 0;
private piecesLeft;
public constructor(piecesLeft: number)
{
requireThat(piecesLeft, "piecesLeft").isPositive();
this.piecesLeft = piecesLeft;
}
public eat(): number
{
++bitesTaken;
assertThat(bitesTaken, "bitesTaken").isNotNegative().elseThrow();
piecesLeft -= ThreadLocalRandom.current().nextInt(5);
assertThat(piecesLeft, "piecesLeft").isNotNegative().elseThrow();
return piecesLeft;
}
public getFailures(): String[]
{
return checkIf(bitesTaken, "bitesTaken").isNotNegative().
and(checkIf(piecesLeft, "piecesLeft").isGreaterThan(3)).
elseGetMessages();
}
}
+If you violate a precondition:
+const cake = new Cake(-1000);
+You'll get:
+RangeError: "piecesLeft" must be positive.
actual: -1000
+If you violate a class invariant:
+const cake = new Cake(1_000_000);
while (true)
cake.eat();
+You'll get:
+lang.AssertionError: "bitesTaken" may not be negative.
actual: -128
+If you violate a postcondition:
+const cake = new Cake(100);
while (true)
cake.eat();
+You'll get:
+AssertionError: "piecesLeft" may not be negative.
actual: -4
+If you violate multiple conditions at once:
+const cake = new Cake(1);
cake.bitesTaken = -1;
cake.piecesLeft = 2;
const failures = [];
for (const failure of cake.getFailures())
failures.add(failure);
console.log(failures.join("\n\n"));
+You'll get:
+"bitesTaken" may not be negative.
actual: -1
"piecesLeft" must be greater than 3.
actual: 2
+Features
This library offers the following features:
+-
+
- Automatic message generation for validation failures +
- Diffs provided whenever possible to highlight the +differences between expected and actual values +
- Zero overhead when assertions are disabled for better performance +
- Multiple validation failures that report all the errors at +once +
- Nested validations that allow you to validate complex objects +
- String diff that shows the differences between two strings +
Entry Points
Designed for discovery using your favorite IDE's auto-complete feature. +The main entry points are:
+-
+
- requireThat(value, name) +for method preconditions. +
- assertThat(value, name) +for class invariants, method postconditions and private methods. +
- checkIf(value, name) +for multiple failures and customized error handling. +
See the API documentation for more details.
+Best practices
-
+
- Use
checkIf().elseGetMessages()to return failure messages without throwing an exception. +This is the fastest validation approach, ideal for web services.
+ - To enhance the clarity of failure messages, you should provide parameter names, even when they are optional.
+In other words, favor
assert that(value, name)overassert that(value).
+
Related Projects
+License
Code licensed under the Apache License, Version 2.0: http://www.apache.org/licenses/LICENSE-2.0
+Icons made by Flat Icons from www.flaticon.com is licensed by CC 3.0 BY
+Interface ApplicationScope
The configuration of an application. A process may contain multiple applications.
+close(): void;
getGlobalConfiguration(): GlobalConfiguration;
getTerminal(): Terminal;
}
Hierarchy (view full)
- ProcessScope
- ApplicationScope
Index
Methods
Methods
close
get
- get
Global Configuration(): GlobalConfiguration Returns GlobalConfiguration
the global configuration inherited by all validators
+
get
Interface ProcessScope
The process configuration.
+Hierarchy (view full)
- ProcessScope
Index
Methods
Interface ValidatorComponent<T>
Methods that all validators must contain.
+and(validation: ((validator: this) => void)): this;
elseGetFailures(): ValidationFailures;
elseThrow(): boolean;
getContext(): Map<string, unknown>;
getContextAsString(): string;
getName(): string;
getValue(): T;
getValueOrDefault(defaultValue: T): T;
getValueOrDefault(defaultValue: null | T): null | T;
isEqualTo(expected: unknown): this;
isEqualTo(expected: unknown, name: string): this;
isInstanceOf<U>(expected: ClassConstructor<U>): UnknownValidator<U>;
isNotEqualTo(unwanted: unknown): this;
isNotEqualTo(unwanted: unknown, name: string): this;
isNotInstanceOf<U>(unwanted: ClassConstructor<U>): this;
isNotNull(): UnknownValidator<NonNullable<T>>;
isNotUndefined(): UnknownValidator<NonUndefinable<T>>;
isNull(): UnknownValidator<null>;
isType(expected: Type): this;
isUndefined(): UnknownValidator<undefined>;
validationFailed(): boolean;
withContext(value: unknown, name: string): this;
}
Type Parameters
Hierarchy (view full)
Implemented by
Methods
and
- and(validation): this
Facilitates the validation of related properties. For example,
++```ts +requireThat(nameToFrequency, "nameToFrequency"). + and(m => m.size().isPositive()). + and(m => m.keySet().contains("John")); +``` +
+Any changes made during the validation process will impact this validator.
Parameters
- validation: ((validator: this) => void)
the nested validation
+- (validator): void
Parameters
- validator: this
Returns void
Returns this
this
+- validation: ((validator: this) => void)
else
- else
Get Failures(): ValidationFailures Returns the array of failed validations.
+Returns ValidationFailures
an array of failed validations
+
else
get
- get
Context(): Map<string, unknown> Returns the contextual information for upcoming validations carried out by this validator. 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
+
get
get
get
get
- get
Value Or Default(defaultValue): T Returns the value that is being validated.
+Parameters
- defaultValue: T
the fallback value to use if the value is invalid
+
Returns T
the validated value, or
+defaultValueif the value is invalid (e.g. due to dereferencing a +property of anullobject)- defaultValue: T
- get
Value Or Default(defaultValue): null | T Parameters
- defaultValue: null | T
Returns null | T
is
- is
Equal To(expected): this Ensures that the object is equal to
+expected.Parameters
- expected: unknown
the expected value
+
Returns this
this
+- expected: unknown
- is
Equal To(expected, name): this Ensures that the object is equal to
+expected.Parameters
- expected: unknown
the expected value
+ - name: string
the name of the expected value
+
Returns this
this
+- expected: unknown
is
- is
Instance Of<U>(expected): UnknownValidator<U> Ensures that the object is an instance of a class.
+Type Parameters
Parameters
- expected: ClassConstructor<U>
the desired class
+
Returns UnknownValidator<U>
a validator for an object of the desired class
+- expected: ClassConstructor<U>
is
- is
Not Equal To(unwanted): this Ensures that the object is not equal to
+unwanted.Parameters
- unwanted: unknown
the unwanted value
+
Returns this
this
+- unwanted: unknown
- is
Not Equal To(unwanted, name): this Ensures that the object is not equal to
+unwanted.Parameters
- unwanted: unknown
the unwanted value
+ - name: string
the name of the other value
+
Returns this
this
+- unwanted: unknown
is
- is
Not Instance Of<U>(unwanted): this Ensures that the object is not an instance of a class.
+Type Parameters
Parameters
- unwanted: ClassConstructor<U>
the unwanted class
+
Returns this
this
+- unwanted: ClassConstructor<U>
is
- is
Not Null(): UnknownValidator<NonNullable<T>> Ensures that the value is not
+null.+This method should be used to validate method arguments that are assigned to class fields but not +accessed right away (such as constructor and setter arguments). It should also be used to validate any +method arguments when the validator contains +additional contextual information.
Returns UnknownValidator<NonNullable<T>>
this
+
is
- is
Not Undefined(): UnknownValidator<NonUndefinable<T>> Ensures that the value is not undefined.
++This method should be used to validate method arguments that are assigned to class fields but not +accessed right away (such as constructor and setter arguments). It should also be used to validate any +method arguments when the validator contains +additional contextual information.
Returns UnknownValidator<NonUndefinable<T>>
this
+
is
- is
Null(): UnknownValidator<null> Ensures that the value is
+null.Returns UnknownValidator<null>
this
+
is
- is
Type(expected): this Ensures that the value has the specified type.
+Parameters
- expected: Type
the expected type of the value
+
Returns this
this
+- expected: Type
is
- is
Undefined(): UnknownValidator<undefined> Ensures that the value is undefined.
+Returns UnknownValidator<undefined>
this
+
validation
with
- with
Context(value, name): this Sets the contextual information for upcoming validations.
++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 override any values that are set using +Validators.withContext. +
+There is no way to remove contextual information from a validator. Thread-level contextual information is +removed automatically.
Parameters
- value: unknown
the value of the entry
+ - name: string
the name of an entry
+
Returns this
this
+- value: unknown
Interface GlobalConfiguration
The configuration shared by all validators. Changes apply to existing or new validators.
+supportedTerminalEncodings(): Set<TerminalEncoding>;
terminalEncoding(): TerminalEncoding;
terminalEncoding(encoding: TerminalEncoding): GlobalConfiguration;
terminalEncoding(encoding?: TerminalEncoding): GlobalConfiguration | TerminalEncoding;
}
Index
Methods
Methods
supported
- supported
Terminal Encodings(): Set<TerminalEncoding> Returns the encoding supported by the terminal.
+Returns Set<TerminalEncoding>
the encoding supported by the terminal
+
terminal
- terminal
Encoding(): TerminalEncoding Returns the current terminal encoding.
+Returns TerminalEncoding
the current terminal encoding (defaults to the auto-detected encoding)
+- terminal
Encoding(encoding): GlobalConfiguration Sets the terminal encoding of the output.
++This can be used to force the use of ANSI colors when their support is not detected.
Parameters
- encoding: TerminalEncoding
the type of encoding that the terminal supports
+
Returns GlobalConfiguration
this
+- encoding: TerminalEncoding
- terminal
Encoding(encoding?): GlobalConfiguration | TerminalEncoding Parameters
Optionalencoding: TerminalEncoding
Returns GlobalConfiguration | TerminalEncoding
Interface JavascriptAssertThat
Creates validators for the Javascript API that throw AssertionError immediately on validation failure.
assertThat<T>(value: T, name?: string): UnknownValidator<T>;
assertThatArray<T, E>(value: T, name?: string): ArrayValidator<T, E>;
assertThatBoolean<T>(value: T, name?: string): BooleanValidator<T>;
assertThatMap<T, K, V>(value: T, name?: string): MapValidator<T, K, V>;
assertThatNumber<T>(value: T, name?: string): NumberValidator<T>;
assertThatSet<T, E>(value: T, name?: string): SetValidator<T, E>;
assertThatString<T>(value: T, name?: string): StringValidator<T>;
}
Implemented by
Index
Methods
assert
- assert
That<T>(value, name?): 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
Parameters
- value: T
the value
+ Optionalname: stringthe name of the value
+
Returns UnknownValidator<T>
a validator for the value
+- value: T
assert
- assert
That Array<T, E>(value, name?): 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: stringthe name of the value
+
Returns ArrayValidator<T, E>
a validator for the value
+- T extends undefined | null | E[]
assert
- assert
That Boolean<T>(value, name?): 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
Parameters
- value: T
the value
+ Optionalname: stringthe name of the value
+
Returns BooleanValidator<T>
a validator for the value
+- value: T
assert
- assert
That Map<T, K, V>(value, name?): 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
Parameters
- value: T
the value
+ Optionalname: stringthe name of the value
+
Returns MapValidator<T, K, V>
a validator for the value
+- value: T
assert
- assert
That Number<T>(value, name?): 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
Parameters
- value: T
the value
+ Optionalname: stringthe name of the value
+
Returns NumberValidator<T>
a validator for the value
+- value: T
assert
- assert
That Set<T, E>(value, name?): 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
Parameters
- value: T
the value
+ Optionalname: stringthe name of the value
+
Returns SetValidator<T, E>
a validator for the value
+- value: T
assert
- assert
That String<T>(value, name?): 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
Parameters
- value: T
the value
+ Optionalname: stringthe name of the value
+
Returns StringValidator<T>
a validator for the value
+- value: T
Interface JavascriptCheckIf
Creates validators for the Javascript API that capture errors on validation failure rather than throwing +them immediately.
+checkIf<T>(value: T, name: string): UnknownValidator<T>;
checkIfArray<T, E>(value: T, name: string): ArrayValidator<T, E>;
checkIfBoolean<T>(value: T, name: string): BooleanValidator<T>;
checkIfMap<T, K, V>(value: T, name: string): MapValidator<T, K, V>;
checkIfNumber<T>(value: T, name: string): NumberValidator<T>;
checkIfSet<T, E>(value: T, name: string): SetValidator<T, E>;
checkIfString<T>(value: T, name: string): StringValidator<T>;
}
Implemented by
Index
Methods
Methods
check
- check
If<T>(value, name): 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
Parameters
- value: T
the value
+ - name: string
the name of the value
+
Returns UnknownValidator<T>
a validator for the value
+- value: T
check
- check
If Array<T, E>(value, name): 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
+ - name: string
the name of the value
+
Returns ArrayValidator<T, E>
a validator for the value
+- T extends undefined | null | E[]
check
- check
If Boolean<T>(value, name): 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
Parameters
- value: T
the value
+ - name: string
the name of the value
+
Returns BooleanValidator<T>
a validator for the value
+- value: T
check
- check
If Map<T, K, V>(value, name): 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
Parameters
- value: T
the value
+ - name: string
the name of the value
+
Returns MapValidator<T, K, V>
a validator for the value
+- value: T
check
- check
If Number<T>(value, name): 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
Parameters
- value: T
the value
+ - name: string
the name of the value
+
Returns NumberValidator<T>
a validator for the value
+- value: T
check
- check
If Set<T, E>(value, name): 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
Parameters
- value: T
the value
+ - name: string
the name of the value
+
Returns SetValidator<T, E>
a validator for the value
+- value: T
check
- check
If String<T>(value, name): 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
Parameters
- value: T
the value
+ - name: string
the name of the value
+
Returns StringValidator<T>
a validator for the value
+- value: T
Interface JavascriptRequireThat
Creates validators for the Javascript API that throw errors immediately on validation failure.
+requireThat<T>(value: T, name: string): UnknownValidator<T>;
requireThatArray<T, E>(value: T, name: string): ArrayValidator<T, E>;
requireThatBoolean<T>(value: T, name: string): BooleanValidator<T>;
requireThatMap<T, K, V>(value: T, name: string): MapValidator<T, K, V>;
requireThatNumber<T>(value: T, name: string): NumberValidator<T>;
requireThatSet<T, E>(value: T, name: string): SetValidator<T, E>;
requireThatString<T>(value: T, name: string): StringValidator<T>;
}
Implemented by
Methods
require
- require
That<T>(value, name): 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
Parameters
- value: T
the value
+ - name: string
the name of the value
+
Returns UnknownValidator<T>
a validator for the value
+- value: T
require
- require
That Array<T, E>(value, name): 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
+- T extends undefined | null | E[]
require
- require
That Boolean<T>(value, name): BooleanValidator<T> Validates the state of a
+boolean.+The returned validator throws an error immediately if a validation fails.
Type Parameters
Parameters
- value: T
the value
+ - name: string
the name of the value
+
Returns BooleanValidator<T>
a validator for the value
+- value: T
require
- require
That Map<T, K, V>(value, name): MapValidator<T, K, V> Validates the state of a
+Map.+The returned validator throws an error immediately if a validation fails.
Type Parameters
Parameters
- value: T
the value
+ - name: string
the name of the value
+
Returns MapValidator<T, K, V>
a validator for the value
+- value: T
require
- require
That Number<T>(value, name): NumberValidator<T> Validates the state of a
+number.+The returned validator throws an error immediately if a validation fails.
Type Parameters
Parameters
- value: T
the value
+ - name: string
the name of the value
+
Returns NumberValidator<T>
a validator for the value
+- value: T
require
- require
That Set<T, E>(value, name): SetValidator<T, E> Validates the state of a
+Set.+The returned validator throws an error immediately if a validation fails.
Type Parameters
Parameters
- value: T
the value
+ - name: string
the name of the value
+
Returns SetValidator<T, E>
a validator for the value
+- value: T
require
- require
That String<T>(value, name): StringValidator<T> Validates the state of a
+string.+The returned validator throws an error immediately if a validation fails.
Type Parameters
Parameters
- value: T
the value
+ - name: string
the name of the value
+
Returns StringValidator<T>
a validator for the value
+- value: T
Interface Validators<S>
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. +
copy(): S;
getContext(): Map<string, unknown>;
getGlobalConfiguration(): GlobalConfiguration;
removeContext(name: string): this;
withContext(value: unknown, name: string): this;
}
Type Parameters
Implemented by
Index
Methods
Methods
copy
- copy(): S
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 S
a copy of this factory
+
get
- get
Context(): 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
+
get
- get
Global Configuration(): GlobalConfiguration Returns the global configuration shared by all validators.
++NOTE: Updating this configuration affects existing and new validators.
Returns GlobalConfiguration
the global configuration updater
+
remove
with
- with
Context(value, name): 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
+- value: unknown
Interface ArrayValidator<T, E>
Validates the state of an array.
+and(validation: ((validator: this) => void)): this;
contains(expected: E): this;
contains(expected: E, name: string): this;
containsAll(expected: Set<E>): this;
containsAll(expected: E[]): this;
containsAll(expected: Set<E>, name: string): this;
containsAll(expected: E[], name: string): this;
containsAny(expected: Set<E>): this;
containsAny(expected: E[]): this;
containsAny(expected: Set<E>, name: string): this;
containsAny(expected: E[], name: string): this;
containsExactly(expected: Set<E>): this;
containsExactly(expected: E[]): this;
containsExactly(expected: Set<E>, name: string): this;
containsExactly(expected: E[], name: string): this;
doesNotContain(unwanted: E): this;
doesNotContain(unwanted: E, name: string): this;
doesNotContainAll(unwanted: Set<E>): this;
doesNotContainAll(unwanted: E[]): this;
doesNotContainAll(unwanted: Set<E>, name: string): this;
doesNotContainAll(unwanted: E[], name: string): this;
doesNotContainAny(unwanted: Set<E>): this;
doesNotContainAny(unwanted: E[]): this;
doesNotContainAny(unwanted: Set<E>, name: string): this;
doesNotContainAny(unwanted: E[], name: string): this;
doesNotContainDuplicates(): this;
doesNotContainExactly(unwanted: Set<E>): this;
doesNotContainExactly(unwanted: E[]): this;
doesNotContainExactly(unwanted: Set<E>, name: string): this;
doesNotContainExactly(unwanted: E[], name: string): this;
elseGetFailures(): ValidationFailures;
elseThrow(): boolean;
getContext(): Map<string, unknown>;
getContextAsString(): string;
getName(): string;
getValue(): T;
getValueOrDefault(defaultValue: T): T;
getValueOrDefault(defaultValue: null | T): null | T;
isEmpty(): this;
isEqualTo(expected: unknown): this;
isEqualTo(expected: unknown, name: string): this;
isInstanceOf<U>(expected: ClassConstructor<U>): UnknownValidator<U>;
isNotEmpty(): this;
isNotEqualTo(unwanted: unknown): this;
isNotEqualTo(unwanted: unknown, name: string): this;
isNotInstanceOf<U>(unwanted: ClassConstructor<U>): this;
isNotNull(): UnknownValidator<NonNullable<T>>;
isNotUndefined(): UnknownValidator<Exclude<T, undefined>>;
isNull(): UnknownValidator<null>;
isSorted(comparator: ((first: unknown, second: unknown) => number)): this;
isType(expected: Type): this;
isUndefined(): UnknownValidator<undefined>;
length(): UnsignedNumberValidator;
size(): UnsignedNumberValidator;
validationFailed(): boolean;
withContext(value: unknown, name: string): this;
}
Type Parameters
- T extends E[] | undefined | null
the type of the value
+ - E
the type of elements in the collection
+
Hierarchy (view full)
- ValidatorComponent<T>
- CollectionComponent<E>
- ArrayValidator
Index
Methods
Methods
and
- and(validation): this
Facilitates the validation of related properties. For example,
++```ts +requireThat(nameToFrequency, "nameToFrequency"). + and(m => m.size().isPositive()). + and(m => m.keySet().contains("John")); +``` +
+Any changes made during the validation process will impact this validator.
Parameters
- validation: ((validator: this) => void)
the nested validation
+- (validator): void
Parameters
- validator: this
Returns void
Returns this
this
+- validation: ((validator: this) => void)
contains
contains
- contains
All(expected): this Ensures that the collection contains all the elements in
+expected.Returns this
this
+- contains
All(expected): this Ensures that the collection contains all the elements in
+expected.Parameters
- expected: E[]
the desired elements
+
Returns this
this
+- expected: E[]
- contains
All(expected, name): this Ensures that the collection contains all the elements in
+expected.Returns this
this
+- contains
All(expected, name): this Ensures that the collection contains all the elements in
+expected.Parameters
- expected: E[]
the desired elements
+ - name: string
the name of the expected collection
+
Returns this
this
+- expected: E[]
contains
- contains
Any(expected): this Ensures that the collection contains any elements in
+expected.Returns this
this
+- contains
Any(expected): this Ensures that the collection contains any elements in
+expected.Parameters
- expected: E[]
the desired elements
+
Returns this
this
+- expected: E[]
- contains
Any(expected, name): this Ensures that the collection contains at least one element in
+expected.Returns this
this
+- contains
Any(expected, name): this Ensures that the collection contains at least one element in
+expected.Parameters
- expected: E[]
the desired elements
+ - name: string
the name of the expected collection
+
Returns this
this
+- expected: E[]
contains
- contains
Exactly(expected): this Ensures that the collection consists of the same elements as
+expected, irrespective of their +order.+In contrast, isEqualTo() requires the same element ordering.
Returns this
this
+- contains
Exactly(expected): this Ensures that the collection consists of the same elements as
+expected, irrespective of +their order.+In contrast, isEqualTo() requires the same element ordering.
Parameters
- expected: E[]
the desired elements
+
Returns this
this
+- expected: E[]
- contains
Exactly(expected, name): this Ensures that the collection consists of the same elements as
+expected, irrespective of their +order.+In contrast, isEqualTo() requires the same element ordering.
Returns this
this
+- contains
Exactly(expected, name): this Ensures that the collection consists of the same elements as
+expected, irrespective of +their order.+In contrast, isEqualTo() requires the same element ordering.
Parameters
- expected: E[]
the desired elements
+ - name: string
the name of the expected collection
+
Returns this
this
+- expected: E[]
does
- does
Not Contain(unwanted): this Ensures that the collection does not contain
+unwanted.Parameters
- unwanted: E
the unwanted element
+
Returns this
this
+- unwanted: E
- does
Not Contain(unwanted, name): this Ensures that the collection does not contain
+unwanted.Parameters
- unwanted: E
the unwanted element
+ - name: string
the name of the element
+
Returns this
this
+- unwanted: E
does
- does
Not Contain All(unwanted): this Allows the collection to contain some, but not all, elements from a collection.
+Returns this
this
+- does
Not Contain All(unwanted): this Allows the collection to contain some, but not all, elements from a collection.
+Parameters
- unwanted: E[]
the unwanted elements
+
Returns this
this
+- unwanted: E[]
- does
Not Contain All(unwanted, name): this Allows the collection to contain some, but not all, elements from a collection.
+Returns this
this
+- does
Not Contain All(unwanted, name): this Allows the collection to contain some, but not all, elements from a collection.
+Parameters
- unwanted: E[]
the unwanted elements
+ - name: string
the name of the unwanted collection
+
Returns this
this
+- unwanted: E[]
does
- does
Not Contain Any(unwanted): this Ensures that the collection does not contain any of the elements in
+unwanted.Returns this
this
+- does
Not Contain Any(unwanted): this Ensures that the collection does not contain any of the elements in
+unwanted.Parameters
- unwanted: E[]
the unwanted elements
+
Returns this
this
+- unwanted: E[]
- does
Not Contain Any(unwanted, name): this Ensures that the collection does not contain any of the elements in
+unwanted.Returns this
this
+- does
Not Contain Any(unwanted, name): this Ensures that the collection does not contain any of the elements in
+unwanted.Parameters
- unwanted: E[]
the unwanted elements
+ - name: string
the name of the unwanted collection
+
Returns this
this
+- unwanted: E[]
does
does
- does
Not Contain Exactly(unwanted): this Ensures that the collection and
+unwantedconsist of different elements, irrespective of their +order.Returns this
this
+- does
Not Contain Exactly(unwanted): this Ensures that the collection and
+unwantedconsist of different elements, irrespective of their +order.Parameters
- unwanted: E[]
the unwanted elements
+
Returns this
this
+- unwanted: E[]
- does
Not Contain Exactly(unwanted, name): this Ensures that the collection and
+unwantedconsist of different elements, irrespective of +their order.Returns this
this
+- does
Not Contain Exactly(unwanted, name): this Ensures that the collection and
+unwantedconsist of different elements, irrespective of their +order.Parameters
- unwanted: E[]
the unwanted elements
+ - name: string
the name of the unwanted collection
+
Returns this
this
+- unwanted: E[]
else
- else
Get Failures(): ValidationFailures Returns the array of failed validations.
+Returns ValidationFailures
an array of failed validations
+
else
get
- get
Context(): Map<string, unknown> Returns the contextual information for upcoming validations carried out by this validator. 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
+
get
get
get
get
- get
Value Or Default(defaultValue): T Returns the value that is being validated.
+Parameters
- defaultValue: T
the fallback value to use if the value is invalid
+
Returns T
the validated value, or
+defaultValueif the value is invalid (e.g. due to dereferencing a +property of anullobject)- defaultValue: T
- get
Value Or Default(defaultValue): null | T Parameters
- defaultValue: null | T
Returns null | T
is
is
- is
Equal To(expected): this Ensures that the object is equal to
+expected.Parameters
- expected: unknown
the expected value
+
Returns this
this
+- expected: unknown
- is
Equal To(expected, name): this Ensures that the object is equal to
+expected.Parameters
- expected: unknown
the expected value
+ - name: string
the name of the expected value
+
Returns this
this
+- expected: unknown
is
- is
Instance Of<U>(expected): UnknownValidator<U> Ensures that the object is an instance of a class.
+Type Parameters
Parameters
- expected: ClassConstructor<U>
the desired class
+
Returns UnknownValidator<U>
a validator for an object of the desired class
+- expected: ClassConstructor<U>
is
is
- is
Not Equal To(unwanted): this Ensures that the object is not equal to
+unwanted.Parameters
- unwanted: unknown
the unwanted value
+
Returns this
this
+- unwanted: unknown
- is
Not Equal To(unwanted, name): this Ensures that the object is not equal to
+unwanted.Parameters
- unwanted: unknown
the unwanted value
+ - name: string
the name of the other value
+
Returns this
this
+- unwanted: unknown
is
- is
Not Instance Of<U>(unwanted): this Ensures that the object is not an instance of a class.
+Type Parameters
Parameters
- unwanted: ClassConstructor<U>
the unwanted class
+
Returns this
this
+- unwanted: ClassConstructor<U>
is
- is
Not Null(): UnknownValidator<NonNullable<T>> Ensures that the value is not
+null.+This method should be used to validate method arguments that are assigned to class fields but not +accessed right away (such as constructor and setter arguments). It should also be used to validate any +method arguments when the validator contains +additional contextual information.
Returns UnknownValidator<NonNullable<T>>
this
+
is
- is
Not Undefined(): UnknownValidator<Exclude<T, undefined>> Ensures that the value is not undefined.
++This method should be used to validate method arguments that are assigned to class fields but not +accessed right away (such as constructor and setter arguments). It should also be used to validate any +method arguments when the validator contains +additional contextual information.
Returns UnknownValidator<Exclude<T, undefined>>
this
+
is
- is
Null(): UnknownValidator<null> Ensures that the value is
+null.Returns UnknownValidator<null>
this
+
is
- is
Sorted(comparator): this Ensures that the array is sorted.
+Parameters
- comparator: ((first: unknown, second: unknown) => number)
a function that returns a negative number if
+firstshould come +beforesecond, zero orNaNif the two values are equal, or a positive number +iffirstshould come aftersecond.- (first, second): number
Parameters
- first: unknown
- second: unknown
Returns number
Returns this
this
+- comparator: ((first: unknown, second: unknown) => number)
is
- is
Type(expected): this Ensures that the value has the specified type.
+Parameters
- expected: Type
the expected type of the value
+
Returns this
this
+- expected: Type
is
- is
Undefined(): UnknownValidator<undefined> Ensures that the value is undefined.
+Returns UnknownValidator<undefined>
this
+
length
- length(): UnsignedNumberValidator
Returns a validator for the array's length.
+Returns UnsignedNumberValidator
a validator for the array's length
+
size
- size(): UnsignedNumberValidator
Returns a validator for the collection's size.
+Returns UnsignedNumberValidator
a validator for the collection's size
+
validation
with
- with
Context(value, name): this Sets the contextual information for upcoming validations.
++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 override any values that are set using +Validators.withContext. +
+There is no way to remove contextual information from a validator. Thread-level contextual information is +removed automatically.
Parameters
- value: unknown
the value of the entry
+ - name: string
the name of an entry
+
Returns this
this
+- value: unknown
Interface BooleanValidator<T>
Validates the state of a boolean.
and(validation: ((validator: this) => void)): this;
elseGetFailures(): ValidationFailures;
elseThrow(): boolean;
getContext(): Map<string, unknown>;
getContextAsString(): string;
getName(): string;
getValue(): T;
getValueOrDefault(defaultValue: T): T;
getValueOrDefault(defaultValue: null | T): null | T;
isEqualTo(expected: unknown): this;
isEqualTo(expected: unknown, name: string): this;
isFalse(): this;
isInstanceOf<U>(expected: ClassConstructor<U>): UnknownValidator<U>;
isNotEqualTo(unwanted: unknown): this;
isNotEqualTo(unwanted: unknown, name: string): this;
isNotInstanceOf<U>(unwanted: ClassConstructor<U>): this;
isNotNull(): UnknownValidator<NonNullable<T>>;
isNotUndefined(): UnknownValidator<Exclude<T, undefined>>;
isNull(): UnknownValidator<null>;
isTrue(): this;
isType(expected: Type): this;
isUndefined(): UnknownValidator<undefined>;
validationFailed(): boolean;
withContext(value: unknown, name: string): this;
}
Type Parameters
Hierarchy (view full)
- ValidatorComponent<T>
- BooleanValidator
Methods
and
- and(validation): this
Facilitates the validation of related properties. For example,
++```ts +requireThat(nameToFrequency, "nameToFrequency"). + and(m => m.size().isPositive()). + and(m => m.keySet().contains("John")); +``` +
+Any changes made during the validation process will impact this validator.
Parameters
- validation: ((validator: this) => void)
the nested validation
+- (validator): void
Parameters
- validator: this
Returns void
Returns this
this
+- validation: ((validator: this) => void)
else
- else
Get Failures(): ValidationFailures Returns the array of failed validations.
+Returns ValidationFailures
an array of failed validations
+
else
get
- get
Context(): Map<string, unknown> Returns the contextual information for upcoming validations carried out by this validator. 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
+
get
get
get
get
- get
Value Or Default(defaultValue): T Returns the value that is being validated.
+Parameters
- defaultValue: T
the fallback value to use if the value is invalid
+
Returns T
the validated value, or
+defaultValueif the value is invalid (e.g. due to dereferencing a +property of anullobject)- defaultValue: T
- get
Value Or Default(defaultValue): null | T Parameters
- defaultValue: null | T
Returns null | T
is
- is
Equal To(expected): this Ensures that the object is equal to
+expected.Parameters
- expected: unknown
the expected value
+
Returns this
this
+- expected: unknown
- is
Equal To(expected, name): this Ensures that the object is equal to
+expected.Parameters
- expected: unknown
the expected value
+ - name: string
the name of the expected value
+
Returns this
this
+- expected: unknown
is
is
- is
Instance Of<U>(expected): UnknownValidator<U> Ensures that the object is an instance of a class.
+Type Parameters
Parameters
- expected: ClassConstructor<U>
the desired class
+
Returns UnknownValidator<U>
a validator for an object of the desired class
+- expected: ClassConstructor<U>
is
- is
Not Equal To(unwanted): this Ensures that the object is not equal to
+unwanted.Parameters
- unwanted: unknown
the unwanted value
+
Returns this
this
+- unwanted: unknown
- is
Not Equal To(unwanted, name): this Ensures that the object is not equal to
+unwanted.Parameters
- unwanted: unknown
the unwanted value
+ - name: string
the name of the other value
+
Returns this
this
+- unwanted: unknown
is
- is
Not Instance Of<U>(unwanted): this Ensures that the object is not an instance of a class.
+Type Parameters
Parameters
- unwanted: ClassConstructor<U>
the unwanted class
+
Returns this
this
+- unwanted: ClassConstructor<U>
is
- is
Not Null(): UnknownValidator<NonNullable<T>> Ensures that the value is not
+null.+This method should be used to validate method arguments that are assigned to class fields but not +accessed right away (such as constructor and setter arguments). It should also be used to validate any +method arguments when the validator contains +additional contextual information.
Returns UnknownValidator<NonNullable<T>>
this
+
is
- is
Not Undefined(): UnknownValidator<Exclude<T, undefined>> Ensures that the value is not undefined.
++This method should be used to validate method arguments that are assigned to class fields but not +accessed right away (such as constructor and setter arguments). It should also be used to validate any +method arguments when the validator contains +additional contextual information.
Returns UnknownValidator<Exclude<T, undefined>>
this
+
is
- is
Null(): UnknownValidator<null> Ensures that the value is
+null.Returns UnknownValidator<null>
this
+
is
is
- is
Type(expected): this Ensures that the value has the specified type.
+Parameters
- expected: Type
the expected type of the value
+
Returns this
this
+- expected: Type
is
- is
Undefined(): UnknownValidator<undefined> Ensures that the value is undefined.
+Returns UnknownValidator<undefined>
this
+
validation
with
- with
Context(value, name): this Sets the contextual information for upcoming validations.
++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 override any values that are set using +Validators.withContext. +
+There is no way to remove contextual information from a validator. Thread-level contextual information is +removed automatically.
Parameters
- value: unknown
the value of the entry
+ - name: string
the name of an entry
+
Returns this
this
+- value: unknown
Interface ConfigurationUpdater
Updates the configuration used by new validators.
+allowDiff(): boolean;
allowDiff(allowDiff: boolean): ConfigurationUpdater;
allowDiff(mayDiff?: boolean): boolean | ConfigurationUpdater;
close(): void;
errorTransformer(): ((error: Error) => Error);
errorTransformer(errorTransformer: ((error: Error) => Error)): ConfigurationUpdater;
errorTransformer(errorTransformer?: ((error: Error) => Error)): ConfigurationUpdater | ((error: Error) => Error);
recordStacktrace(): boolean;
recordStacktrace(recordStacktrace: boolean): ConfigurationUpdater;
recordStacktrace(recordStacktrace?: boolean): boolean | ConfigurationUpdater;
stringMappers(): MutableStringMappers;
}
Index
Methods
Methods
allow
- allow
Diff(): boolean Returns
+trueif error messages may include a diff that compares actual and expected values.Returns boolean
+trueby default- allow
Diff(allowDiff): ConfigurationUpdater Specifies that error messages may include a diff that compares actual and expected values.
+Parameters
- allowDiff: boolean
+trueby default
Returns ConfigurationUpdater
this
+- allowDiff: boolean
- allow
Diff(mayDiff?): boolean | ConfigurationUpdater Parameters
OptionalmayDiff: boolean
Returns boolean | ConfigurationUpdater
close
error
- error
Transformer(): ((error: Error) => Error) Returns a function that transforms the validation error before it is thrown or returned. If the function +returns
+undefinedornull, it’s treated as if it returned the input error.Returns ((error: Error) => Error)
a function that transforms the validation error
+- error
Transformer(errorTransformer): ConfigurationUpdater Sets a function that transforms the validation error before it is thrown or returned. If the function +returns
+undefinedornull, it’s treated as if it returned the input error.Parameters
Returns ConfigurationUpdater
this
+- error
Transformer(errorTransformer?): ConfigurationUpdater | ((error: Error) => Error) Parameters
Returns ConfigurationUpdater | ((error: Error) => Error)
record
- record
Stacktrace(): boolean Returns
+trueif error stack traces should reference the code that triggers a validation +failure. When set tofalse, the error type remains unchanged, but the stack trace location is +undefined. Users who only plan to list of failure messages +instead of errors may experience a performance improvement if this value is set tofalse.Returns boolean
+trueif errors must be recorded when a validation failure occurs- record
Stacktrace(recordStacktrace): ConfigurationUpdater Specifies whether error stack traces should reference the code that triggers a validation failure. +When set to
+false, the error type remains unchanged, but the stack trace location is +undefined. Users who only plan to list of failure messages +instead of errors may experience a performance improvement if this value is set tofalse.Parameters
- recordStacktrace: boolean
+trueif errors must be recorded when a validation failure occurs
Returns ConfigurationUpdater
this
+- recordStacktrace: boolean
- record
Stacktrace(recordStacktrace?): boolean | ConfigurationUpdater Parameters
OptionalrecordStacktrace: boolean
Returns boolean | ConfigurationUpdater
string
- string
Mappers(): MutableStringMappers Returns the configuration used to map contextual values to a String. Supports common types such as +arrays or numbers.
+Returns MutableStringMappers
a function that takes an object and returns the
+stringrepresentation of the object
Interface MapValidator<T, K, V>
Validates the state of a Map.
and(validation: ((validator: this) => void)): this;
elseGetFailures(): ValidationFailures;
elseThrow(): boolean;
entries(): ArrayValidator<[K, V][], [K, V]>;
getContext(): Map<string, unknown>;
getContextAsString(): string;
getName(): string;
getValue(): T;
getValueOrDefault(defaultValue: T): T;
getValueOrDefault(defaultValue: null | T): null | T;
isEmpty(): this;
isEqualTo(expected: unknown): this;
isEqualTo(expected: unknown, name: string): this;
isInstanceOf<U>(expected: ClassConstructor<U>): UnknownValidator<U>;
isNotEmpty(): this;
isNotEqualTo(unwanted: unknown): this;
isNotEqualTo(unwanted: unknown, name: string): this;
isNotInstanceOf<U>(unwanted: ClassConstructor<U>): this;
isNotNull(): UnknownValidator<NonNullable<T>>;
isNotUndefined(): UnknownValidator<Exclude<T, undefined>>;
isNull(): UnknownValidator<null>;
isType(expected: Type): this;
isUndefined(): UnknownValidator<undefined>;
keys(): ArrayValidator<K[], K>;
size(): UnsignedNumberValidator;
validationFailed(): boolean;
values(): ArrayValidator<V[], V>;
withContext(value: unknown, name: string): this;
}
Type Parameters
Hierarchy (view full)
- ValidatorComponent<T>
- MapValidator
Index
Methods
Methods
and
- and(validation): this
Facilitates the validation of related properties. For example,
++```ts +requireThat(nameToFrequency, "nameToFrequency"). + and(m => m.size().isPositive()). + and(m => m.keySet().contains("John")); +``` +
+Any changes made during the validation process will impact this validator.
Parameters
- validation: ((validator: this) => void)
the nested validation
+- (validator): void
Parameters
- validator: this
Returns void
Returns this
this
+- validation: ((validator: this) => void)
else
- else
Get Failures(): ValidationFailures Returns the array of failed validations.
+Returns ValidationFailures
an array of failed validations
+
else
entries
- entries(): ArrayValidator<[K, V][], [K, V]>
Returns a validator for the map's Map.entries +(an array of
+[key, this.value]for each element in the Map).Returns ArrayValidator<[K, V][], [K, V]>
a validator for the map's Map.entries
+
get
- get
Context(): Map<string, unknown> Returns the contextual information for upcoming validations carried out by this validator. 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
+
get
get
get
get
- get
Value Or Default(defaultValue): T Returns the value that is being validated.
+Parameters
- defaultValue: T
the fallback value to use if the value is invalid
+
Returns T
the validated value, or
+defaultValueif the value is invalid (e.g. due to dereferencing a +property of anullobject)- defaultValue: T
- get
Value Or Default(defaultValue): null | T Parameters
- defaultValue: null | T
Returns null | T
is
is
- is
Equal To(expected): this Ensures that the object is equal to
+expected.Parameters
- expected: unknown
the expected value
+
Returns this
this
+- expected: unknown
- is
Equal To(expected, name): this Ensures that the object is equal to
+expected.Parameters
- expected: unknown
the expected value
+ - name: string
the name of the expected value
+
Returns this
this
+- expected: unknown
is
- is
Instance Of<U>(expected): UnknownValidator<U> Ensures that the object is an instance of a class.
+Type Parameters
Parameters
- expected: ClassConstructor<U>
the desired class
+
Returns UnknownValidator<U>
a validator for an object of the desired class
+- expected: ClassConstructor<U>
is
is
- is
Not Equal To(unwanted): this Ensures that the object is not equal to
+unwanted.Parameters
- unwanted: unknown
the unwanted value
+
Returns this
this
+- unwanted: unknown
- is
Not Equal To(unwanted, name): this Ensures that the object is not equal to
+unwanted.Parameters
- unwanted: unknown
the unwanted value
+ - name: string
the name of the other value
+
Returns this
this
+- unwanted: unknown
is
- is
Not Instance Of<U>(unwanted): this Ensures that the object is not an instance of a class.
+Type Parameters
Parameters
- unwanted: ClassConstructor<U>
the unwanted class
+
Returns this
this
+- unwanted: ClassConstructor<U>
is
- is
Not Null(): UnknownValidator<NonNullable<T>> Ensures that the value is not
+null.+This method should be used to validate method arguments that are assigned to class fields but not +accessed right away (such as constructor and setter arguments). It should also be used to validate any +method arguments when the validator contains +additional contextual information.
Returns UnknownValidator<NonNullable<T>>
this
+
is
- is
Not Undefined(): UnknownValidator<Exclude<T, undefined>> Ensures that the value is not undefined.
++This method should be used to validate method arguments that are assigned to class fields but not +accessed right away (such as constructor and setter arguments). It should also be used to validate any +method arguments when the validator contains +additional contextual information.
Returns UnknownValidator<Exclude<T, undefined>>
this
+
is
- is
Null(): UnknownValidator<null> Ensures that the value is
+null.Returns UnknownValidator<null>
this
+
is
- is
Type(expected): this Ensures that the value has the specified type.
+Parameters
- expected: Type
the expected type of the value
+
Returns this
this
+- expected: Type
is
- is
Undefined(): UnknownValidator<undefined> Ensures that the value is undefined.
+Returns UnknownValidator<undefined>
this
+
keys
- keys(): ArrayValidator<K[], K>
Returns a validator for the map's Map.keys.
+Returns ArrayValidator<K[], K>
a validator for the map's Map.keys
+
size
- size(): UnsignedNumberValidator
Returns a validator for the map's Map.size.
+Returns UnsignedNumberValidator
a validator for the map's Map.size
+
validation
values
- values(): ArrayValidator<V[], V>
Returns a validator for the map's Map.values.
+Returns ArrayValidator<V[], V>
a validator for the map's Map.values
+
with
- with
Context(value, name): this Sets the contextual information for upcoming validations.
++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 override any values that are set using +Validators.withContext. +
+There is no way to remove contextual information from a validator. Thread-level contextual information is +removed automatically.
Parameters
- value: unknown
the value of the entry
+ - name: string
the name of an entry
+
Returns this
this
+- value: unknown
Interface NumberValidator<T>
Validates the state of a number.
and(validation: ((validator: this) => void)): this;
elseGetFailures(): ValidationFailures;
elseThrow(): boolean;
getContext(): Map<string, unknown>;
getContextAsString(): string;
getName(): string;
getValue(): T;
getValueOrDefault(defaultValue: T): T;
getValueOrDefault(defaultValue: null | T): null | T;
isBetween(minimumInclusive: number, maximumExclusive: number): this;
isBetween(minimum: number, minimumInclusive: boolean, maximum: number, maximumInclusive: boolean): this;
isEqualTo(expected: unknown): this;
isEqualTo(expected: unknown, name: string): this;
isFinite(): this;
isGreaterThan(minimumExclusive: number): this;
isGreaterThan(minimumExclusive: number, name: string): this;
isGreaterThanOrEqualTo(minimumInclusive: number): this;
isGreaterThanOrEqualTo(minimumInclusive: number, name: string): this;
isInfinite(): this;
isInstanceOf<U>(expected: ClassConstructor<U>): UnknownValidator<U>;
isLessThan(maximumExclusive: number): this;
isLessThan(maximumExclusive: number, name: string): this;
isLessThanOrEqualTo(maximumInclusive: number): this;
isLessThanOrEqualTo(maximumInclusive: number, name: string): this;
isMultipleOf(factor: number): this;
isMultipleOf(factor: number, name: string): this;
isNegative(): this;
isNotEqualTo(unwanted: unknown): this;
isNotEqualTo(unwanted: unknown, name: string): this;
isNotInstanceOf<U>(unwanted: ClassConstructor<U>): this;
isNotMultipleOf(factor: number): this;
isNotMultipleOf(factor: number, name: string): this;
isNotNegative(): this;
isNotNull(): UnknownValidator<NonNullable<T>>;
isNotNumber(): this;
isNotPositive(): this;
isNotUndefined(): UnknownValidator<Exclude<T, undefined>>;
isNotZero(): this;
isNull(): UnknownValidator<null>;
isNumber(): this;
isPositive(): this;
isType(expected: Type): this;
isUndefined(): UnknownValidator<undefined>;
isZero(): this;
validationFailed(): boolean;
withContext(value: unknown, name: string): this;
}
Type Parameters
Hierarchy (view full)
Index
Methods
Methods
and
- and(validation): this
Facilitates the validation of related properties. For example,
++```ts +requireThat(nameToFrequency, "nameToFrequency"). + and(m => m.size().isPositive()). + and(m => m.keySet().contains("John")); +``` +
+Any changes made during the validation process will impact this validator.
Parameters
- validation: ((validator: this) => void)
the nested validation
+- (validator): void
Parameters
- validator: this
Returns void
Returns this
this
+- validation: ((validator: this) => void)
else
- else
Get Failures(): ValidationFailures Returns the array of failed validations.
+Returns ValidationFailures
an array of failed validations
+
else
get
- get
Context(): Map<string, unknown> Returns the contextual information for upcoming validations carried out by this validator. 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
+
get
get
get
get
- get
Value Or Default(defaultValue): T Returns the value that is being validated.
+Parameters
- defaultValue: T
the fallback value to use if the value is invalid
+
Returns T
the validated value, or
+defaultValueif the value is invalid (e.g. due to dereferencing a +property of anullobject)- defaultValue: T
- get
Value Or Default(defaultValue): null | T Parameters
- defaultValue: null | T
Returns null | T
is
- is
Between(minimumInclusive, maximumExclusive): this Ensures that the value is within a range.
+Parameters
- minimumInclusive: number
the lower bound of the range (inclusive)
+ - maximumExclusive: number
the upper bound of the range (exclusive)
+
Returns this
this
+- minimumInclusive: number
- is
Between(minimum, minimumInclusive, maximum, maximumInclusive): this Ensures that the value is within a range.
+Parameters
- minimum: number
the lower bound of the range
+ - minimumInclusive: boolean
+trueif the lower bound of the range is inclusive - maximum: number
the upper bound of the range
+ - maximumInclusive: boolean
+trueif the upper bound of the range is inclusive
Returns this
this
+Throws
RangeError if
+minimumis greater thanmaximum. If +minimumInclusiveistrue, and the value is less thanminimum. +IfminimumInclusiveisfalse, and the value is less than or equal to +minimum. IfmaximumInclusiveistrueand the value is greater +thanmaximum. IfmaximumInclusiveisfalse, and the value is +greater than or equal tomaximum.- minimum: number
is
- is
Equal To(expected): this Ensures that the object is equal to
+expected.Parameters
- expected: unknown
the expected value
+
Returns this
this
+- expected: unknown
- is
Equal To(expected, name): this Ensures that the object is equal to
+expected.Parameters
- expected: unknown
the expected value
+ - name: string
the name of the expected value
+
Returns this
this
+- expected: unknown
is
is
- is
Greater Than(minimumExclusive): this Ensures that the value is greater than a lower bound.
+Parameters
- minimumExclusive: number
the exclusive lower bound
+
Returns this
this
+- minimumExclusive: number
- is
Greater Than(minimumExclusive, name): this Ensures that the value is greater than a lower bound.
+Parameters
- minimumExclusive: number
the exclusive lower bound
+ - name: string
the name of the lower bound
+
Returns this
this
+- minimumExclusive: number
is
- is
Greater Than Or Equal To(minimumInclusive): this Ensures that the value is greater than or equal to a minimum value.
+Parameters
- minimumInclusive: number
the minimum value
+
Returns this
this
+- minimumInclusive: number
- is
Greater Than Or Equal To(minimumInclusive, name): this Ensures that the value is greater than or equal a minimum value.
+Parameters
- minimumInclusive: number
the minimum value
+ - name: string
the name of the minimum value
+
Returns this
this
+- minimumInclusive: number
is
is
- is
Instance Of<U>(expected): UnknownValidator<U> Ensures that the object is an instance of a class.
+Type Parameters
Parameters
- expected: ClassConstructor<U>
the desired class
+
Returns UnknownValidator<U>
a validator for an object of the desired class
+- expected: ClassConstructor<U>
is
- is
Less Than(maximumExclusive): this Ensures that the value is less than an upper bound.
+Parameters
- maximumExclusive: number
the exclusive upper bound
+
Returns this
this
+- maximumExclusive: number
- is
Less Than(maximumExclusive, name): this Ensures that the value is less than an upper bound.
+Parameters
- maximumExclusive: number
the exclusive upper bound
+ - name: string
the name of the upper bound
+
Returns this
this
+- maximumExclusive: number
is
- is
Less Than Or Equal To(maximumInclusive): this Ensures that the value is less than or equal to a maximum value.
+Parameters
- maximumInclusive: number
the inclusive upper value
+
Returns this
this
+- maximumInclusive: number
- is
Less Than Or Equal To(maximumInclusive, name): this Ensures that the value is less than or equal to a maximum value.
+Parameters
- maximumInclusive: number
the maximum value
+ - name: string
the name of the maximum value
+
Returns this
this
+- maximumInclusive: number
is
- is
Multiple Of(factor): this Ensures that the value is a multiple of
+factor.Parameters
- factor: number
the number being multiplied
+
Returns this
this
+- factor: number
- is
Multiple Of(factor, name): this Ensures that the value is a multiple of
+factor.Parameters
- factor: number
the number being multiplied
+ - name: string
the name of the factor
+
Returns this
this
+- factor: number
is
is
- is
Not Equal To(unwanted): this Ensures that the object is not equal to
+unwanted.Parameters
- unwanted: unknown
the unwanted value
+
Returns this
this
+- unwanted: unknown
- is
Not Equal To(unwanted, name): this Ensures that the object is not equal to
+unwanted.Parameters
- unwanted: unknown
the unwanted value
+ - name: string
the name of the other value
+
Returns this
this
+- unwanted: unknown
is
- is
Not Instance Of<U>(unwanted): this Ensures that the object is not an instance of a class.
+Type Parameters
Parameters
- unwanted: ClassConstructor<U>
the unwanted class
+
Returns this
this
+- unwanted: ClassConstructor<U>
is
- is
Not Multiple Of(factor): this Ensures that the value is not a multiple of
+factor.Parameters
- factor: number
the number being multiplied
+
Returns this
this
+- factor: number
- is
Not Multiple Of(factor, name): this Ensures that the value is not a multiple of
+factor.Parameters
- factor: number
the number being multiplied
+ - name: string
the name of the factor
+
Returns this
this
+- factor: number
is
is
- is
Not Null(): UnknownValidator<NonNullable<T>> Ensures that the value is not
+null.+This method should be used to validate method arguments that are assigned to class fields but not +accessed right away (such as constructor and setter arguments). It should also be used to validate any +method arguments when the validator contains +additional contextual information.
Returns UnknownValidator<NonNullable<T>>
this
+
is
is
is
- is
Not Undefined(): UnknownValidator<Exclude<T, undefined>> Ensures that the value is not undefined.
++This method should be used to validate method arguments that are assigned to class fields but not +accessed right away (such as constructor and setter arguments). It should also be used to validate any +method arguments when the validator contains +additional contextual information.
Returns UnknownValidator<Exclude<T, undefined>>
this
+
is
is
- is
Null(): UnknownValidator<null> Ensures that the value is
+null.Returns UnknownValidator<null>
this
+
is
is
is
- is
Type(expected): this Ensures that the value has the specified type.
+Parameters
- expected: Type
the expected type of the value
+
Returns this
this
+- expected: Type
is
- is
Undefined(): UnknownValidator<undefined> Ensures that the value is undefined.
+Returns UnknownValidator<undefined>
this
+
is
validation
with
- with
Context(value, name): this Sets the contextual information for upcoming validations.
++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 override any values that are set using +Validators.withContext. +
+There is no way to remove contextual information from a validator. Thread-level contextual information is +removed automatically.
Parameters
- value: unknown
the value of the entry
+ - name: string
the name of an entry
+
Returns this
this
+- value: unknown
Interface SetValidator<T, E>
Validates the state of a Set.
and(validation: ((validator: this) => void)): this;
contains(expected: E): this;
contains(expected: E, name: string): this;
containsAll(expected: Set<E>): this;
containsAll(expected: E[]): this;
containsAll(expected: Set<E>, name: string): this;
containsAll(expected: E[], name: string): this;
containsAny(expected: Set<E>): this;
containsAny(expected: E[]): this;
containsAny(expected: Set<E>, name: string): this;
containsAny(expected: E[], name: string): this;
containsExactly(expected: Set<E>): this;
containsExactly(expected: E[]): this;
containsExactly(expected: Set<E>, name: string): this;
containsExactly(expected: E[], name: string): this;
doesNotContain(unwanted: E): this;
doesNotContain(unwanted: E, name: string): this;
doesNotContainAll(unwanted: Set<E>): this;
doesNotContainAll(unwanted: E[]): this;
doesNotContainAll(unwanted: Set<E>, name: string): this;
doesNotContainAll(unwanted: E[], name: string): this;
doesNotContainAny(unwanted: Set<E>): this;
doesNotContainAny(unwanted: E[]): this;
doesNotContainAny(unwanted: Set<E>, name: string): this;
doesNotContainAny(unwanted: E[], name: string): this;
doesNotContainDuplicates(): this;
doesNotContainExactly(unwanted: Set<E>): this;
doesNotContainExactly(unwanted: E[]): this;
doesNotContainExactly(unwanted: Set<E>, name: string): this;
doesNotContainExactly(unwanted: E[], name: string): this;
elseGetFailures(): ValidationFailures;
elseThrow(): boolean;
getContext(): Map<string, unknown>;
getContextAsString(): string;
getName(): string;
getValue(): T;
getValueOrDefault(defaultValue: T): T;
getValueOrDefault(defaultValue: null | T): null | T;
isEmpty(): this;
isEqualTo(expected: unknown): this;
isEqualTo(expected: unknown, name: string): this;
isInstanceOf<U>(expected: ClassConstructor<U>): UnknownValidator<U>;
isNotEmpty(): this;
isNotEqualTo(unwanted: unknown): this;
isNotEqualTo(unwanted: unknown, name: string): this;
isNotInstanceOf<U>(unwanted: ClassConstructor<U>): this;
isNotNull(): UnknownValidator<NonNullable<T>>;
isNotUndefined(): UnknownValidator<Exclude<T, undefined>>;
isNull(): UnknownValidator<null>;
isType(expected: Type): this;
isUndefined(): UnknownValidator<undefined>;
size(): UnsignedNumberValidator;
validationFailed(): boolean;
withContext(value: unknown, name: string): this;
}
Type Parameters
Hierarchy (view full)
- ValidatorComponent<T>
- CollectionComponent<E>
- SetValidator
Index
Methods
Methods
and
- and(validation): this
Facilitates the validation of related properties. For example,
++```ts +requireThat(nameToFrequency, "nameToFrequency"). + and(m => m.size().isPositive()). + and(m => m.keySet().contains("John")); +``` +
+Any changes made during the validation process will impact this validator.
Parameters
- validation: ((validator: this) => void)
the nested validation
+- (validator): void
Parameters
- validator: this
Returns void
Returns this
this
+- validation: ((validator: this) => void)
contains
contains
- contains
All(expected): this Ensures that the collection contains all the elements in
+expected.Returns this
this
+- contains
All(expected): this Ensures that the collection contains all the elements in
+expected.Parameters
- expected: E[]
the desired elements
+
Returns this
this
+- expected: E[]
- contains
All(expected, name): this Ensures that the collection contains all the elements in
+expected.Returns this
this
+- contains
All(expected, name): this Ensures that the collection contains all the elements in
+expected.Parameters
- expected: E[]
the desired elements
+ - name: string
the name of the expected collection
+
Returns this
this
+- expected: E[]
contains
- contains
Any(expected): this Ensures that the collection contains any elements in
+expected.Returns this
this
+- contains
Any(expected): this Ensures that the collection contains any elements in
+expected.Parameters
- expected: E[]
the desired elements
+
Returns this
this
+- expected: E[]
- contains
Any(expected, name): this Ensures that the collection contains at least one element in
+expected.Returns this
this
+- contains
Any(expected, name): this Ensures that the collection contains at least one element in
+expected.Parameters
- expected: E[]
the desired elements
+ - name: string
the name of the expected collection
+
Returns this
this
+- expected: E[]
contains
- contains
Exactly(expected): this Ensures that the collection consists of the same elements as
+expected, irrespective of their +order.+In contrast, isEqualTo() requires the same element ordering.
Returns this
this
+- contains
Exactly(expected): this Ensures that the collection consists of the same elements as
+expected, irrespective of +their order.+In contrast, isEqualTo() requires the same element ordering.
Parameters
- expected: E[]
the desired elements
+
Returns this
this
+- expected: E[]
- contains
Exactly(expected, name): this Ensures that the collection consists of the same elements as
+expected, irrespective of their +order.+In contrast, isEqualTo() requires the same element ordering.
Returns this
this
+- contains
Exactly(expected, name): this Ensures that the collection consists of the same elements as
+expected, irrespective of +their order.+In contrast, isEqualTo() requires the same element ordering.
Parameters
- expected: E[]
the desired elements
+ - name: string
the name of the expected collection
+
Returns this
this
+- expected: E[]
does
- does
Not Contain(unwanted): this Ensures that the collection does not contain
+unwanted.Parameters
- unwanted: E
the unwanted element
+
Returns this
this
+- unwanted: E
- does
Not Contain(unwanted, name): this Ensures that the collection does not contain
+unwanted.Parameters
- unwanted: E
the unwanted element
+ - name: string
the name of the element
+
Returns this
this
+- unwanted: E
does
- does
Not Contain All(unwanted): this Allows the collection to contain some, but not all, elements from a collection.
+Returns this
this
+- does
Not Contain All(unwanted): this Allows the collection to contain some, but not all, elements from a collection.
+Parameters
- unwanted: E[]
the unwanted elements
+
Returns this
this
+- unwanted: E[]
- does
Not Contain All(unwanted, name): this Allows the collection to contain some, but not all, elements from a collection.
+Returns this
this
+- does
Not Contain All(unwanted, name): this Allows the collection to contain some, but not all, elements from a collection.
+Parameters
- unwanted: E[]
the unwanted elements
+ - name: string
the name of the unwanted collection
+
Returns this
this
+- unwanted: E[]
does
- does
Not Contain Any(unwanted): this Ensures that the collection does not contain any of the elements in
+unwanted.Returns this
this
+- does
Not Contain Any(unwanted): this Ensures that the collection does not contain any of the elements in
+unwanted.Parameters
- unwanted: E[]
the unwanted elements
+
Returns this
this
+- unwanted: E[]
- does
Not Contain Any(unwanted, name): this Ensures that the collection does not contain any of the elements in
+unwanted.Returns this
this
+- does
Not Contain Any(unwanted, name): this Ensures that the collection does not contain any of the elements in
+unwanted.Parameters
- unwanted: E[]
the unwanted elements
+ - name: string
the name of the unwanted collection
+
Returns this
this
+- unwanted: E[]
does
does
- does
Not Contain Exactly(unwanted): this Ensures that the collection and
+unwantedconsist of different elements, irrespective of their +order.Returns this
this
+- does
Not Contain Exactly(unwanted): this Ensures that the collection and
+unwantedconsist of different elements, irrespective of their +order.Parameters
- unwanted: E[]
the unwanted elements
+
Returns this
this
+- unwanted: E[]
- does
Not Contain Exactly(unwanted, name): this Ensures that the collection and
+unwantedconsist of different elements, irrespective of +their order.Returns this
this
+- does
Not Contain Exactly(unwanted, name): this Ensures that the collection and
+unwantedconsist of different elements, irrespective of their +order.Parameters
- unwanted: E[]
the unwanted elements
+ - name: string
the name of the unwanted collection
+
Returns this
this
+- unwanted: E[]
else
- else
Get Failures(): ValidationFailures Returns the array of failed validations.
+Returns ValidationFailures
an array of failed validations
+
else
get
- get
Context(): Map<string, unknown> Returns the contextual information for upcoming validations carried out by this validator. 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
+
get
get
get
get
- get
Value Or Default(defaultValue): T Returns the value that is being validated.
+Parameters
- defaultValue: T
the fallback value to use if the value is invalid
+
Returns T
the validated value, or
+defaultValueif the value is invalid (e.g. due to dereferencing a +property of anullobject)- defaultValue: T
- get
Value Or Default(defaultValue): null | T Parameters
- defaultValue: null | T
Returns null | T
is
is
- is
Equal To(expected): this Ensures that the object is equal to
+expected.Parameters
- expected: unknown
the expected value
+
Returns this
this
+- expected: unknown
- is
Equal To(expected, name): this Ensures that the object is equal to
+expected.Parameters
- expected: unknown
the expected value
+ - name: string
the name of the expected value
+
Returns this
this
+- expected: unknown
is
- is
Instance Of<U>(expected): UnknownValidator<U> Ensures that the object is an instance of a class.
+Type Parameters
Parameters
- expected: ClassConstructor<U>
the desired class
+
Returns UnknownValidator<U>
a validator for an object of the desired class
+- expected: ClassConstructor<U>
is
is
- is
Not Equal To(unwanted): this Ensures that the object is not equal to
+unwanted.Parameters
- unwanted: unknown
the unwanted value
+
Returns this
this
+- unwanted: unknown
- is
Not Equal To(unwanted, name): this Ensures that the object is not equal to
+unwanted.Parameters
- unwanted: unknown
the unwanted value
+ - name: string
the name of the other value
+
Returns this
this
+- unwanted: unknown
is
- is
Not Instance Of<U>(unwanted): this Ensures that the object is not an instance of a class.
+Type Parameters
Parameters
- unwanted: ClassConstructor<U>
the unwanted class
+
Returns this
this
+- unwanted: ClassConstructor<U>
is
- is
Not Null(): UnknownValidator<NonNullable<T>> Ensures that the value is not
+null.+This method should be used to validate method arguments that are assigned to class fields but not +accessed right away (such as constructor and setter arguments). It should also be used to validate any +method arguments when the validator contains +additional contextual information.
Returns UnknownValidator<NonNullable<T>>
this
+
is
- is
Not Undefined(): UnknownValidator<Exclude<T, undefined>> Ensures that the value is not undefined.
++This method should be used to validate method arguments that are assigned to class fields but not +accessed right away (such as constructor and setter arguments). It should also be used to validate any +method arguments when the validator contains +additional contextual information.
Returns UnknownValidator<Exclude<T, undefined>>
this
+
is
- is
Null(): UnknownValidator<null> Ensures that the value is
+null.Returns UnknownValidator<null>
this
+
is
- is
Type(expected): this Ensures that the value has the specified type.
+Parameters
- expected: Type
the expected type of the value
+
Returns this
this
+- expected: Type
is
- is
Undefined(): UnknownValidator<undefined> Ensures that the value is undefined.
+Returns UnknownValidator<undefined>
this
+
size
- size(): UnsignedNumberValidator
Returns a validator for the set's size.
+Returns UnsignedNumberValidator
a validator for the set's size
+
validation
with
- with
Context(value, name): this Sets the contextual information for upcoming validations.
++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 override any values that are set using +Validators.withContext. +
+There is no way to remove contextual information from a validator. Thread-level contextual information is +removed automatically.
Parameters
- value: unknown
the value of the entry
+ - name: string
the name of an entry
+
Returns this
this
+- value: unknown
Interface StringValidator<T>
Validates the state of a string.
and(validation: ((validator: this) => void)): this;
contains(expected: string): this;
doesNotContain(unwanted: string): this;
doesNotContainWhitespace(): this;
doesNotEndWith(suffix: string): this;
doesNotStartWith(prefix: string): this;
elseGetFailures(): ValidationFailures;
elseThrow(): boolean;
endsWith(suffix: string): this;
getContext(): Map<string, unknown>;
getContextAsString(): string;
getName(): string;
getValue(): T;
getValueOrDefault(defaultValue: T): T;
getValueOrDefault(defaultValue: null | T): null | T;
isEmpty(): this;
isEqualTo(expected: unknown): this;
isEqualTo(expected: unknown, name: string): this;
isInstanceOf<U>(expected: ClassConstructor<U>): UnknownValidator<U>;
isNotEmpty(): this;
isNotEqualTo(unwanted: unknown): this;
isNotEqualTo(unwanted: unknown, name: string): this;
isNotInstanceOf<U>(unwanted: ClassConstructor<U>): this;
isNotNull(): UnknownValidator<NonNullable<T>>;
isNotUndefined(): UnknownValidator<Exclude<T, undefined>>;
isNull(): UnknownValidator<null>;
isTrimmed(): this;
isType(expected: Type): this;
isUndefined(): UnknownValidator<undefined>;
length(): UnsignedNumberValidator;
matches(regex: RegExp): this;
startsWith(prefix: string): this;
validationFailed(): boolean;
withContext(value: unknown, name: string): this;
}
Type Parameters
Hierarchy (view full)
- ValidatorComponent<T>
- StringValidator
Index
Methods
Methods
and
- and(validation): this
Facilitates the validation of related properties. For example,
++```ts +requireThat(nameToFrequency, "nameToFrequency"). + and(m => m.size().isPositive()). + and(m => m.keySet().contains("John")); +``` +
+Any changes made during the validation process will impact this validator.
Parameters
- validation: ((validator: this) => void)
the nested validation
+- (validator): void
Parameters
- validator: this
Returns void
Returns this
this
+- validation: ((validator: this) => void)
contains
does
does
does
does
else
- else
Get Failures(): ValidationFailures Returns the array of failed validations.
+Returns ValidationFailures
an array of failed validations
+
else
ends
get
- get
Context(): Map<string, unknown> Returns the contextual information for upcoming validations carried out by this validator. 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
+
get
get
get
get
- get
Value Or Default(defaultValue): T Returns the value that is being validated.
+Parameters
- defaultValue: T
the fallback value to use if the value is invalid
+
Returns T
the validated value, or
+defaultValueif the value is invalid (e.g. due to dereferencing a +property of anullobject)- defaultValue: T
- get
Value Or Default(defaultValue): null | T Parameters
- defaultValue: null | T
Returns null | T
is
is
- is
Equal To(expected): this Ensures that the object is equal to
+expected.Parameters
- expected: unknown
the expected value
+
Returns this
this
+- expected: unknown
- is
Equal To(expected, name): this Ensures that the object is equal to
+expected.Parameters
- expected: unknown
the expected value
+ - name: string
the name of the expected value
+
Returns this
this
+- expected: unknown
is
- is
Instance Of<U>(expected): UnknownValidator<U> Ensures that the object is an instance of a class.
+Type Parameters
Parameters
- expected: ClassConstructor<U>
the desired class
+
Returns UnknownValidator<U>
a validator for an object of the desired class
+- expected: ClassConstructor<U>
is
is
- is
Not Equal To(unwanted): this Ensures that the object is not equal to
+unwanted.Parameters
- unwanted: unknown
the unwanted value
+
Returns this
this
+- unwanted: unknown
- is
Not Equal To(unwanted, name): this Ensures that the object is not equal to
+unwanted.Parameters
- unwanted: unknown
the unwanted value
+ - name: string
the name of the other value
+
Returns this
this
+- unwanted: unknown
is
- is
Not Instance Of<U>(unwanted): this Ensures that the object is not an instance of a class.
+Type Parameters
Parameters
- unwanted: ClassConstructor<U>
the unwanted class
+
Returns this
this
+- unwanted: ClassConstructor<U>
is
- is
Not Null(): UnknownValidator<NonNullable<T>> Ensures that the value is not
+null.+This method should be used to validate method arguments that are assigned to class fields but not +accessed right away (such as constructor and setter arguments). It should also be used to validate any +method arguments when the validator contains +additional contextual information.
Returns UnknownValidator<NonNullable<T>>
this
+
is
- is
Not Undefined(): UnknownValidator<Exclude<T, undefined>> Ensures that the value is not undefined.
++This method should be used to validate method arguments that are assigned to class fields but not +accessed right away (such as constructor and setter arguments). It should also be used to validate any +method arguments when the validator contains +additional contextual information.
Returns UnknownValidator<Exclude<T, undefined>>
this
+
is
- is
Null(): UnknownValidator<null> Ensures that the value is
+null.Returns UnknownValidator<null>
this
+
is
is
- is
Type(expected): this Ensures that the value has the specified type.
+Parameters
- expected: Type
the expected type of the value
+
Returns this
this
+- expected: Type
is
- is
Undefined(): UnknownValidator<undefined> Ensures that the value is undefined.
+Returns UnknownValidator<undefined>
this
+
length
- length(): UnsignedNumberValidator
Returns a validator for the length of the string.
+Returns UnsignedNumberValidator
a validator for the length of the string
+
matches
- matches(regex): this
Ensures that the value matches a regular expression.
+Parameters
- regex: RegExp
the regular expression
+
Returns this
this
+- regex: RegExp
starts
validation
with
- with
Context(value, name): this Sets the contextual information for upcoming validations.
++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 override any values that are set using +Validators.withContext. +
+There is no way to remove contextual information from a validator. Thread-level contextual information is +removed automatically.
Parameters
- value: unknown
the value of the entry
+ - name: string
the name of an entry
+
Returns this
this
+- value: unknown
Interface UnsignedNumberValidator
Validates the state of an unsigned number.
and(validation: ((validator: this) => void)): this;
elseGetFailures(): ValidationFailures;
elseThrow(): boolean;
getContext(): Map<string, unknown>;
getContextAsString(): string;
getName(): string;
getValue(): number;
getValueOrDefault(defaultValue: number): number;
getValueOrDefault(defaultValue: null | number): null | number;
isBetween(minimumInclusive: number, maximumExclusive: number): this;
isBetween(minimum: number, minimumInclusive: boolean, maximum: number, maximumInclusive: boolean): this;
isEqualTo(expected: unknown): this;
isEqualTo(expected: unknown, name: string): this;
isFinite(): this;
isGreaterThan(minimumExclusive: number): this;
isGreaterThan(minimumExclusive: number, name: string): this;
isGreaterThanOrEqualTo(minimumInclusive: number): this;
isGreaterThanOrEqualTo(minimumInclusive: number, name: string): this;
isInfinite(): this;
isInstanceOf<U>(expected: ClassConstructor<U>): UnknownValidator<U>;
isLessThan(maximumExclusive: number): this;
isLessThan(maximumExclusive: number, name: string): this;
isLessThanOrEqualTo(maximumInclusive: number): this;
isLessThanOrEqualTo(maximumInclusive: number, name: string): this;
isMultipleOf(factor: number): this;
isMultipleOf(factor: number, name: string): this;
isNotEqualTo(unwanted: unknown): this;
isNotEqualTo(unwanted: unknown, name: string): this;
isNotInstanceOf<U>(unwanted: ClassConstructor<U>): this;
isNotMultipleOf(factor: number): this;
isNotMultipleOf(factor: number, name: string): this;
isNotNull(): UnknownValidator<number>;
isNotNumber(): this;
isNotPositive(): this;
isNotUndefined(): UnknownValidator<number>;
isNotZero(): this;
isNull(): UnknownValidator<null>;
isNumber(): this;
isPositive(): this;
isType(expected: Type): this;
isUndefined(): UnknownValidator<undefined>;
isZero(): this;
validationFailed(): boolean;
withContext(value: unknown, name: string): this;
}
Hierarchy (view full)
- ValidatorComponent<number>
- NumberComponent<number>
- ZeroNumberComponent
- PositiveNumberComponent
- UnsignedNumberValidator
Index
Methods
Methods
and
- and(validation): this
Facilitates the validation of related properties. For example,
++```ts +requireThat(nameToFrequency, "nameToFrequency"). + and(m => m.size().isPositive()). + and(m => m.keySet().contains("John")); +``` +
+Any changes made during the validation process will impact this validator.
Parameters
- validation: ((validator: this) => void)
the nested validation
+- (validator): void
Parameters
- validator: this
Returns void
Returns this
this
+- validation: ((validator: this) => void)
else
- else
Get Failures(): ValidationFailures Returns the array of failed validations.
+Returns ValidationFailures
an array of failed validations
+
else
get
- get
Context(): Map<string, unknown> Returns the contextual information for upcoming validations carried out by this validator. 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
+
get
get
get
get
- get
Value Or Default(defaultValue): number Returns the value that is being validated.
+Parameters
- defaultValue: number
the fallback value to use if the value is invalid
+
Returns number
the validated value, or
+defaultValueif the value is invalid (e.g. due to dereferencing a +property of anullobject)- defaultValue: number
- get
Value Or Default(defaultValue): null | number Parameters
- defaultValue: null | number
Returns null | number
is
- is
Between(minimumInclusive, maximumExclusive): this Ensures that the value is within a range.
+Parameters
- minimumInclusive: number
the lower bound of the range (inclusive)
+ - maximumExclusive: number
the upper bound of the range (exclusive)
+
Returns this
this
+- minimumInclusive: number
- is
Between(minimum, minimumInclusive, maximum, maximumInclusive): this Ensures that the value is within a range.
+Parameters
- minimum: number
the lower bound of the range
+ - minimumInclusive: boolean
+trueif the lower bound of the range is inclusive - maximum: number
the upper bound of the range
+ - maximumInclusive: boolean
+trueif the upper bound of the range is inclusive
Returns this
this
+Throws
RangeError if
+minimumis greater thanmaximum. If +minimumInclusiveistrue, and the value is less thanminimum. +IfminimumInclusiveisfalse, and the value is less than or equal to +minimum. IfmaximumInclusiveistrueand the value is greater +thanmaximum. IfmaximumInclusiveisfalse, and the value is +greater than or equal tomaximum.- minimum: number
is
- is
Equal To(expected): this Ensures that the object is equal to
+expected.Parameters
- expected: unknown
the expected value
+
Returns this
this
+- expected: unknown
- is
Equal To(expected, name): this Ensures that the object is equal to
+expected.Parameters
- expected: unknown
the expected value
+ - name: string
the name of the expected value
+
Returns this
this
+- expected: unknown
is
is
- is
Greater Than(minimumExclusive): this Ensures that the value is greater than a lower bound.
+Parameters
- minimumExclusive: number
the exclusive lower bound
+
Returns this
this
+- minimumExclusive: number
- is
Greater Than(minimumExclusive, name): this Ensures that the value is greater than a lower bound.
+Parameters
- minimumExclusive: number
the exclusive lower bound
+ - name: string
the name of the lower bound
+
Returns this
this
+- minimumExclusive: number
is
- is
Greater Than Or Equal To(minimumInclusive): this Ensures that the value is greater than or equal to a minimum value.
+Parameters
- minimumInclusive: number
the minimum value
+
Returns this
this
+- minimumInclusive: number
- is
Greater Than Or Equal To(minimumInclusive, name): this Ensures that the value is greater than or equal a minimum value.
+Parameters
- minimumInclusive: number
the minimum value
+ - name: string
the name of the minimum value
+
Returns this
this
+- minimumInclusive: number
is
is
- is
Instance Of<U>(expected): UnknownValidator<U> Ensures that the object is an instance of a class.
+Type Parameters
Parameters
- expected: ClassConstructor<U>
the desired class
+
Returns UnknownValidator<U>
a validator for an object of the desired class
+- expected: ClassConstructor<U>
is
- is
Less Than(maximumExclusive): this Ensures that the value is less than an upper bound.
+Parameters
- maximumExclusive: number
the exclusive upper bound
+
Returns this
this
+- maximumExclusive: number
- is
Less Than(maximumExclusive, name): this Ensures that the value is less than an upper bound.
+Parameters
- maximumExclusive: number
the exclusive upper bound
+ - name: string
the name of the upper bound
+
Returns this
this
+- maximumExclusive: number
is
- is
Less Than Or Equal To(maximumInclusive): this Ensures that the value is less than or equal to a maximum value.
+Parameters
- maximumInclusive: number
the inclusive upper value
+
Returns this
this
+- maximumInclusive: number
- is
Less Than Or Equal To(maximumInclusive, name): this Ensures that the value is less than or equal to a maximum value.
+Parameters
- maximumInclusive: number
the maximum value
+ - name: string
the name of the maximum value
+
Returns this
this
+- maximumInclusive: number
is
- is
Multiple Of(factor): this Ensures that the value is a multiple of
+factor.Parameters
- factor: number
the number being multiplied
+
Returns this
this
+- factor: number
- is
Multiple Of(factor, name): this Ensures that the value is a multiple of
+factor.Parameters
- factor: number
the number being multiplied
+ - name: string
the name of the factor
+
Returns this
this
+- factor: number
is
- is
Not Equal To(unwanted): this Ensures that the object is not equal to
+unwanted.Parameters
- unwanted: unknown
the unwanted value
+
Returns this
this
+- unwanted: unknown
- is
Not Equal To(unwanted, name): this Ensures that the object is not equal to
+unwanted.Parameters
- unwanted: unknown
the unwanted value
+ - name: string
the name of the other value
+
Returns this
this
+- unwanted: unknown
is
- is
Not Instance Of<U>(unwanted): this Ensures that the object is not an instance of a class.
+Type Parameters
Parameters
- unwanted: ClassConstructor<U>
the unwanted class
+
Returns this
this
+- unwanted: ClassConstructor<U>
is
- is
Not Multiple Of(factor): this Ensures that the value is not a multiple of
+factor.Parameters
- factor: number
the number being multiplied
+
Returns this
this
+- factor: number
- is
Not Multiple Of(factor, name): this Ensures that the value is not a multiple of
+factor.Parameters
- factor: number
the number being multiplied
+ - name: string
the name of the factor
+
Returns this
this
+- factor: number
is
- is
Not Null(): UnknownValidator<number> Ensures that the value is not
+null.+This method should be used to validate method arguments that are assigned to class fields but not +accessed right away (such as constructor and setter arguments). It should also be used to validate any +method arguments when the validator contains +additional contextual information.
Returns UnknownValidator<number>
this
+
is
is
is
- is
Not Undefined(): UnknownValidator<number> Ensures that the value is not undefined.
++This method should be used to validate method arguments that are assigned to class fields but not +accessed right away (such as constructor and setter arguments). It should also be used to validate any +method arguments when the validator contains +additional contextual information.
Returns UnknownValidator<number>
this
+
is
is
- is
Null(): UnknownValidator<null> Ensures that the value is
+null.Returns UnknownValidator<null>
this
+
is
is
is
- is
Type(expected): this Ensures that the value has the specified type.
+Parameters
- expected: Type
the expected type of the value
+
Returns this
this
+- expected: Type
is
- is
Undefined(): UnknownValidator<undefined> Ensures that the value is undefined.
+Returns UnknownValidator<undefined>
this
+
is
validation
with
- with
Context(value, name): this Sets the contextual information for upcoming validations.
++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 override any values that are set using +Validators.withContext. +
+There is no way to remove contextual information from a validator. Thread-level contextual information is +removed automatically.
Parameters
- value: unknown
the value of the entry
+ - name: string
the name of an entry
+
Returns this
this
+- value: unknown
Interface CollectionComponent<E>
Methods that all collection validators must contain.
+contains(expected: E): this;
contains(expected: E, name: string): this;
containsAll(expected: Set<E>): this;
containsAll(expected: E[]): this;
containsAll(expected: Set<E>, name: string): this;
containsAll(expected: E[], name: string): this;
containsAny(expected: Set<E>): this;
containsAny(expected: E[]): this;
containsAny(expected: Set<E>, name: string): this;
containsAny(expected: E[], name: string): this;
containsExactly(expected: Set<E>): this;
containsExactly(expected: E[]): this;
containsExactly(expected: Set<E>, name: string): this;
containsExactly(expected: E[], name: string): this;
doesNotContain(unwanted: E): this;
doesNotContain(unwanted: E, name: string): this;
doesNotContainAll(unwanted: Set<E>): this;
doesNotContainAll(unwanted: E[]): this;
doesNotContainAll(unwanted: Set<E>, name: string): this;
doesNotContainAll(unwanted: E[], name: string): this;
doesNotContainAny(unwanted: Set<E>): this;
doesNotContainAny(unwanted: E[]): this;
doesNotContainAny(unwanted: Set<E>, name: string): this;
doesNotContainAny(unwanted: E[], name: string): this;
doesNotContainDuplicates(): this;
doesNotContainExactly(unwanted: Set<E>): this;
doesNotContainExactly(unwanted: E[]): this;
doesNotContainExactly(unwanted: Set<E>, name: string): this;
doesNotContainExactly(unwanted: E[], name: string): this;
isEmpty(): this;
isNotEmpty(): this;
size(): UnsignedNumberValidator;
}
Type Parameters
Hierarchy (view full)
- CollectionComponent
Methods
contains
contains
- contains
All(expected): this Ensures that the collection contains all the elements in
+expected.Returns this
this
+- contains
All(expected): this Ensures that the collection contains all the elements in
+expected.Parameters
- expected: E[]
the desired elements
+
Returns this
this
+- expected: E[]
- contains
All(expected, name): this Ensures that the collection contains all the elements in
+expected.Returns this
this
+- contains
All(expected, name): this Ensures that the collection contains all the elements in
+expected.Parameters
- expected: E[]
the desired elements
+ - name: string
the name of the expected collection
+
Returns this
this
+- expected: E[]
contains
- contains
Any(expected): this Ensures that the collection contains any elements in
+expected.Returns this
this
+- contains
Any(expected): this Ensures that the collection contains any elements in
+expected.Parameters
- expected: E[]
the desired elements
+
Returns this
this
+- expected: E[]
- contains
Any(expected, name): this Ensures that the collection contains at least one element in
+expected.Returns this
this
+- contains
Any(expected, name): this Ensures that the collection contains at least one element in
+expected.Parameters
- expected: E[]
the desired elements
+ - name: string
the name of the expected collection
+
Returns this
this
+- expected: E[]
contains
- contains
Exactly(expected): this Ensures that the collection consists of the same elements as
+expected, irrespective of their +order.+In contrast, isEqualTo() requires the same element ordering.
Returns this
this
+- contains
Exactly(expected): this Ensures that the collection consists of the same elements as
+expected, irrespective of +their order.+In contrast, isEqualTo() requires the same element ordering.
Parameters
- expected: E[]
the desired elements
+
Returns this
this
+- expected: E[]
- contains
Exactly(expected, name): this Ensures that the collection consists of the same elements as
+expected, irrespective of their +order.+In contrast, isEqualTo() requires the same element ordering.
Returns this
this
+- contains
Exactly(expected, name): this Ensures that the collection consists of the same elements as
+expected, irrespective of +their order.+In contrast, isEqualTo() requires the same element ordering.
Parameters
- expected: E[]
the desired elements
+ - name: string
the name of the expected collection
+
Returns this
this
+- expected: E[]
does
- does
Not Contain(unwanted): this Ensures that the collection does not contain
+unwanted.Parameters
- unwanted: E
the unwanted element
+
Returns this
this
+- unwanted: E
- does
Not Contain(unwanted, name): this Ensures that the collection does not contain
+unwanted.Parameters
- unwanted: E
the unwanted element
+ - name: string
the name of the element
+
Returns this
this
+- unwanted: E
does
- does
Not Contain All(unwanted): this Allows the collection to contain some, but not all, elements from a collection.
+Returns this
this
+- does
Not Contain All(unwanted): this Allows the collection to contain some, but not all, elements from a collection.
+Parameters
- unwanted: E[]
the unwanted elements
+
Returns this
this
+- unwanted: E[]
- does
Not Contain All(unwanted, name): this Allows the collection to contain some, but not all, elements from a collection.
+Returns this
this
+- does
Not Contain All(unwanted, name): this Allows the collection to contain some, but not all, elements from a collection.
+Parameters
- unwanted: E[]
the unwanted elements
+ - name: string
the name of the unwanted collection
+
Returns this
this
+- unwanted: E[]
does
- does
Not Contain Any(unwanted): this Ensures that the collection does not contain any of the elements in
+unwanted.Returns this
this
+- does
Not Contain Any(unwanted): this Ensures that the collection does not contain any of the elements in
+unwanted.Parameters
- unwanted: E[]
the unwanted elements
+
Returns this
this
+- unwanted: E[]
- does
Not Contain Any(unwanted, name): this Ensures that the collection does not contain any of the elements in
+unwanted.Returns this
this
+- does
Not Contain Any(unwanted, name): this Ensures that the collection does not contain any of the elements in
+unwanted.Parameters
- unwanted: E[]
the unwanted elements
+ - name: string
the name of the unwanted collection
+
Returns this
this
+- unwanted: E[]
does
does
- does
Not Contain Exactly(unwanted): this Ensures that the collection and
+unwantedconsist of different elements, irrespective of their +order.Returns this
this
+- does
Not Contain Exactly(unwanted): this Ensures that the collection and
+unwantedconsist of different elements, irrespective of their +order.Parameters
- unwanted: E[]
the unwanted elements
+
Returns this
this
+- unwanted: E[]
- does
Not Contain Exactly(unwanted, name): this Ensures that the collection and
+unwantedconsist of different elements, irrespective of +their order.Returns this
this
+- does
Not Contain Exactly(unwanted, name): this Ensures that the collection and
+unwantedconsist of different elements, irrespective of their +order.Parameters
- unwanted: E[]
the unwanted elements
+ - name: string
the name of the unwanted collection
+
Returns this
this
+- unwanted: E[]
is
is
size
- size(): UnsignedNumberValidator
Returns a validator for the collection's size.
+Returns UnsignedNumberValidator
a validator for the collection's size
+
Interface NegativeNumberComponent
Methods that validators for numbers that may be negative must contain.
+Hierarchy (view full)
- NegativeNumberComponent
Index
Methods
Interface NumberComponent<T>
Methods that all number validators must contain.
+getValue(): T;
isBetween(minimumInclusive: number, maximumExclusive: number): this;
isBetween(minimum: number, minimumInclusive: boolean, maximum: number, maximumInclusive: boolean): this;
isFinite(): this;
isGreaterThan(minimumExclusive: number): this;
isGreaterThan(minimumExclusive: number, name: string): this;
isGreaterThanOrEqualTo(minimumInclusive: number): this;
isGreaterThanOrEqualTo(minimumInclusive: number, name: string): this;
isInfinite(): this;
isLessThan(maximumExclusive: number): this;
isLessThan(maximumExclusive: number, name: string): this;
isLessThanOrEqualTo(maximumInclusive: number): this;
isLessThanOrEqualTo(maximumInclusive: number, name: string): this;
isMultipleOf(factor: number): this;
isMultipleOf(factor: number, name: string): this;
isNotMultipleOf(factor: number): this;
isNotMultipleOf(factor: number, name: string): this;
isNotNumber(): this;
isNumber(): this;
}
Type Parameters
Hierarchy (view full)
- NumberComponent
Methods
get
is
- is
Between(minimumInclusive, maximumExclusive): this Ensures that the value is within a range.
+Parameters
- minimumInclusive: number
the lower bound of the range (inclusive)
+ - maximumExclusive: number
the upper bound of the range (exclusive)
+
Returns this
this
+- minimumInclusive: number
- is
Between(minimum, minimumInclusive, maximum, maximumInclusive): this Ensures that the value is within a range.
+Parameters
- minimum: number
the lower bound of the range
+ - minimumInclusive: boolean
+trueif the lower bound of the range is inclusive - maximum: number
the upper bound of the range
+ - maximumInclusive: boolean
+trueif the upper bound of the range is inclusive
Returns this
this
+Throws
RangeError if
+minimumis greater thanmaximum. If +minimumInclusiveistrue, and the value is less thanminimum. +IfminimumInclusiveisfalse, and the value is less than or equal to +minimum. IfmaximumInclusiveistrueand the value is greater +thanmaximum. IfmaximumInclusiveisfalse, and the value is +greater than or equal tomaximum.- minimum: number
is
is
- is
Greater Than(minimumExclusive): this Ensures that the value is greater than a lower bound.
+Parameters
- minimumExclusive: number
the exclusive lower bound
+
Returns this
this
+- minimumExclusive: number
- is
Greater Than(minimumExclusive, name): this Ensures that the value is greater than a lower bound.
+Parameters
- minimumExclusive: number
the exclusive lower bound
+ - name: string
the name of the lower bound
+
Returns this
this
+- minimumExclusive: number
is
- is
Greater Than Or Equal To(minimumInclusive): this Ensures that the value is greater than or equal to a minimum value.
+Parameters
- minimumInclusive: number
the minimum value
+
Returns this
this
+- minimumInclusive: number
- is
Greater Than Or Equal To(minimumInclusive, name): this Ensures that the value is greater than or equal a minimum value.
+Parameters
- minimumInclusive: number
the minimum value
+ - name: string
the name of the minimum value
+
Returns this
this
+- minimumInclusive: number
is
is
- is
Less Than(maximumExclusive): this Ensures that the value is less than an upper bound.
+Parameters
- maximumExclusive: number
the exclusive upper bound
+
Returns this
this
+- maximumExclusive: number
- is
Less Than(maximumExclusive, name): this Ensures that the value is less than an upper bound.
+Parameters
- maximumExclusive: number
the exclusive upper bound
+ - name: string
the name of the upper bound
+
Returns this
this
+- maximumExclusive: number
is
- is
Less Than Or Equal To(maximumInclusive): this Ensures that the value is less than or equal to a maximum value.
+Parameters
- maximumInclusive: number
the inclusive upper value
+
Returns this
this
+- maximumInclusive: number
- is
Less Than Or Equal To(maximumInclusive, name): this Ensures that the value is less than or equal to a maximum value.
+Parameters
- maximumInclusive: number
the maximum value
+ - name: string
the name of the maximum value
+
Returns this
this
+- maximumInclusive: number
is
- is
Multiple Of(factor): this Ensures that the value is a multiple of
+factor.Parameters
- factor: number
the number being multiplied
+
Returns this
this
+- factor: number
- is
Multiple Of(factor, name): this Ensures that the value is a multiple of
+factor.Parameters
- factor: number
the number being multiplied
+ - name: string
the name of the factor
+
Returns this
this
+- factor: number
is
- is
Not Multiple Of(factor): this Ensures that the value is not a multiple of
+factor.Parameters
- factor: number
the number being multiplied
+
Returns this
this
+- factor: number
- is
Not Multiple Of(factor, name): this Ensures that the value is not a multiple of
+factor.Parameters
- factor: number
the number being multiplied
+ - name: string
the name of the factor
+
Returns this
this
+- factor: number
is
is
Interface PositiveNumberComponent
Methods that validators for numbers that may be positive must contain.
+Hierarchy (view full)
- PositiveNumberComponent
Index
Methods
Interface ZeroNumberComponent
Methods that validators for numbers that may be zero must contain.
+Hierarchy (view full)
- ZeroNumberComponent
@cowwoc/requirements - v4.0.6
Index
Modules
Module <internal>
Index
Classes
Interfaces
Type Aliases
Module DefaultJavascriptValidators
Index
Modules
Functions
Module GlobalConfiguration
Index
Interfaces
Module JavascriptAssertThat
Index
Interfaces
Module JavascriptCheckIf
Index
Interfaces
Module JavascriptRequireThat
Index
Interfaces
Module JavascriptValidators
Index
Classes
Module MultipleFailuresError
Index
Classes
Module TerminalEncoding
Index
Enumerations
Functions
Module Type
Index
Enumerations
Classes
Module ValidationFailure
Index
Interfaces
Functions
Module ValidationFailures
Index
Classes
Module Validators
Index
Interfaces
Module <internal>
Index
Classes
Interfaces
Module index
Index
References
Modules
Classes
Interfaces
Type Aliases
References
assert
Re-exports assertThatassert
Re-exports assertThatArrayassert
Re-exports assertThatBooleanassert
Re-exports assertThatMapassert
Re-exports assertThatNumberassert
Re-exports assertThatSetassert
Re-exports assertThatStringcheck
Re-exports checkIfcheck
Re-exports checkIfArraycheck
Re-exports checkIfBooleancheck
Re-exports checkIfMapcheck
Re-exports checkIfNumbercheck
Re-exports checkIfSetcheck
Re-exports checkIfStringget
Re-exports getContextGlobal
Re-exports GlobalConfigurationJavascript
Re-exports JavascriptValidatorsremove
Re-exports removeContextrequire
Re-exports requireThatrequire
Re-exports requireThatArrayrequire
Re-exports requireThatBooleanrequire
Re-exports requireThatMaprequire
Re-exports requireThatNumberrequire
Re-exports requireThatSetrequire
Re-exports requireThatStringTerminal
Re-exports TerminalEncodingType
Re-exports TypeType
Re-exports TypeCategoryupdate
Re-exports updateConfigurationValidators
Re-exports Validatorswith
Re-exports withContextType Alias ClassConstructor<T>
Type Parameters
Type Alias StringMapper
Returns the string representation of a value.
+Type declaration
- (value, seen?): string
Parameters
- value: unknown
a value
+ Optionalseen: Set<unknown>the objects that we've seen before
+
Returns string
the string representation of the value
+- value: unknown
Type Alias UnknownValidator<T>
Validates the state of an unknown value or a value that does not have a specialized validator.
+
Validates the state of a value, recording failures without throwing an error.
+