@sapphire/shapeshift v4.0.0

Enumerations

Enumeration	Description
ObjectValidatorStrategy	-

Classes

Class	Description
BaseError	-
CombinedError	-
CombinedPropertyError	-
ExpectedConstraintError	-
ExpectedValidationError	-
MissingPropertyError	-
MultiplePossibilitiesConstraintError	-
Result	-
UnknownEnumValueError	-
UnknownPropertyError	-
ValidationError	-

Interfaces

Interface	Description
ArrayValidator	-
BaseConstraintError	-
BaseConstraintErrorJsonified	-
BaseErrorJsonified	-
BaseValidator	-
BigIntValidator	-
BooleanValidator	-
DateValidator	-
DefaultValidator	-
ExpectedConstraintErrorJsonified	-
ExpectedValidationErrorJsonified	-
IConstraint	-
InstanceValidator	-
LiteralValidator	-
MapValidator	-
MissingPropertyErrorJsonified	-
MultiplePossibilitiesConstraintErrorJsonified	-
NativeEnumLike	-
NativeEnumValidator	-
NeverValidator	-
NullishValidator	-
NumberValidator	-
ObjectValidator	-
PassthroughValidator	-
RecordValidator	-
SetValidator	-
Shapes	-
StringUuidOptions	-
StringValidator	-
TupleValidator	-
TypedArrayValidator	-
UnionValidator	-
UnknownEnumKeyErrorJsonified	-
UnknownEnumValueErrorJsonified	-
UrlOptions	-
ValidationErrorJsonified	-
ValidatorOptions	Additional options to pass to the validator. Right now this only supports a custom error message, but we provide an option for future expansion.

Type Aliases

Type Alias	Description
ArrayConstraintName	-
arrayLengthEqual	-
arrayLengthGreaterThan	-
arrayLengthGreaterThanOrEqual	-
arrayLengthLessThan	-
arrayLengthLessThanOrEqual	-
arrayLengthNotEqual	-
arrayLengthRange	-
arrayLengthRangeExclusive	-
arrayLengthRangeInclusive	-
BigIntConstraintName	-
bigintDivisibleBy	-
bigintEqual	-
bigintGreaterThan	-
bigintGreaterThanOrEqual	-
bigintLessThan	-
bigintLessThanOrEqual	-
bigintNotEqual	-
BooleanConstraintName	-
booleanFalse	-
booleanTrue	-
ConstraintErrorNames	-
Constructor	-
DateConstraintName	-
dateEqual	-
dateGreaterThan	-
dateGreaterThanOrEqual	-
dateInvalid	-
dateLessThan	-
dateLessThanOrEqual	-
dateNotEqual	-
dateValid	-
ExpandSmallerTuples	-
GrowExp	-
GrowExpRev	-
InferResultType	-
InferType	Infers the type of a schema object given typeof schema. The schema has to extend ObjectValidator.
MappedObjectValidator	-
NumberConstraintName	-
numberDivisibleBy	-
numberEqual	-
numberFinite	-
numberGreaterThan	-
numberGreaterThanOrEqual	-
numberInt	-
numberLessThan	-
numberLessThanOrEqual	-
numberNaN	-
numberNotEqual	-
numberNotNaN	-
numberSafeInt	-
SchemaOf	An alias of ObjectValidator with a name more common among object validation libraries. This is the type of a schema after using s.object({ ... })
Shift	-
StringConstraintName	-
StringDomain	-
stringEmail	-
stringIp	-
stringLengthEqual	-
stringLengthGreaterThan	-
stringLengthGreaterThanOrEqual	-
stringLengthLessThan	-
stringLengthLessThanOrEqual	-
stringLengthNotEqual	-
StringProtocol	-
stringRegex	-
stringUrl	-
stringUuid	-
Tuple	-
Type	-
typedArrayByteLengthEqual	-
typedArrayByteLengthGreaterThan	-
typedArrayByteLengthGreaterThanOrEqual	-
typedArrayByteLengthLessThan	-
typedArrayByteLengthLessThanOrEqual	-
typedArrayByteLengthNotEqual	-
typedArrayByteLengthRange	-
typedArrayByteLengthRangeExclusive	-
typedArrayByteLengthRangeInclusive	-
TypedArrayConstraintName	-
typedArrayLengthEqual	-
typedArrayLengthGreaterThan	-
typedArrayLengthGreaterThanOrEqual	-
typedArrayLengthLessThan	-
typedArrayLengthLessThanOrEqual	-
typedArrayLengthNotEqual	-
typedArrayLengthRange	-
typedArrayLengthRangeExclusive	-
typedArrayLengthRangeInclusive	-
UndefinedToOptional	-
UnshiftTuple	-
Unwrap	-
UnwrapTuple	-
UUIDVersion	-
ValidatorError	-

Variables

Variable	Description
customInspectSymbol	-
customInspectSymbolStackLess	-
s	-

Functions

Function	Description
getGlobalValidationEnabled	-
setGlobalValidationEnabled	Sets whether validators should run on the input, or if the input should be passed through.