Class: TypedArrayValidator<T>
Type parameters
Name | Type |
---|---|
T | extends TypedArray |
Hierarchy
↳
TypedArrayValidator
Constructors
constructor
• new TypedArrayValidator<T
>(type
, constraints?
)
Type parameters
Name | Type |
---|---|
T | extends TypedArray |
Parameters
Name | Type | Default value |
---|---|---|
type | "Int8Array" | "Uint8Array" | "Uint8ClampedArray" | "Int16Array" | "Uint16Array" | "Int32Array" | "Uint32Array" | "Float32Array" | "Float64Array" | "BigInt64Array" | "BigUint64Array" | "TypedArray" | undefined |
constraints | readonly IConstraint <T , T >[] | [] |
Overrides
Defined in
projects/shapeshift/src/validators/TypedArrayValidator.ts:31
Properties
constraints
• Protected
constraints: readonly IConstraint
<T
, T
>[] = []
Inherited from
Defined in
projects/shapeshift/src/validators/BaseValidator.ts:17
description
• Optional
description: string
Inherited from
Defined in
projects/shapeshift/src/validators/BaseValidator.ts:15
isValidationEnabled
• Protected
isValidationEnabled: null
| boolean
| () => boolean
= null
Inherited from
BaseValidator.isValidationEnabled
Defined in
projects/shapeshift/src/validators/BaseValidator.ts:18
parent
• Protected
Optional
parent: object
Inherited from
Defined in
projects/shapeshift/src/validators/BaseValidator.ts:16
type
• Private
Readonly
type: "Int8Array"
| "Uint8Array"
| "Uint8ClampedArray"
| "Int16Array"
| "Uint16Array"
| "Int32Array"
| "Uint32Array"
| "Float32Array"
| "Float64Array"
| "BigInt64Array"
| "BigUint64Array"
| "TypedArray"
Defined in
projects/shapeshift/src/validators/TypedArrayValidator.ts:29
Accessors
array
• get
array(): ArrayValidator
<T
[], T
>
Returns
ArrayValidator
<T
[], T
>
Inherited from
BaseValidator.array
Defined in
projects/shapeshift/src/validators/BaseValidator.ts:41
nullable
• get
nullable(): UnionValidator
<null
| T
>
Returns
UnionValidator
<null
| T
>
Inherited from
BaseValidator.nullable
Defined in
projects/shapeshift/src/validators/BaseValidator.ts:33
nullish
• get
nullish(): UnionValidator
<undefined
| null
| T
>
Returns
UnionValidator
<undefined
| null
| T
>
Inherited from
BaseValidator.nullish
Defined in
projects/shapeshift/src/validators/BaseValidator.ts:37
optional
• get
optional(): UnionValidator
<undefined
| T
>
Returns
UnionValidator
<undefined
| T
>
Inherited from
BaseValidator.optional
Defined in
projects/shapeshift/src/validators/BaseValidator.ts:29
set
• get
set(): SetValidator
<T
>
Returns
SetValidator
<T
>
Inherited from
BaseValidator.set
Defined in
projects/shapeshift/src/validators/BaseValidator.ts:45
shouldRunConstraints
• Protected
get
shouldRunConstraints(): boolean
Returns
boolean
Inherited from
BaseValidator.shouldRunConstraints
Defined in
projects/shapeshift/src/validators/BaseValidator.ts:120
Methods
addConstraint
▸ Protected
addConstraint(constraint
): TypedArrayValidator
<T
>
Parameters
Name | Type |
---|---|
constraint | IConstraint <T , T > |
Returns
Inherited from
Defined in
projects/shapeshift/src/validators/BaseValidator.ts:132
byteLengthEqual
▸ byteLengthEqual(length
): TypedArrayValidator
<T
>
Parameters
Name | Type |
---|---|
length | number |
Returns
Defined in
projects/shapeshift/src/validators/TypedArrayValidator.ts:52
byteLengthGreaterThan
▸ byteLengthGreaterThan(length
): TypedArrayValidator
<T
>
Parameters
Name | Type |
---|---|
length | number |
Returns
Defined in
projects/shapeshift/src/validators/TypedArrayValidator.ts:44
byteLengthGreaterThanOrEqual
▸ byteLengthGreaterThanOrEqual(length
): TypedArrayValidator
<T
>
Parameters
Name | Type |
---|---|
length | number |
Returns
Defined in
projects/shapeshift/src/validators/TypedArrayValidator.ts:48
byteLengthLessThan
▸ byteLengthLessThan(length
): TypedArrayValidator
<T
>
Parameters
Name | Type |
---|---|
length | number |
Returns
Defined in
projects/shapeshift/src/validators/TypedArrayValidator.ts:36
byteLengthLessThanOrEqual
▸ byteLengthLessThanOrEqual(length
): TypedArrayValidator
<T
>
Parameters
Name | Type |
---|---|
length | number |
Returns
Defined in
projects/shapeshift/src/validators/TypedArrayValidator.ts:40
byteLengthNotEqual
▸ byteLengthNotEqual(length
): TypedArrayValidator
<T
>
Parameters
Name | Type |
---|---|
length | number |
Returns
Defined in
projects/shapeshift/src/validators/TypedArrayValidator.ts:56
byteLengthRange
▸ byteLengthRange(start
, endBefore
): TypedArrayValidator
<T
>
Parameters
Name | Type |
---|---|
start | number |
endBefore | number |
Returns
Defined in
projects/shapeshift/src/validators/TypedArrayValidator.ts:60
byteLengthRangeExclusive
▸ byteLengthRangeExclusive(startAfter
, endBefore
): TypedArrayValidator
<T
>
Parameters
Name | Type |
---|---|
startAfter | number |
endBefore | number |
Returns
Defined in
projects/shapeshift/src/validators/TypedArrayValidator.ts:68
byteLengthRangeInclusive
▸ byteLengthRangeInclusive(startAt
, endAt
): TypedArrayValidator
<T
>
Parameters
Name | Type |
---|---|
startAt | number |
endAt | number |
Returns
Defined in
projects/shapeshift/src/validators/TypedArrayValidator.ts:64
clone
▸ Protected
clone(): TypedArrayValidator
<T
>
Returns
Overrides
Defined in
projects/shapeshift/src/validators/TypedArrayValidator.ts:108
default
▸ default(value
): DefaultValidator
<Exclude
<T
, undefined
>>
Parameters
Name | Type |
---|---|
value | Exclude <T , undefined > | () => Exclude <T , undefined > |
Returns
DefaultValidator
<Exclude
<T
, undefined
>>
Inherited from
Defined in
projects/shapeshift/src/validators/BaseValidator.ts:65
describe
▸ describe(description
): TypedArrayValidator
<T
>
Parameters
Name | Type |
---|---|
description | string |
Returns
Inherited from
Defined in
projects/shapeshift/src/validators/BaseValidator.ts:73
getValidationEnabled
▸ getValidationEnabled(): null
| boolean
Returns
null
| boolean
Inherited from
BaseValidator.getValidationEnabled
Defined in
projects/shapeshift/src/validators/BaseValidator.ts:116
handle
▸ Protected
handle(value
): Result
<T
, ValidationError
>
Parameters
Name | Type |
---|---|
value | unknown |
Returns
Overrides
Defined in
projects/shapeshift/src/validators/TypedArrayValidator.ts:112
is
▸ is<R
>(value
): value is R
Type parameters
Name | Type |
---|---|
R | extends TypedArray = T |
Parameters
Name | Type |
---|---|
value | unknown |
Returns
value is R
Inherited from
Defined in
projects/shapeshift/src/validators/BaseValidator.ts:101
lengthEqual
▸ lengthEqual(length
): TypedArrayValidator
<T
>
Parameters
Name | Type |
---|---|
length | number |
Returns
Defined in
projects/shapeshift/src/validators/TypedArrayValidator.ts:88
lengthGreaterThan
▸ lengthGreaterThan(length
): TypedArrayValidator
<T
>
Parameters
Name | Type |
---|---|
length | number |
Returns
Defined in
projects/shapeshift/src/validators/TypedArrayValidator.ts:80
lengthGreaterThanOrEqual
▸ lengthGreaterThanOrEqual(length
): TypedArrayValidator
<T
>
Parameters
Name | Type |
---|---|
length | number |
Returns
Defined in
projects/shapeshift/src/validators/TypedArrayValidator.ts:84
lengthLessThan
▸ lengthLessThan(length
): TypedArrayValidator
<T
>
Parameters
Name | Type |
---|---|
length | number |
Returns
Defined in
projects/shapeshift/src/validators/TypedArrayValidator.ts:72
lengthLessThanOrEqual
▸ lengthLessThanOrEqual(length
): TypedArrayValidator
<T
>
Parameters
Name | Type |
---|---|
length | number |
Returns
Defined in
projects/shapeshift/src/validators/TypedArrayValidator.ts:76
lengthNotEqual
▸ lengthNotEqual(length
): TypedArrayValidator
<T
>
Parameters
Name | Type |
---|---|
length | number |
Returns
Defined in
projects/shapeshift/src/validators/TypedArrayValidator.ts:92
lengthRange
▸ lengthRange(start
, endBefore
): TypedArrayValidator
<T
>
Parameters
Name | Type |
---|---|
start | number |
endBefore | number |
Returns
Defined in
projects/shapeshift/src/validators/TypedArrayValidator.ts:96
lengthRangeExclusive
▸ lengthRangeExclusive(startAfter
, endBefore
): TypedArrayValidator
<T
>
Parameters
Name | Type |
---|---|
startAfter | number |
endBefore | number |
Returns
Defined in
projects/shapeshift/src/validators/TypedArrayValidator.ts:104
lengthRangeInclusive
▸ lengthRangeInclusive(startAt
, endAt
): TypedArrayValidator
<T
>
Parameters
Name | Type |
---|---|
startAt | number |
endAt | number |
Returns
Defined in
projects/shapeshift/src/validators/TypedArrayValidator.ts:100
or
▸ or<O
>(...predicates
): UnionValidator
<T
| O
>
Type parameters
Name |
---|
O |
Parameters
Name | Type |
---|---|
...predicates | readonly BaseValidator <O >[] |
Returns
UnionValidator
<T
| O
>
Inherited from
Defined in
projects/shapeshift/src/validators/BaseValidator.ts:49
parse
▸ parse<R
>(value
): R
Type parameters
Name | Type |
---|---|
R | extends TypedArray = T |
Parameters
Name | Type |
---|---|
value | unknown |
Returns
R
Inherited from
Defined in
projects/shapeshift/src/validators/BaseValidator.ts:91
reshape
▸ reshape(cb
): TypedArrayValidator
<T
>
Parameters
Name | Type |
---|---|
cb | (input : T ) => Result <T , Error > |
Returns
Inherited from
Defined in
projects/shapeshift/src/validators/BaseValidator.ts:59
▸ reshape<R
, O
>(cb
): BaseValidator
<O
>
Type parameters
Name | Type |
---|---|
R | extends Result <unknown , Error , R > |
O | InferResultType <R > |
Parameters
Name | Type |
---|---|
cb | (input : T ) => R |
Returns
Inherited from
Defined in
projects/shapeshift/src/validators/BaseValidator.ts:60
run
▸ run(value
): Result
<T
, BaseError
>
Parameters
Name | Type |
---|---|
value | unknown |
Returns
Inherited from
Defined in
projects/shapeshift/src/validators/BaseValidator.ts:79
setParent
▸ setParent(parent
): TypedArrayValidator
<T
>
Parameters
Name | Type |
---|---|
parent | object |
Returns
Inherited from
Defined in
projects/shapeshift/src/validators/BaseValidator.ts:24
setValidationEnabled
▸ setValidationEnabled(isValidationEnabled
): TypedArrayValidator
<T
>
Sets if the validator should also run constraints or just do basic checks.
Parameters
Name | Type | Description |
---|---|---|
isValidationEnabled | null | boolean | () => boolean | Whether this validator should be enabled or disabled. You can pass boolean or a function returning boolean which will be called just before parsing. Set to null to go off of the global configuration. |
Returns
Inherited from
BaseValidator.setValidationEnabled
Defined in
projects/shapeshift/src/validators/BaseValidator.ts:110
transform
▸ transform(cb
): TypedArrayValidator
<T
>
Parameters
Name | Type |
---|---|
cb | (value : T ) => T |
Returns
Inherited from
Defined in
projects/shapeshift/src/validators/BaseValidator.ts:53
▸ transform<O
>(cb
): BaseValidator
<O
>
Type parameters
Name |
---|
O |
Parameters
Name | Type |
---|---|
cb | (value : T ) => O |
Returns
Inherited from
Defined in
projects/shapeshift/src/validators/BaseValidator.ts:54
when
▸ when<Key
, This
>(key
, options
): TypedArrayValidator
<T
>
Type parameters
Name | Type |
---|---|
Key | extends WhenKey |
This | extends BaseValidator <any , This > = TypedArrayValidator <T > |
Parameters
Name | Type |
---|---|
key | Key |
options | WhenOptions <This , Key > |