@sapphire/shapeshift
Enumerations
Classes
- 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
Type Aliases
ArrayConstraintName
Ƭ ArrayConstraintName: `s.array(T).length${"LessThan" | "LessThanOrEqual" | "GreaterThan" | "GreaterThanOrEqual" | "Equal" | "NotEqual" | "Range" | "RangeInclusive" | "RangeExclusive"}`
Defined in
projects/shapeshift/src/constraints/ArrayLengthConstraints.ts:6
BigIntConstraintName
Ƭ BigIntConstraintName: `s.bigint.${"lessThan" | "lessThanOrEqual" | "greaterThan" | "greaterThanOrEqual" | "equal" | "notEqual" | "divisibleBy"}`
Defined in
projects/shapeshift/src/constraints/BigIntConstraints.ts:6
BooleanConstraintName
Ƭ BooleanConstraintName: `s.boolean.${boolean}`
Defined in
projects/shapeshift/src/constraints/BooleanConstraints.ts:5
ConstraintErrorNames
Ƭ ConstraintErrorNames: TypedArrayConstraintName | ArrayConstraintName | BigIntConstraintName | BooleanConstraintName | DateConstraintName | NumberConstraintName | StringConstraintName
Defined in
projects/shapeshift/src/lib/errors/BaseConstraintError.ts:12
Constructor
Ƭ Constructor<T>: (...args: readonly any[]) => T | (...args: readonly any[]) => T
Type parameters
| Name |
|---|
T |
Defined in
projects/shapeshift/src/lib/util-types.ts:4
DateConstraintName
Ƭ DateConstraintName: `s.date.${"lessThan" | "lessThanOrEqual" | "greaterThan" | "greaterThanOrEqual" | "equal" | "notEqual" | "valid" | "invalid"}`
Defined in
projects/shapeshift/src/constraints/DateConstraints.ts:6
ExpandSmallerTuples
Ƭ ExpandSmallerTuples<T>: T extends [T[0], ...(infer Tail)] ? T | ExpandSmallerTuples<Tail> : []
Type parameters
| Name | Type |
|---|---|
T | extends [...any[]] |
Defined in
projects/shapeshift/src/lib/util-types.ts:110
GrowExp
Ƭ GrowExp<A, N, P>: [...A, ...A][`N`] extends undefined ? GrowExp<[...A, ...A], N, [A, ...P]> : GrowExpRev<A, N, P>
Type parameters
| Name | Type |
|---|---|
A | extends any[] |
N | extends number |
P | extends any[][] |
Defined in
projects/shapeshift/src/lib/util-types.ts:119
GrowExpRev
Ƭ GrowExpRev<A, N, P>: A["length"] extends N ? A : GrowExpRev<[...A, ...P[0]][`N`] extends undefined ? [...A, ...P[0]] : A, N, Shift<P>>
Type parameters
| Name | Type |
|---|---|
A | extends any[] |
N | extends number |
P | extends any[][] |
Defined in
projects/shapeshift/src/lib/util-types.ts:115
InferType
Ƭ InferType<T>: T extends ObjectValidator<any, infer U> ? U : never
Type parameters
| Name | Type |
|---|---|
T | extends ObjectValidator<any> |
Defined in
projects/shapeshift/src/lib/util-types.ts:102
MappedObjectValidator
Ƭ MappedObjectValidator<T>: { [key in keyof T]: BaseValidator<T[key]> }
Type parameters
| Name |
|---|
T |
Defined in
projects/shapeshift/src/lib/util-types.ts:19
NonNullObject
Ƭ NonNullObject: {} & object
Defined in
projects/shapeshift/src/lib/util-types.ts:9
NumberConstraintName
Ƭ NumberConstraintName: `s.number.${"lessThan" | "lessThanOrEqual" | "greaterThan" | "greaterThanOrEqual" | "equal" | "equal(NaN)" | "notEqual" | "notEqual(NaN)" | "int" | "safeInt" | "finite" | "divisibleBy"}`
Defined in
projects/shapeshift/src/constraints/NumberConstraints.ts:6
PickDefined
Ƭ PickDefined<T>: { [K in keyof T as undefined extends T[K] ? never : K]: T[K] }
Type parameters
| Name |
|---|
T |
Defined in
projects/shapeshift/src/lib/util-types.ts:11
PickUndefinedMakeOptional
Ƭ PickUndefinedMakeOptional<T>: { [K in keyof T as undefined extends T[K] ? K : never]?: Exclude<T[K], undefined> }
Type parameters
| Name |
|---|
T |
Defined in
projects/shapeshift/src/lib/util-types.ts:13
SchemaOf
Ƭ SchemaOf<T>: ObjectValidator<T>
Type parameters
| Name |
|---|
T |
Defined in
projects/shapeshift/src/lib/util-types.ts:74
Shift
Ƭ Shift<A>: (...args: A) => void extends (...args: [A[0], ...(infer R)]) => void ? R : never
Type parameters
| Name | Type |
|---|---|
A | extends any[] |
Defined in
projects/shapeshift/src/lib/util-types.ts:113
StringConstraintName
Ƭ StringConstraintName: `s.string.${`length${"LessThan" | "LessThanOrEqual" | "GreaterThan" | "GreaterThanOrEqual" | "Equal" | "NotEqual"}` | "regex" | "url" | "uuid" | "email" | `ip${"v4" | "v6" | ""}` | "date"}`
Defined in
projects/shapeshift/src/constraints/StringConstraints.ts:9
StringDomain
Ƭ StringDomain: `${string}.${string}`
Defined in
projects/shapeshift/src/constraints/StringConstraints.ts:21
StringProtocol
Ƭ StringProtocol: `${string}:`
Defined in
projects/shapeshift/src/constraints/StringConstraints.ts:19
Tuple
Ƭ Tuple<T, N>: number extends N ? T[] : N extends 0 ? [] : N extends 1 ? [T] : GrowExp<[T], N, [[]]>
Type parameters
| Name | Type |
|---|---|
T | T |
N | extends number |
Defined in
projects/shapeshift/src/lib/util-types.ts:123
Type
Ƭ Type<V>: V extends BaseValidator<infer T> ? T : never
Type parameters
| Name |
|---|
V |
Defined in
projects/shapeshift/src/lib/util-types.ts:6
TypedArrayConstraintName
Ƭ TypedArrayConstraintName: `s.typedArray(T).${"byteLength" | "length"}${"LessThan" | "LessThanOrEqual" | "GreaterThan" | "GreaterThanOrEqual" | "Equal" | "NotEqual" | "Range" | "RangeInclusive" | "RangeExclusive"}`
Defined in
projects/shapeshift/src/constraints/TypedArrayLengthConstraints.ts:7
UUIDVersion
Ƭ UUIDVersion: 1 | 3 | 4 | 5
Defined in
projects/shapeshift/src/constraints/StringConstraints.ts:28
UndefinedToOptional
Ƭ UndefinedToOptional<T>: PickDefined<T> & PickUndefinedMakeOptional<T>
Type parameters
| Name |
|---|
T |
Defined in
projects/shapeshift/src/lib/util-types.ts:17
UnshiftTuple
Ƭ UnshiftTuple<T>: T extends [T[0], ...(infer Tail)] ? Tail : never
Type parameters
| Name | Type |
|---|---|
T | extends [...any[]] |
Defined in
projects/shapeshift/src/lib/util-types.ts:109
Unwrap
Ƭ Unwrap<T>: T extends BaseValidator<infer V> ? V : never
Type parameters
| Name |
|---|
T |
Defined in
projects/shapeshift/src/lib/util-types.ts:106
UnwrapTuple
Ƭ UnwrapTuple<T>: T extends [infer Head, ...(infer Tail)] ? [Unwrap<Head>, ...UnwrapTuple<Tail>] : []
Type parameters
| Name | Type |
|---|---|
T | extends [...any[]] |
Defined in
projects/shapeshift/src/lib/util-types.ts:105
ValidatorError
Ƭ ValidatorError: ValidationError | CombinedError | CombinedPropertyError | UnknownEnumValueError
Defined in
projects/shapeshift/src/validators/BaseValidator.ts:110
Variables
booleanFalse
• Const booleanFalse: IConstraint<boolean, false>
Defined in
projects/shapeshift/src/constraints/BooleanConstraints.ts:15
booleanTrue
• Const booleanTrue: IConstraint<boolean, true>
Defined in
projects/shapeshift/src/constraints/BooleanConstraints.ts:7
customInspectSymbol
• Const customInspectSymbol: typeof customInspectSymbol
Defined in
projects/shapeshift/src/lib/errors/BaseError.ts:3
customInspectSymbolStackLess
• Const customInspectSymbolStackLess: typeof customInspectSymbolStackLess
Defined in
projects/shapeshift/src/lib/errors/BaseError.ts:4
dateInvalid
• Const dateInvalid: IConstraint<Date>
Defined in
projects/shapeshift/src/constraints/DateConstraints.ts:56
dateValid
• Const dateValid: IConstraint<Date>
Defined in
projects/shapeshift/src/constraints/DateConstraints.ts:64
numberFinite
• Const numberFinite: IConstraint<number>
Defined in
projects/shapeshift/src/constraints/NumberConstraints.ts:85
numberInt
• Const numberInt: IConstraint<number>
Defined in
projects/shapeshift/src/constraints/NumberConstraints.ts:60
numberNaN
• Const numberNaN: IConstraint<number>
Defined in
projects/shapeshift/src/constraints/NumberConstraints.ts:93
numberNotNaN
• Const numberNotNaN: IConstraint<number>
Defined in
projects/shapeshift/src/constraints/NumberConstraints.ts:101
numberSafeInt
• Const numberSafeInt: IConstraint<number>
Defined in
projects/shapeshift/src/constraints/NumberConstraints.ts:70
s
• Const s: Shapes
Defined in
projects/shapeshift/src/index.ts:3
Functions
arrayLengthEqual
▸ arrayLengthEqual<T>(value): IConstraint<T[]>
Type parameters
| Name |
|---|
T |
Parameters
| Name | Type |
|---|---|
value | number |
Returns
IConstraint<T[]>
Defined in
projects/shapeshift/src/constraints/ArrayLengthConstraints.ts:47
arrayLengthGreaterThan
▸ arrayLengthGreaterThan<T>(value): IConstraint<T[]>
Type parameters
| Name |
|---|
T |
Parameters
| Name | Type |
|---|---|
value | number |
Returns
IConstraint<T[]>
Defined in
projects/shapeshift/src/constraints/ArrayLengthConstraints.ts:37
arrayLengthGreaterThanOrEqual
▸ arrayLengthGreaterThanOrEqual<T>(value): IConstraint<T[]>
Type parameters
| Name |
|---|
T |
Parameters
| Name | Type |
|---|---|
value | number |
Returns
IConstraint<T[]>
Defined in
projects/shapeshift/src/constraints/ArrayLengthConstraints.ts:42
arrayLengthLessThan
▸ arrayLengthLessThan<T>(value): IConstraint<T[]>
Type parameters
| Name |
|---|
T |
Parameters
| Name | Type |
|---|---|
value | number |
Returns
IConstraint<T[]>
Defined in
projects/shapeshift/src/constraints/ArrayLengthConstraints.ts:27
arrayLengthLessThanOrEqual
▸ arrayLengthLessThanOrEqual<T>(value): IConstraint<T[]>
Type parameters
| Name |
|---|
T |
Parameters
| Name | Type |
|---|---|
value | number |
Returns
IConstraint<T[]>
Defined in
projects/shapeshift/src/constraints/ArrayLengthConstraints.ts:32
arrayLengthNotEqual
▸ arrayLengthNotEqual<T>(value): IConstraint<T[]>
Type parameters
| Name |
|---|
T |
Parameters
| Name | Type |
|---|---|
value | number |
Returns
IConstraint<T[]>
Defined in
projects/shapeshift/src/constraints/ArrayLengthConstraints.ts:52
arrayLengthRange
▸ arrayLengthRange<T>(start, endBefore): IConstraint<T[]>
Type parameters
| Name |
|---|
T |
Parameters
| Name | Type |
|---|---|
start | number |
endBefore | number |
Returns
IConstraint<T[]>
Defined in
projects/shapeshift/src/constraints/ArrayLengthConstraints.ts:57
arrayLengthRangeExclusive
▸ arrayLengthRangeExclusive<T>(startAfter, endBefore): IConstraint<T[]>
Type parameters
| Name |
|---|
T |
Parameters
| Name | Type |
|---|---|
startAfter | number |
endBefore | number |
Returns
IConstraint<T[]>
Defined in
projects/shapeshift/src/constraints/ArrayLengthConstraints.ts:79
arrayLengthRangeInclusive
▸ arrayLengthRangeInclusive<T>(start, end): IConstraint<T[]>
Type parameters
| Name |
|---|
T |
Parameters
| Name | Type |
|---|---|
start | number |
end | number |
Returns
IConstraint<T[]>
Defined in
projects/shapeshift/src/constraints/ArrayLengthConstraints.ts:68
bigintDivisibleBy
▸ bigintDivisibleBy(divider): IConstraint<bigint>
Parameters
| Name | Type |
|---|---|
divider | bigint |
Returns
IConstraint<bigint>
Defined in
projects/shapeshift/src/constraints/BigIntConstraints.ts:55
bigintEqual
▸ bigintEqual(value): IConstraint<bigint>
Parameters
| Name | Type |
|---|---|
value | bigint |
Returns
IConstraint<bigint>
Defined in
projects/shapeshift/src/constraints/BigIntConstraints.ts:45
bigintGreaterThan
▸ bigintGreaterThan(value): IConstraint<bigint>
Parameters
| Name | Type |
|---|---|
value | bigint |
Returns
IConstraint<bigint>
Defined in
projects/shapeshift/src/constraints/BigIntConstraints.ts:35
bigintGreaterThanOrEqual
▸ bigintGreaterThanOrEqual(value): IConstraint<bigint>
Parameters
| Name | Type |
|---|---|
value | bigint |
Returns
IConstraint<bigint>
Defined in
projects/shapeshift/src/constraints/BigIntConstraints.ts:40
bigintLessThan
▸ bigintLessThan(value): IConstraint<bigint>
Parameters
| Name | Type |
|---|---|
value | bigint |
Returns
IConstraint<bigint>
Defined in
projects/shapeshift/src/constraints/BigIntConstraints.ts:25
bigintLessThanOrEqual
▸ bigintLessThanOrEqual(value): IConstraint<bigint>
Parameters
| Name | Type |
|---|---|
value | bigint |
Returns
IConstraint<bigint>
Defined in
projects/shapeshift/src/constraints/BigIntConstraints.ts:30
bigintNotEqual
▸ bigintNotEqual(value): IConstraint<bigint>
Parameters
| Name | Type |
|---|---|
value | bigint |
Returns
IConstraint<bigint>
Defined in
projects/shapeshift/src/constraints/BigIntConstraints.ts:50
dateEqual
▸ dateEqual(value): IConstraint<Date>
Parameters
| Name | Type |
|---|---|
value | Date |
Returns
Defined in
projects/shapeshift/src/constraints/DateConstraints.ts:46
dateGreaterThan
▸ dateGreaterThan(value): IConstraint<Date>
Parameters
| Name | Type |
|---|---|
value | Date |
Returns
Defined in
projects/shapeshift/src/constraints/DateConstraints.ts:36
dateGreaterThanOrEqual
▸ dateGreaterThanOrEqual(value): IConstraint<Date>
Parameters
| Name | Type |
|---|---|
value | Date |
Returns
Defined in
projects/shapeshift/src/constraints/DateConstraints.ts:41
dateLessThan
▸ dateLessThan(value): IConstraint<Date>
Parameters
| Name | Type |
|---|---|
value | Date |
Returns
Defined in
projects/shapeshift/src/constraints/DateConstraints.ts:26
dateLessThanOrEqual
▸ dateLessThanOrEqual(value): IConstraint<Date>
Parameters
| Name | Type |
|---|---|
value | Date |
Returns
Defined in
projects/shapeshift/src/constraints/DateConstraints.ts:31
dateNotEqual
▸ dateNotEqual(value): IConstraint<Date>
Parameters
| Name | Type |
|---|---|
value | Date |
Returns
Defined in
projects/shapeshift/src/constraints/DateConstraints.ts:51
getGlobalValidationEnabled
▸ getGlobalValidationEnabled(): boolean
Returns
boolean
Defined in
projects/shapeshift/src/lib/configs.ts:14
numberDivisibleBy
▸ numberDivisibleBy(divider): IConstraint<number>
Parameters
| Name | Type |
|---|---|
divider | number |
Returns
IConstraint<number>
Defined in
projects/shapeshift/src/constraints/NumberConstraints.ts:109
numberEqual
▸ numberEqual(value): IConstraint<number>
Parameters
| Name | Type |
|---|---|
value | number |
Returns
IConstraint<number>
Defined in
projects/shapeshift/src/constraints/NumberConstraints.ts:50
numberGreaterThan
▸ numberGreaterThan(value): IConstraint<number>
Parameters
| Name | Type |
|---|---|
value | number |
Returns
IConstraint<number>
Defined in
projects/shapeshift/src/constraints/NumberConstraints.ts:40
numberGreaterThanOrEqual
▸ numberGreaterThanOrEqual(value): IConstraint<number>
Parameters
| Name | Type |
|---|---|
value | number |
Returns
IConstraint<number>
Defined in
projects/shapeshift/src/constraints/NumberConstraints.ts:45
numberLessThan
▸ numberLessThan(value): IConstraint<number>
Parameters
| Name | Type |
|---|---|
value | number |
Returns
IConstraint<number>
Defined in
projects/shapeshift/src/constraints/NumberConstraints.ts:30
numberLessThanOrEqual
▸ numberLessThanOrEqual(value): IConstraint<number>
Parameters
| Name | Type |
|---|---|
value | number |
Returns
IConstraint<number>
Defined in
projects/shapeshift/src/constraints/NumberConstraints.ts:35
numberNotEqual
▸ numberNotEqual(value): IConstraint<number>
Parameters
| Name | Type |
|---|---|
value | number |
Returns
IConstraint<number>
Defined in
projects/shapeshift/src/constraints/NumberConstraints.ts:55
setGlobalValidationEnabled
▸ setGlobalValidationEnabled(enabled): void
Parameters
| Name | Type | Description |
|---|---|---|
enabled | boolean |
Returns
void
Defined in
projects/shapeshift/src/lib/configs.ts:7
stringEmail
▸ stringEmail(): IConstraint<string>
Returns
IConstraint<string>
Defined in
projects/shapeshift/src/constraints/StringConstraints.ts:75
stringIp
▸ stringIp(version?): IConstraint<string>
Parameters
| Name | Type |
|---|---|
version? | 4 | 6 |
Returns
IConstraint<string>
Defined in
projects/shapeshift/src/constraints/StringConstraints.ts:113
stringLengthEqual
▸ stringLengthEqual(length): IConstraint<string>
Parameters
| Name | Type |
|---|---|
length | number |
Returns
IConstraint<string>
Defined in
projects/shapeshift/src/constraints/StringConstraints.ts:65
stringLengthGreaterThan
▸ stringLengthGreaterThan(length): IConstraint<string>
Parameters
| Name | Type |
|---|---|
length | number |
Returns
IConstraint<string>
Defined in
projects/shapeshift/src/constraints/StringConstraints.ts:55
stringLengthGreaterThanOrEqual
▸ stringLengthGreaterThanOrEqual(length): IConstraint<string>
Parameters
| Name | Type |
|---|---|
length | number |
Returns
IConstraint<string>
Defined in
projects/shapeshift/src/constraints/StringConstraints.ts:60
stringLengthLessThan
▸ stringLengthLessThan(length): IConstraint<string>
Parameters
| Name | Type |
|---|---|
length | number |
Returns
IConstraint<string>
Defined in
projects/shapeshift/src/constraints/StringConstraints.ts:45
stringLengthLessThanOrEqual
▸ stringLengthLessThanOrEqual(length): IConstraint<string>
Parameters
| Name | Type |
|---|---|
length | number |
Returns
IConstraint<string>
Defined in
projects/shapeshift/src/constraints/StringConstraints.ts:50
stringLengthNotEqual
▸ stringLengthNotEqual(length): IConstraint<string>
Parameters
| Name | Type |
|---|---|
length | number |
Returns
IConstraint<string>
Defined in
projects/shapeshift/src/constraints/StringConstraints.ts:70
stringRegex
▸ stringRegex(regex): IConstraint<string, string>
Parameters
| Name | Type |
|---|---|
regex | RegExp |
Returns
IConstraint<string, string>
Defined in
projects/shapeshift/src/constraints/StringConstraints.ts:127
stringUrl
▸ stringUrl(options?): IConstraint<string>
Parameters
| Name | Type |
|---|---|
options? | UrlOptions |
Returns
IConstraint<string>
Defined in
projects/shapeshift/src/constraints/StringConstraints.ts:95
stringUuid
▸ stringUuid(__namedParameters?): IConstraint<string, string>
Parameters
| Name | Type |
|---|---|
__namedParameters | StringUuidOptions |
Returns
IConstraint<string, string>
Defined in
projects/shapeshift/src/constraints/StringConstraints.ts:131
typedArrayByteLengthEqual
▸ typedArrayByteLengthEqual<T>(value): IConstraint<T>
Type parameters
| Name | Type |
|---|---|
T | extends TypedArray |
Parameters
| Name | Type |
|---|---|
value | number |
Returns
IConstraint<T>
Defined in
projects/shapeshift/src/constraints/TypedArrayLengthConstraints.ts:53
typedArrayByteLengthGreaterThan
▸ typedArrayByteLengthGreaterThan<T>(value): IConstraint<T>
Type parameters
| Name | Type |
|---|---|
T | extends TypedArray |
Parameters
| Name | Type |
|---|---|
value | number |
Returns
IConstraint<T>
Defined in
projects/shapeshift/src/constraints/TypedArrayLengthConstraints.ts:43
typedArrayByteLengthGreaterThanOrEqual
▸ typedArrayByteLengthGreaterThanOrEqual<T>(value): IConstraint<T>
Type parameters
| Name | Type |
|---|---|
T | extends TypedArray |
Parameters
| Name | Type |
|---|---|
value | number |
Returns
IConstraint<T>
Defined in
projects/shapeshift/src/constraints/TypedArrayLengthConstraints.ts:48
typedArrayByteLengthLessThan
▸ typedArrayByteLengthLessThan<T>(value): IConstraint<T>
Type parameters
| Name | Type |
|---|---|
T | extends TypedArray |
Parameters
| Name | Type |
|---|---|
value | number |
Returns
IConstraint<T>
Defined in
projects/shapeshift/src/constraints/TypedArrayLengthConstraints.ts:33
typedArrayByteLengthLessThanOrEqual
▸ typedArrayByteLengthLessThanOrEqual<T>(value): IConstraint<T>
Type parameters
| Name | Type |
|---|---|
T | extends TypedArray |
Parameters
| Name | Type |
|---|---|
value | number |
Returns
IConstraint<T>
Defined in
projects/shapeshift/src/constraints/TypedArrayLengthConstraints.ts:38
typedArrayByteLengthNotEqual
▸ typedArrayByteLengthNotEqual<T>(value): IConstraint<T>
Type parameters
| Name | Type |
|---|---|
T | extends TypedArray |
Parameters
| Name | Type |
|---|---|
value | number |
Returns
IConstraint<T>
Defined in
projects/shapeshift/src/constraints/TypedArrayLengthConstraints.ts:58
typedArrayByteLengthRange
▸ typedArrayByteLengthRange<T>(start, endBefore): IConstraint<T>
Type parameters
| Name | Type |
|---|---|
T | extends TypedArray |
Parameters
| Name | Type |
|---|---|
start | number |
endBefore | number |
Returns
IConstraint<T>
Defined in
projects/shapeshift/src/constraints/TypedArrayLengthConstraints.ts:63
typedArrayByteLengthRangeExclusive
▸ typedArrayByteLengthRangeExclusive<T>(startAfter, endBefore): IConstraint<T>
Type parameters
| Name | Type |
|---|---|
T | extends TypedArray |
Parameters
| Name | Type |
|---|---|
startAfter | number |
endBefore | number |
Returns
IConstraint<T>
Defined in
projects/shapeshift/src/constraints/TypedArrayLengthConstraints.ts:87
typedArrayByteLengthRangeInclusive
▸ typedArrayByteLengthRangeInclusive<T>(start, end): Object
Type parameters
| Name | Type |
|---|---|
T | extends TypedArray |
Parameters
| Name | Type |
|---|---|
start | number |
end | number |
Returns
Object
| Name | Type |
|---|---|
run | (input: T) => Result<T, Error> | Result<unknown, ExpectedConstraintError<T>> |
Defined in
projects/shapeshift/src/constraints/TypedArrayLengthConstraints.ts:74
typedArrayLengthEqual
▸ typedArrayLengthEqual<T>(value): IConstraint<T>
Type parameters
| Name | Type |
|---|---|
T | extends TypedArray |
Parameters
| Name | Type |
|---|---|
value | number |
Returns
IConstraint<T>
Defined in
projects/shapeshift/src/constraints/TypedArrayLengthConstraints.ts:135
typedArrayLengthGreaterThan
▸ typedArrayLengthGreaterThan<T>(value): IConstraint<T>
Type parameters
| Name | Type |
|---|---|
T | extends TypedArray |
Parameters
| Name | Type |
|---|---|
value | number |
Returns
IConstraint<T>
Defined in
projects/shapeshift/src/constraints/TypedArrayLengthConstraints.ts:125
typedArrayLengthGreaterThanOrEqual
▸ typedArrayLengthGreaterThanOrEqual<T>(value): IConstraint<T>
Type parameters
| Name | Type |
|---|---|
T | extends TypedArray |
Parameters
| Name | Type |
|---|---|
value | number |
Returns
IConstraint<T>
Defined in
projects/shapeshift/src/constraints/TypedArrayLengthConstraints.ts:130
typedArrayLengthLessThan
▸ typedArrayLengthLessThan<T>(value): IConstraint<T>
Type parameters
| Name | Type |
|---|---|
T | extends TypedArray |
Parameters
| Name | Type |
|---|---|
value | number |
Returns
IConstraint<T>
Defined in
projects/shapeshift/src/constraints/TypedArrayLengthConstraints.ts:115
typedArrayLengthLessThanOrEqual
▸ typedArrayLengthLessThanOrEqual<T>(value): IConstraint<T>
Type parameters
| Name | Type |
|---|---|
T | extends TypedArray |
Parameters
| Name | Type |
|---|---|
value | number |
Returns
IConstraint<T>
Defined in
projects/shapeshift/src/constraints/TypedArrayLengthConstraints.ts:120
typedArrayLengthNotEqual
▸ typedArrayLengthNotEqual<T>(value): IConstraint<T>
Type parameters
| Name | Type |
|---|---|
T | extends TypedArray |
Parameters
| Name | Type |
|---|---|
value | number |
Returns
IConstraint<T>
Defined in
projects/shapeshift/src/constraints/TypedArrayLengthConstraints.ts:140
typedArrayLengthRange
▸ typedArrayLengthRange<T>(start, endBefore): IConstraint<T>
Type parameters
| Name | Type |
|---|---|
T | extends TypedArray |
Parameters
| Name | Type |
|---|---|
start | number |
endBefore | number |
Returns
IConstraint<T>
Defined in
projects/shapeshift/src/constraints/TypedArrayLengthConstraints.ts:145
typedArrayLengthRangeExclusive
▸ typedArrayLengthRangeExclusive<T>(startAfter, endBefore): IConstraint<T>
Type parameters
| Name | Type |
|---|---|
T | extends TypedArray |
Parameters
| Name | Type |
|---|---|
startAfter | number |
endBefore | number |
Returns
IConstraint<T>
Defined in
projects/shapeshift/src/constraints/TypedArrayLengthConstraints.ts:167
typedArrayLengthRangeInclusive
▸ typedArrayLengthRangeInclusive<T>(start, end): IConstraint<T>
Type parameters
| Name | Type |
|---|---|
T | extends TypedArray |
Parameters
| Name | Type |
|---|---|
start | number |
end | number |
Returns
IConstraint<T>
Defined in
projects/shapeshift/src/constraints/TypedArrayLengthConstraints.ts:156