AbstractProtectedconstructorProtectedisWhether the schema requires a non-null/non-undefined value.
Sets the requirement flag. Must be a boolean.
ProtectedpreprocessorsA list of preprocessors associated with the Builder
ProtectedtypeThe string identifier of the schema type (e.g. 'string', 'number', 'object').
Sets the schema type identifier. Must be a non-empty string.
ProtectedvalidatorsA list of validators associated with the Builder
Adds a preprocessor to a preprocessors list
ProtectedassureEnsures a ValidationErrorMessageProvider is valid.
If provider is undefined, falls back to defaultValue.
Function providers are bound to this for access to schema state.
the provider to validate, or undefined
fallback provider when provider is not supplied
a valid ValidationErrorMessageProvider
AbstractclearClears type set by call to .hasType<T>(), default schema type inference will be used
for schema returned by this call.
Remove all preprocessors for this schema.
Remove all validators for this schema.
Protected AbstractcreateProtected method used to create a new instance of the Builder
defined by the props object. Should be used to instantiate new
builders to keep builder's immutability.
arbitrary props object
ProtectedgetResolves a ValidationErrorMessageProvider to a string error message.
Handles both string providers and function providers (sync or async).
the error message provider (string or function)
the value that caused the validation error
the resolved error message string
AbstracthasSet type of schema explicitly. notUsed param is needed only for case when JS is used. E.g. when you
can't call method like schema.hasType<Date>(), so instead you can call schema.hasType(new Date())
with the same result.
OptionalnotUsed: TGenerates a serializable object describing the defined schema
If set to false, schema will be optional (null or undefined values
will be considered as valid).
Array of preprocessor functions
Custom error message provider for the 'is required' validation error.
String id of schema type, e.g. string', numberorobject`.
Array of validator functions
Makes schema optional (consider null and undefined as valid objects for this schema)
ProtectedpreRuns preprocessors, validators, and the required/optional check on object.
Subclasses call this at the start of their validate() implementation to get
a preprocessed value wrapped in a transaction, along with any early errors.
the value to pre-validate
Optionalcontext: ValidationContext<SchemaBuilder<any, any>>optional validation context settings
a PreValidationResult containing the preprocessed transaction, context, and any errors
Makes schema required (consider null and undefined as invalid objects for this schema)
OptionalerrorMessage: ValidationErrorMessageProvider<SchemaBuilder<any, any>>optional custom error message or provider for the 'is required' validation error
AbstractvalidatePerform schema validation on object.
Object to validate
Optionalcontext: ValidationContext<SchemaBuilder<any, any>>Optional ValidationContext settings
Base class for all schema builders. Provides basic functionality for schema building.
Note: this class is not intended to be used directly, use one of the subclasses instead.
Typeparam
TResult Type of the object that will be returned by
validate()method.Typeparam
TRequired If
true, object will be required. Iffalse, object will be optional.