Skip to main content

@sapphire/shapeshift v4.0.0

Enumerations

EnumerationDescription
ObjectValidatorStrategy-

Classes

ClassDescription
ArrayValidator-
BaseConstraintError-
BaseError-
BaseValidator-
BigIntValidator-
BooleanValidator-
CombinedError-
CombinedPropertyError-
DateValidator-
DefaultValidator-
ExpectedConstraintError-
ExpectedValidationError-
InstanceValidator-
LiteralValidator-
MapValidator-
MissingPropertyError-
MultiplePossibilitiesConstraintError-
NativeEnumValidator-
NeverValidator-
NullishValidator-
NumberValidator-
ObjectValidator-
PassthroughValidator-
RecordValidator-
Result-
SetValidator-
Shapes-
StringValidator-
TupleValidator-
TypedArrayValidator-
UnionValidator-
UnknownEnumValueError-
UnknownPropertyError-
ValidationError-

Interfaces

InterfaceDescription
BaseConstraintErrorJsonified-
BaseErrorJsonified-
ExpectedConstraintErrorJsonified-
ExpectedValidationErrorJsonified-
IConstraint-
MissingPropertyErrorJsonified-
MultiplePossibilitiesConstraintErrorJsonified-
NativeEnumLike-
StringUuidOptions-
UnknownEnumKeyErrorJsonified-
UnknownEnumValueErrorJsonified-
UrlOptions-
ValidationErrorJsonified-
ValidatorOptionsAdditional options to pass to the validator.

Type Aliases

Type aliasDescription
ArrayConstraintName-
BigIntConstraintName-
BooleanConstraintName-
ConstraintErrorNames-
Constructor-
DateConstraintName-
ExpandSmallerTuples-
GrowExp-
GrowExpRev-
InferResultType-
InferTypeInfers the type of a schema object given typeof schema.
MappedObjectValidator-
NumberConstraintName-
SchemaOfAn alias of ObjectValidator with a name more common among object validation libraries.
Shift-
StringConstraintName-
StringDomain-
StringProtocol-
Tuple-
Type-
TypedArrayConstraintName-
UUIDVersion-
UndefinedToOptional-
UnshiftTuple-
Unwrap-
UnwrapTuple-
ValidatorError-

Variables

VariableDescription
customInspectSymbol-
customInspectSymbolStackLess-
s-

Functions

FunctionDescription
arrayLengthEqual-
arrayLengthGreaterThan-
arrayLengthGreaterThanOrEqual-
arrayLengthLessThan-
arrayLengthLessThanOrEqual-
arrayLengthNotEqual-
arrayLengthRange-
arrayLengthRangeExclusive-
arrayLengthRangeInclusive-
bigintDivisibleBy-
bigintEqual-
bigintGreaterThan-
bigintGreaterThanOrEqual-
bigintLessThan-
bigintLessThanOrEqual-
bigintNotEqual-
booleanFalse-
booleanTrue-
dateEqual-
dateGreaterThan-
dateGreaterThanOrEqual-
dateInvalid-
dateLessThan-
dateLessThanOrEqual-
dateNotEqual-
dateValid-
getGlobalValidationEnabled-
numberDivisibleBy-
numberEqual-
numberFinite-
numberGreaterThan-
numberGreaterThanOrEqual-
numberInt-
numberLessThan-
numberLessThanOrEqual-
numberNaN-
numberNotEqual-
numberNotNaN-
numberSafeInt-
setGlobalValidationEnabledSets whether validators should run on the input, or if the input should be passed through.
stringEmail-
stringIp-
stringLengthEqual-
stringLengthGreaterThan-
stringLengthGreaterThanOrEqual-
stringLengthLessThan-
stringLengthLessThanOrEqual-
stringLengthNotEqual-
stringRegex-
stringUrl-
stringUuid-
typedArrayByteLengthEqual-
typedArrayByteLengthGreaterThan-
typedArrayByteLengthGreaterThanOrEqual-
typedArrayByteLengthLessThan-
typedArrayByteLengthLessThanOrEqual-
typedArrayByteLengthNotEqual-
typedArrayByteLengthRange-
typedArrayByteLengthRangeExclusive-
typedArrayByteLengthRangeInclusive-
typedArrayLengthEqual-
typedArrayLengthGreaterThan-
typedArrayLengthGreaterThanOrEqual-
typedArrayLengthLessThan-
typedArrayLengthLessThanOrEqual-
typedArrayLengthNotEqual-
typedArrayLengthRange-
typedArrayLengthRangeExclusive-
typedArrayLengthRangeInclusive-