Class: TypedArrayValidator<T>
Type parameters
Name | Type |
---|---|
T | extends TypedArray |
Hierarchy
-
↳
TypedArrayValidator
Constructors
constructor
• new TypedArrayValidator<T
>(type
, constraints?
): TypedArrayValidator
<T
>
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 >[] | [] |
Returns
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
• get
shouldRunConstraints(): boolean
Returns
boolean
Inherited from
BaseValidator.shouldRunConstraints
Defined in
projects/shapeshift/src/validators/BaseValidator.ts:120
Methods
addConstraint
▸ 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 |