Class: NativeEnumValidator<T>
Type parameters
Name | Type |
---|---|
T | extends NativeEnumLike |
Hierarchy
-
BaseValidator
<T
[keyofT
]>↳
NativeEnumValidator
Constructors
constructor
• new NativeEnumValidator<T
>(enumShape
): NativeEnumValidator
<T
>
Type parameters
Name | Type |
---|---|
T | extends NativeEnumLike |
Parameters
Name | Type |
---|---|
enumShape | T |
Returns
Overrides
Defined in
projects/shapeshift/src/validators/NativeEnumValidator.ts:12
Properties
constraints
• Protected
constraints: readonly IConstraint
<T
[keyof T
], T
[keyof 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
enumKeys
• Private
Readonly
enumKeys: string
[]
Defined in
projects/shapeshift/src/validators/NativeEnumValidator.ts:9
enumMapping
• Private
Readonly
enumMapping: Map
<string
| number
, T
[keyof T
]>
Defined in
projects/shapeshift/src/validators/NativeEnumValidator.ts:10
enumShape
• Readonly
enumShape: T
Defined in
projects/shapeshift/src/validators/NativeEnumValidator.ts:7
hasNumericElements
• Readonly
hasNumericElements: boolean
= false
Defined in
projects/shapeshift/src/validators/NativeEnumValidator.ts:8
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
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
): NativeEnumValidator
<T
>
Parameters
Name | Type |
---|---|
constraint | IConstraint <T [keyof T ], T [keyof T ]> |
Returns
Inherited from
Defined in
projects/shapeshift/src/validators/BaseValidator.ts:132
clone
▸ clone(): NativeEnumValidator
<T
>
Returns
Overrides
Defined in
projects/shapeshift/src/validators/NativeEnumValidator.ts:54
default
▸ default(value
): DefaultValidator
<Exclude
<T
[keyof T
], undefined
>>
Parameters
Name | Type |
---|---|
value | Exclude <T [keyof T ], undefined > | () => Exclude <T [keyof T ], undefined > |
Returns
DefaultValidator
<Exclude
<T
[keyof T
], undefined
>>
Inherited from
Defined in
projects/shapeshift/src/validators/BaseValidator.ts:65
describe
▸ describe(description
): NativeEnumValidator
<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
▸ handle(value
): Result
<T
[keyof T
], ValidationError
| UnknownEnumValueError
>
Parameters
Name | Type |
---|---|
value | unknown |
Returns
Result
<T
[keyof T
], ValidationError
| UnknownEnumValueError
>
Overrides
Defined in
projects/shapeshift/src/validators/NativeEnumValidator.ts:33
is
▸ is<R
>(value
): value is R
Type parameters
Name | Type |
---|---|
R | extends string | number = T [keyof T ] |
Parameters
Name | Type |
---|---|
value | unknown |
Returns
value is R
Inherited from
Defined in
projects/shapeshift/src/validators/BaseValidator.ts:101
or
▸ or<O
>(...predicates
): UnionValidator
<T
[keyof T
] | O
>
Type parameters
Name |
---|
O |
Parameters
Name | Type |
---|---|
...predicates | readonly BaseValidator <O >[] |
Returns
UnionValidator
<T
[keyof T
] | O
>
Inherited from
Defined in
projects/shapeshift/src/validators/BaseValidator.ts:49
parse
▸ parse<R
>(value
): R
Type parameters
Name | Type |
---|---|
R | extends string | number = T [keyof T ] |
Parameters
Name | Type |
---|---|
value | unknown |
Returns
R
Inherited from
Defined in
projects/shapeshift/src/validators/BaseValidator.ts:91
reshape
▸ reshape(cb
): NativeEnumValidator
<T
>
Parameters
Name | Type |
---|---|
cb | (input : T [keyof T ]) => Result <T [keyof 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 > |
O | InferResultType <R > |
Parameters
Name | Type |
---|---|
cb | (input : T [keyof T ]) => R |
Returns
Inherited from
Defined in
projects/shapeshift/src/validators/BaseValidator.ts:60
run
▸ run(value
): Result
<T
[keyof T
], BaseError
>
Parameters
Name | Type |
---|---|
value | unknown |
Returns
Inherited from
Defined in
projects/shapeshift/src/validators/BaseValidator.ts:79
setParent
▸ setParent(parent
): NativeEnumValidator
<T
>
Parameters
Name | Type |
---|---|
parent | object |
Returns
Inherited from
Defined in
projects/shapeshift/src/validators/BaseValidator.ts:24
setValidationEnabled
▸ setValidationEnabled(isValidationEnabled
): NativeEnumValidator
<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
): NativeEnumValidator
<T
>
Parameters
Name | Type |
---|---|
cb | (value : T [keyof T ]) => T [keyof 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 [keyof T ]) => O |
Returns
Inherited from
Defined in
projects/shapeshift/src/validators/BaseValidator.ts:54
when
▸ when<Key
, This
>(key
, options
): NativeEnumValidator
<T
>
Type parameters
Name | Type |
---|---|
Key | extends WhenKey |
This | extends BaseValidator <any > = NativeEnumValidator <T > |
Parameters
Name | Type |
---|---|
key | Key |
options | WhenOptions <This , Key > |