Class: StringValidator<T>
Extends
Type Parameters
Type Parameter |
---|
T extends string |
Constructors
new StringValidator()
new StringValidator<
T
>(validatorOptions
:ValidatorOptions
,constraints
: readonlyIConstraint
<T
,T
>[]):StringValidator
<T
>
Parameters
Parameter | Type | Default value |
---|---|---|
validatorOptions | ValidatorOptions | {} |
constraints | readonly IConstraint <T , T >[] | [] |
Returns
Inherited from
Defined in
projects/shapeshift/src/validators/BaseValidator.ts:22
Properties
constraints
protected
constraints: readonlyIConstraint
<T
,T
>[] =[]
Inherited from
Defined in
projects/shapeshift/src/validators/BaseValidator.ts:19
description?
optional
description:string
Inherited from
Defined in
projects/shapeshift/src/validators/BaseValidator.ts:16
isValidationEnabled
protected
isValidationEnabled:null
|boolean
| () =>boolean
=null
Inherited from
BaseValidator
.isValidationEnabled
Defined in
projects/shapeshift/src/validators/BaseValidator.ts:20
parent?
protected
optional
parent:object
Inherited from
Defined in
projects/shapeshift/src/validators/BaseValidator.ts:18
validatorOptions
protected
validatorOptions:ValidatorOptions
Inherited from
BaseValidator
.validatorOptions
Defined in
projects/shapeshift/src/validators/BaseValidator.ts:17
Accessors
shouldRunConstraints
get
protected
shouldRunConstraints():boolean
Returns
boolean
Inherited from
BaseValidator
.shouldRunConstraints
Defined in
projects/shapeshift/src/validators/BaseValidator.ts:143
Methods
addConstraint()
protected
addConstraint(constraint
:IConstraint
<T
,T
>,validatorOptions
:ValidatorOptions
):this
Parameters
Parameter | Type |
---|---|
constraint | IConstraint <T , T > |
validatorOptions | ValidatorOptions |
Returns
this
Inherited from
Defined in
projects/shapeshift/src/validators/BaseValidator.ts:155
array()
array(
options
:ValidatorOptions
):ArrayValidator
<T
[],T
>
Parameters
Parameter | Type |
---|---|
options | ValidatorOptions |
Returns
ArrayValidator
<T
[], T
>
Inherited from
Defined in
projects/shapeshift/src/validators/BaseValidator.ts:44
clone()
protected
clone():this
Returns
this
Inherited from
Defined in
projects/shapeshift/src/validators/BaseValidator.ts:147
date()
date(
options
:ValidatorOptions
):StringValidator
<T
>
Parameters
Parameter | Type |
---|---|
options | ValidatorOptions |
Returns
Defined in
projects/shapeshift/src/validators/StringValidator.ts:81
default()
default(
value
:Exclude
<T
,undefined
> | () =>Exclude
<T
,undefined
>,options
:ValidatorOptions
):DefaultValidator
<Exclude
<T
,undefined
>>
Parameters
Parameter | Type |
---|---|
value | Exclude <T , undefined > | () => Exclude <T , undefined > |
options | ValidatorOptions |
Returns
DefaultValidator
<Exclude
<T
, undefined
>>
Inherited from
Defined in
projects/shapeshift/src/validators/BaseValidator.ts:81
describe()
describe(
description
:string
):this
Parameters
Parameter | Type |
---|---|
description | string |
Returns
this
Inherited from
Defined in
projects/shapeshift/src/validators/BaseValidator.ts:96
email()
email(
options
:ValidatorOptions
):this
Parameters
Parameter | Type |
---|---|
options | ValidatorOptions |
Returns
this
Defined in
projects/shapeshift/src/validators/StringValidator.ts:49
getValidationEnabled()
getValidationEnabled():
null
|boolean
Returns
null
| boolean
Inherited from
BaseValidator
.getValidationEnabled
Defined in
projects/shapeshift/src/validators/BaseValidator.ts:139
handle()
protected
handle(value
:unknown
):Result
<T
,ValidationError
>
Parameters
Parameter | Type |
---|---|
value | unknown |
Returns
Overrides
Defined in
projects/shapeshift/src/validators/StringValidator.ts:101
ip()
ip(
version
?:4
|6
,options
?:ValidatorOptions
):this
Parameters
Parameter | Type |
---|---|
version ? | 4 | 6 |
options ? | ValidatorOptions |
Returns
this
Defined in
projects/shapeshift/src/validators/StringValidator.ts:93
ipv4()
ipv4(
options
:ValidatorOptions
):this
Parameters
Parameter | Type |
---|---|
options | ValidatorOptions |
Returns
this
Defined in
projects/shapeshift/src/validators/StringValidator.ts:85
ipv6()
ipv6(
options
:ValidatorOptions
):this
Parameters
Parameter | Type |
---|---|
options | ValidatorOptions |
Returns
this
Defined in
projects/shapeshift/src/validators/StringValidator.ts:89
is()
is<
R
>(value
:unknown
):value is R
Type Parameters
Type Parameter | Default type |
---|---|
R extends string | T |
Parameters
Parameter | Type |
---|---|
value | unknown |
Returns
value is R
Inherited from
Defined in
projects/shapeshift/src/validators/BaseValidator.ts:124
lengthEqual()
lengthEqual(
length
:number
,options
:ValidatorOptions
):this