Class: StringValidator<T>
Type parameters
Name | Type |
---|---|
T | extends string |
Hierarchy
↳
StringValidator
Constructors
constructor
• new StringValidator<T
>(constraints?
)
Type parameters
Name | Type |
---|---|
T | extends string |
Parameters
Name | Type | Default value |
---|---|---|
constraints | readonly IConstraint <T , T >[] | [] |
Inherited from
Defined in
projects/shapeshift/src/validators/BaseValidator.ts:13
Properties
constraints
• Protected
constraints: readonly IConstraint
<T
, T
>[] = []
Inherited from
Defined in
projects/shapeshift/src/validators/BaseValidator.ts:11
Accessors
array
• get
array(): ArrayValidator
<T
>
Returns
Inherited from
BaseValidator.array
Defined in
projects/shapeshift/src/validators/BaseValidator.ts:29
date
• get
date(): this
Returns
this
Defined in
projects/shapeshift/src/validators/StringValidator.ts:63
email
• get
email(): this
Returns
this
Defined in
projects/shapeshift/src/validators/StringValidator.ts:47
ipv4
• get
ipv4(): this
Returns
this
Defined in
projects/shapeshift/src/validators/StringValidator.ts:67
ipv6
• get
ipv6(): this
Returns
this
Defined in
projects/shapeshift/src/validators/StringValidator.ts:71
nullable
• get
nullable(): UnionValidator
<null
| T
>
Returns
UnionValidator
<null
| T
>
Inherited from
BaseValidator.nullable
Defined in
projects/shapeshift/src/validators/BaseValidator.ts:21
nullish
• get
nullish(): UnionValidator
<undefined
| null
| T
>
Returns
UnionValidator
<undefined
| null
| T
>
Inherited from
BaseValidator.nullish
Defined in
projects/shapeshift/src/validators/BaseValidator.ts:25
optional
• get
optional(): UnionValidator
<undefined
| T
>
Returns
UnionValidator
<undefined
| T
>
Inherited from
BaseValidator.optional
Defined in
projects/shapeshift/src/validators/BaseValidator.ts:17
set
• get
set(): SetValidator
<T
>
Returns
SetValidator
<T
>
Inherited from
BaseValidator.set
Defined in
projects/shapeshift/src/validators/BaseValidator.ts:33
Methods
addConstraint
▸ Protected
addConstraint(constraint
): StringValidator
<T
>
Parameters
Name | Type |
---|---|
constraint | IConstraint <T , T > |
Returns
Inherited from
Defined in
projects/shapeshift/src/validators/BaseValidator.ts:73
clone
▸ Protected
clone(): StringValidator
<T
>
Returns
Inherited from
Defined in
projects/shapeshift/src/validators/BaseValidator.ts:67
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:47
handle
▸ Protected
handle(value
): Result
<T
, ValidationError
>
Parameters
Name | Type |
---|---|
value | unknown |
Returns
Overrides
Defined in
projects/shapeshift/src/validators/StringValidator.ts:79
ip
▸ ip(version?
): StringValidator
<T
>
Parameters
Name | Type |
---|---|
version? | 4 | 6 |
Returns
Defined in
projects/shapeshift/src/validators/StringValidator.ts:75
lengthEqual
▸ lengthEqual(length
): StringValidator
<T
>
Parameters
Name | Type |
---|---|
length | number |
Returns
Defined in
projects/shapeshift/src/validators/StringValidator.ts:39
lengthGreaterThan
▸ lengthGreaterThan(length
): StringValidator
<T
>
Parameters
Name | Type |
---|---|
length | number |
Returns
Defined in
projects/shapeshift/src/validators/StringValidator.ts:31
lengthGreaterThanOrEqual
▸ lengthGreaterThanOrEqual(length
): StringValidator
<T
>
Parameters
Name | Type |
---|---|
length | number |
Returns
Defined in
projects/shapeshift/src/validators/StringValidator.ts:35
lengthLessThan
▸ lengthLessThan(length
): StringValidator
<T
>
Parameters
Name | Type |
---|---|
length | number |
Returns
Defined in
projects/shapeshift/src/validators/StringValidator.ts:23
lengthLessThanOrEqual
▸ lengthLessThanOrEqual(length
): StringValidator
<T
>
Parameters
Name | Type |
---|---|
length | number |
Returns
Defined in
projects/shapeshift/src/validators/StringValidator.ts:27
lengthNotEqual
▸ lengthNotEqual(length
): StringValidator
<T
>
Parameters
Name | Type |
---|---|
length | number |
Returns
Defined in
projects/shapeshift/src/validators/StringValidator.ts:43
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:37
parse
▸ parse(value
): T
Parameters
Name | Type |
---|---|
value | unknown |
Returns
T
Inherited from
Defined in
projects/shapeshift/src/validators/BaseValidator.ts:63
regex
▸ regex(regex
): StringValidator
<T
>
Parameters
Name | Type |
---|---|
regex | RegExp |
Returns
Defined in
projects/shapeshift/src/validators/StringValidator.ts:59
run
▸ run(value
): Result
<T
, BaseError
>
Parameters
Name | Type |
---|---|
value | unknown |
Returns
Inherited from
Defined in
projects/shapeshift/src/validators/BaseValidator.ts:51
transform
▸ transform(cb
): StringValidator
<T
>
Parameters
Name | Type |
---|---|
cb | (value : T ) => T |
Returns
Inherited from
Defined in
projects/shapeshift/src/validators/BaseValidator.ts:41
▸ 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:42
url
▸ url(options?
): StringValidator
<T
>
Parameters
Name | Type |
---|---|
options? | UrlOptions |
Returns
Defined in
projects/shapeshift/src/validators/StringValidator.ts:51
uuid
▸ uuid(options?
): StringValidator
<T
>
Parameters
Name | Type |
---|---|
options? | StringUuidOptions |