Skip to main content

Class: StringValidator<T>

Type parameters

NameType
Textends string

Hierarchy

Constructors

constructor

new StringValidator<T>(constraints?)

Type parameters

NameType
Textends string

Parameters

NameTypeDefault value
constraintsreadonly IConstraint<T, T>[][]

Inherited from

BaseValidator.constructor

Defined in

projects/shapeshift/src/validators/BaseValidator.ts:16

Properties

constraints

Protected constraints: readonly IConstraint<T, T>[] = []

Inherited from

BaseValidator.constraints

Defined in

projects/shapeshift/src/validators/BaseValidator.ts:13


isValidationEnabled

Protected isValidationEnabled: null | boolean | () => boolean = null

Inherited from

BaseValidator.isValidationEnabled

Defined in

projects/shapeshift/src/validators/BaseValidator.ts:14

Accessors

array

get array(): ArrayValidator<T[], T>

Returns

ArrayValidator<T[], T>

Inherited from

BaseValidator.array

Defined in

projects/shapeshift/src/validators/BaseValidator.ts:32


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:24


nullish

get nullish(): UnionValidator<undefined | null | T>

Returns

UnionValidator<undefined | null | T>

Inherited from

BaseValidator.nullish

Defined in

projects/shapeshift/src/validators/BaseValidator.ts:28


optional

get optional(): UnionValidator<undefined | T>

Returns

UnionValidator<undefined | T>

Inherited from

BaseValidator.optional

Defined in

projects/shapeshift/src/validators/BaseValidator.ts:20


set

get set(): SetValidator<T>

Returns

SetValidator<T>

Inherited from

BaseValidator.set

Defined in

projects/shapeshift/src/validators/BaseValidator.ts:36


shouldRunConstraints

Protected get shouldRunConstraints(): boolean

Returns

boolean

Inherited from

BaseValidator.shouldRunConstraints

Defined in

projects/shapeshift/src/validators/BaseValidator.ts:91

Methods

addConstraint

Protected addConstraint(constraint): StringValidator<T>

Parameters

NameType
constraintIConstraint<T, T>

Returns

StringValidator<T>

Inherited from

BaseValidator.addConstraint

Defined in

projects/shapeshift/src/validators/BaseValidator.ts:103


clone

Protected clone(): StringValidator<T>

Returns

StringValidator<T>

Inherited from

BaseValidator.clone

Defined in

projects/shapeshift/src/validators/BaseValidator.ts:95


default

default(value): DefaultValidator<Exclude<T, undefined>>

Parameters

NameType
valueExclude<T, undefined> | () => Exclude<T, undefined>

Returns

DefaultValidator<Exclude<T, undefined>>

Inherited from

BaseValidator.default

Defined in

projects/shapeshift/src/validators/BaseValidator.ts:50


getValidationEnabled

getValidationEnabled(): null | boolean

Returns

null | boolean

Inherited from

BaseValidator.getValidationEnabled

Defined in

projects/shapeshift/src/validators/BaseValidator.ts:87


handle

Protected handle(value): Result<T, ValidationError>

Parameters

NameType
valueunknown

Returns

Result<T, ValidationError>

Overrides

BaseValidator.handle

Defined in

projects/shapeshift/src/validators/StringValidator.ts:79


ip

ip(version?): StringValidator<T>

Parameters

NameType
version?4 | 6

Returns

StringValidator<T>

Defined in

projects/shapeshift/src/validators/StringValidator.ts:75


lengthEqual

lengthEqual(length): StringValidator<T>

Parameters

NameType
lengthnumber

Returns

StringValidator<T>

Defined in

projects/shapeshift/src/validators/StringValidator.ts:39


lengthGreaterThan

lengthGreaterThan(length): StringValidator<T>

Parameters

NameType
lengthnumber

Returns

StringValidator<T>

Defined in

projects/shapeshift/src/validators/StringValidator.ts:31


lengthGreaterThanOrEqual

lengthGreaterThanOrEqual(length): StringValidator<T>

Parameters

NameType
lengthnumber

Returns

StringValidator<T>

Defined in

projects/shapeshift/src/validators/StringValidator.ts:35


lengthLessThan

lengthLessThan(length): StringValidator<T>

Parameters

NameType
lengthnumber

Returns

StringValidator<T>

Defined in

projects/shapeshift/src/validators/StringValidator.ts:23


lengthLessThanOrEqual

lengthLessThanOrEqual(length): StringValidator<T>

Parameters

NameType
lengthnumber

Returns

StringValidator<T>

Defined in

projects/shapeshift/src/validators/StringValidator.ts:27


lengthNotEqual

lengthNotEqual(length): StringValidator<T>

Parameters

NameType
lengthnumber

Returns

StringValidator<T>

Defined in

projects/shapeshift/src/validators/StringValidator.ts:43


or

or<O>(...predicates): UnionValidator<T | O>

Type parameters

Name
O

Parameters

NameType
...predicatesreadonly BaseValidator<O>[]

Returns

UnionValidator<T | O>

Inherited from

BaseValidator.or

Defined in

projects/shapeshift/src/validators/BaseValidator.ts:40


parse

parse<R>(value): R

Type parameters

NameType
Rextends string = T

Parameters

NameType
valueunknown

Returns

R

Inherited from

BaseValidator.parse

Defined in

projects/shapeshift/src/validators/BaseValidator.ts:66


regex

regex(regex): StringValidator<T>

Parameters

NameType
regexRegExp

Returns

StringValidator<T>

Defined in

projects/shapeshift/src/validators/StringValidator.ts:59


run

run(value): Result<T, BaseError>

Parameters

NameType
valueunknown

Returns

Result<T, BaseError>

Inherited from

BaseValidator.run

Defined in

projects/shapeshift/src/validators/BaseValidator.ts:54


setValidationEnabled

setValidationEnabled(isValidationEnabled): StringValidator<T>

Parameters

NameTypeDescription
isValidationEnablednull | boolean | () => boolean

Returns

StringValidator<T>

Inherited from

BaseValidator.setValidationEnabled

Defined in

projects/shapeshift/src/validators/BaseValidator.ts:81


transform

transform(cb): StringValidator<T>

Parameters

NameType
cb(value: T) => T

Returns

StringValidator<T>

Inherited from

BaseValidator.transform

Defined in

projects/shapeshift/src/validators/BaseValidator.ts:44

transform<O>(cb): BaseValidator<O>

Type parameters

Name
O

Parameters

NameType
cb(value: T) => O

Returns

BaseValidator<O>

Inherited from

BaseValidator.transform

Defined in

projects/shapeshift/src/validators/BaseValidator.ts:45


url

url(options?): StringValidator<T>

Parameters

NameType
options?UrlOptions

Returns

StringValidator<T>

Defined in

projects/shapeshift/src/validators/StringValidator.ts:51


uuid

uuid(options?): StringValidator<T>

Parameters

NameType
options?StringUuidOptions

Returns

StringValidator<T>

Defined in

projects/shapeshift/src/validators/StringValidator.ts:55