Class: DateValidator
Hierarchy
-
↳
DateValidator
Constructors
constructor
• new DateValidator(constraints?
): DateValidator
Parameters
Name | Type | Default value |
---|---|---|
constraints | readonly IConstraint <Date , Date >[] | [] |
Returns
Inherited from
Defined in
projects/shapeshift/src/validators/BaseValidator.ts:20
Properties
constraints
• Protected
constraints: readonly IConstraint
<Date
, Date
>[] = []
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
Accessors
array
• get
array(): ArrayValidator
<T
[], T
>
Returns
ArrayValidator
<T
[], T
>
Inherited from
BaseValidator.array
Defined in
projects/shapeshift/src/validators/BaseValidator.ts:41
invalid
• get
invalid(): this
Returns
this
Defined in
projects/shapeshift/src/validators/DateValidator.ts:50
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
valid
• get
valid(): this
Returns
this
Defined in
projects/shapeshift/src/validators/DateValidator.ts:46
Methods
addConstraint
▸ addConstraint(constraint
): this
Parameters
Name | Type |
---|---|
constraint | IConstraint <Date , Date > |
Returns
this
Inherited from
Defined in
projects/shapeshift/src/validators/BaseValidator.ts:132
clone
▸ clone(): this
Returns
this
Inherited from
Defined in
projects/shapeshift/src/validators/BaseValidator.ts:124
default
▸ default(value
): DefaultValidator
<Date
>
Parameters
Name | Type |
---|---|
value | Date | () => Date |
Returns
Inherited from
Defined in
projects/shapeshift/src/validators/BaseValidator.ts:65
describe
▸ describe(description
): this
Parameters
Name | Type |
---|---|
description | string |
Returns
this
Inherited from
Defined in
projects/shapeshift/src/validators/BaseValidator.ts:73
equal
▸ equal(date
): this
Parameters
Name | Type |
---|---|
date | string | number | Date |
Returns
this
Defined in
projects/shapeshift/src/validators/DateValidator.ts:32
getValidationEnabled
▸ getValidationEnabled(): null
| boolean
Returns
null
| boolean
Inherited from
BaseValidator.getValidationEnabled
Defined in
projects/shapeshift/src/validators/BaseValidator.ts:116
greaterThan
▸ greaterThan(date
): this
Parameters
Name | Type |
---|---|
date | string | number | Date |
Returns
this
Defined in
projects/shapeshift/src/validators/DateValidator.ts:24
greaterThanOrEqual
▸ greaterThanOrEqual(date
): this
Parameters
Name | Type |
---|---|
date | string | number | Date |
Returns
this
Defined in
projects/shapeshift/src/validators/DateValidator.ts:28
handle
▸ handle(value
): Result
<Date
, ValidationError
>
Parameters
Name | Type |
---|---|
value | unknown |
Returns
Overrides
Defined in
projects/shapeshift/src/validators/DateValidator.ts:54
is
▸ is<R
>(value
): value is R
Type parameters
Name | Type |
---|---|
R | extends Date = Date |
Parameters
Name | Type |
---|---|
value | unknown |
Returns
value is R
Inherited from
Defined in
projects/shapeshift/src/validators/BaseValidator.ts:101
lessThan
▸ lessThan(date
): this
Parameters
Name | Type |
---|---|
date | string | number | Date |
Returns
this
Defined in
projects/shapeshift/src/validators/DateValidator.ts:16
lessThanOrEqual
▸ lessThanOrEqual(date
): this
Parameters
Name | Type |
---|---|
date | string | number | Date |
Returns
this
Defined in
projects/shapeshift/src/validators/DateValidator.ts:20
notEqual
▸ notEqual(date
): this
Parameters
Name | Type |
---|---|
date | string | number | Date |
Returns
this
Defined in
projects/shapeshift/src/validators/DateValidator.ts:39
or
▸ or<O
>(...predicates
): UnionValidator
<Date
| O
>
Type parameters
Name |
---|
O |
Parameters
Name | Type |
---|---|
...predicates | readonly BaseValidator <O >[] |
Returns
UnionValidator
<Date
| O
>
Inherited from
Defined in
projects/shapeshift/src/validators/BaseValidator.ts:49
parse
▸ parse<R
>(value
): R
Type parameters
Name | Type |
---|---|
R | extends Date = Date |
Parameters
Name | Type |
---|---|
value | unknown |
Returns
R
Inherited from
Defined in
projects/shapeshift/src/validators/BaseValidator.ts:91
reshape
▸ reshape(cb
): this
Parameters
Name | Type |
---|---|
cb | (input : Date ) => Result <Date , Error > |
Returns
this
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 : Date ) => R |
Returns
Inherited from
Defined in
projects/shapeshift/src/validators/BaseValidator.ts:60
run
▸ run(value
): Result
<Date
, BaseError
>
Parameters
Name | Type |
---|---|
value | unknown |