Class: StringValidator<T>

Extends

• BaseValidator<T>

Type Parameters

Type Parameter
T extends string

Constructors

new StringValidator()

new StringValidator<T>(validatorOptions: ValidatorOptions, constraints: readonly IConstraint<T, T>[]): StringValidator<T>

Parameters

Parameter	Type	Default value
validatorOptions	ValidatorOptions	{}
constraints	readonly IConstraint<T, T>[]	[]

Returns

StringValidator<T>

Inherited from

BaseValidator.constructor

Defined in

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

Properties

constraints

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

Inherited from

BaseValidator.constraints

Defined in

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

---

description?

optional description: string

Inherited from

BaseValidator.description

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

BaseValidator.parent

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 Signature

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

BaseValidator.addConstraint

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

BaseValidator.array

Defined in

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

---

clone()

protected clone(): this

Returns

this

Inherited from

BaseValidator.clone

Defined in

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

---

date()

date(options: ValidatorOptions): StringValidator<T>

Parameters

Parameter	Type
options	ValidatorOptions

Returns

StringValidator<T>

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

BaseValidator.default

Defined in

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

---

describe()

describe(description: string): this

Parameters

Parameter	Type
description	string

Returns

this

Inherited from

BaseValidator.describe

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

Result<T, ValidationError>

Overrides

BaseValidator.handle

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

BaseValidator.is

Defined in

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

---

lengthEqual()

lengthEqual(length: number, options: ValidatorOptions): this

Parameters

Parameter	Type
length	number
options	ValidatorOptions

Returns

this

Defined in

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

---

lengthGreaterThan()

lengthGreaterThan(length: number, options: ValidatorOptions): this

Parameters

Parameter	Type
length	number
options	ValidatorOptions

Returns

this

Defined in

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

---

lengthGreaterThanOrEqual()

lengthGreaterThanOrEqual(length: number, options: ValidatorOptions): this

Parameters

Parameter	Type
length	number
options	ValidatorOptions

Returns

this

Defined in

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

---

lengthLessThan()

lengthLessThan(length: number, options: ValidatorOptions): this

Parameters

Parameter	Type
length	number
options	ValidatorOptions

Returns

this

Defined in

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

---

lengthLessThanOrEqual()

lengthLessThanOrEqual(length: number, options: ValidatorOptions): this

Parameters

Parameter	Type
length	number
options	ValidatorOptions

Returns

this

Defined in

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

---

lengthNotEqual()

lengthNotEqual(length: number, options: ValidatorOptions): this

Parameters

Parameter	Type
length	number
options	ValidatorOptions

Returns

this

Defined in

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

---

nullable()

nullable(options: ValidatorOptions): UnionValidator<null | T>

Parameters

Parameter	Type
options	ValidatorOptions

Returns

UnionValidator<null | T>

Inherited from

BaseValidator.nullable

Defined in

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

---

nullish()

nullish(options: ValidatorOptions): UnionValidator<undefined | null | T>

Parameters

Parameter	Type
options	ValidatorOptions

Returns

UnionValidator<undefined | null | T>

Inherited from

BaseValidator.nullish

Defined in

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

---

optional()

optional(options: ValidatorOptions): UnionValidator<undefined | T>

Parameters

Parameter	Type
options	ValidatorOptions

Returns

UnionValidator<undefined | T>

Inherited from

BaseValidator.optional

Defined in

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

---

or()

or<O>(...predicates: readonly BaseValidator<O>[]): UnionValidator<T | O>

Type Parameters

Type Parameter
O

Parameters

Parameter	Type
...predicates	readonly BaseValidator<O>[]

Returns

UnionValidator<T | O>

Inherited from

BaseValidator.or

Defined in

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

---

parse()

parse<R>(value: unknown): R

Type Parameters

Type Parameter	Default type
R extends string	T

Parameters

Parameter	Type
value	unknown

Returns

R

Inherited from

BaseValidator.parse

Defined in

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

---

phone()

phone(options: ValidatorOptions): this

Parameters

Parameter	Type
options	ValidatorOptions

Returns

this

Defined in

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

---

regex()

regex(regex: RegExp, options: ValidatorOptions): this

Parameters

Parameter	Type
regex	RegExp
options	ValidatorOptions

Returns

this

Defined in

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

---

reshape()

reshape(cb, options)

reshape(cb: (input: T) => Result<T, Error>, options?: ValidatorOptions): this

Parameters

Parameter	Type
cb	(input: T) => Result<T, Error>
options?	ValidatorOptions

Returns

this

Inherited from

BaseValidator.reshape

Defined in

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

reshape(cb, options)

reshape<R, O>(cb: (input: T) => R, options?: ValidatorOptions): BaseValidator<O>

Type Parameters

Type Parameter	Default type
R extends Result<unknown, Error>	-
O	InferResultType<R>

Parameters

Parameter	Type
cb	(input: T) => R
options?	ValidatorOptions

Returns

BaseValidator<O>

Inherited from

BaseValidator.reshape

Defined in

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

---

run()

run(value: unknown): Result<T, BaseError>

Parameters

Parameter	Type
value	unknown

Returns

Result<T, BaseError>

Inherited from

BaseValidator.run

Defined in

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

---

set()

set(options: ValidatorOptions): SetValidator<T>

Parameters

Parameter	Type
options	ValidatorOptions

Returns

SetValidator<T>

Inherited from

BaseValidator.set

Defined in

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

---

setParent()

setParent(parent: object): this

Parameters

Parameter	Type
parent	object

Returns

this

Inherited from

BaseValidator.setParent

Defined in

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

---

setValidationEnabled()

setValidationEnabled(isValidationEnabled: null | boolean | () => boolean): this

Sets if the validator should also run constraints or just do basic checks.

Parameters

Parameter	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

this

Inherited from

BaseValidator.setValidationEnabled

Defined in

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

---

transform()

transform(cb, options)

transform(cb: (value: T) => T, options?: ValidatorOptions): this

Parameters

Parameter	Type
cb	(value: T) => T
options?	ValidatorOptions

Returns

this

Inherited from

BaseValidator.transform

Defined in

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

transform(cb, options)

transform<O>(cb: (value: T) => O, options?: ValidatorOptions): BaseValidator<O>

Type Parameters

Type Parameter
O

Parameters

Parameter	Type
cb	(value: T) => O
options?	ValidatorOptions

Returns

BaseValidator<O>

Inherited from

BaseValidator.transform

Defined in

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

---

url()

url(validatorOptions)

url(validatorOptions?: ValidatorOptions): this

Parameters

Parameter	Type
validatorOptions?	ValidatorOptions

Returns

this

Defined in

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

url(options, validatorOptions)

url(options?: UrlOptions, validatorOptions?: ValidatorOptions): this

Parameters

Parameter	Type
options?	UrlOptions
validatorOptions?	ValidatorOptions

Returns

this

Defined in

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

---

uuid()

uuid(validatorOptions)

uuid(validatorOptions?: ValidatorOptions): this

Parameters

Parameter	Type
validatorOptions?	ValidatorOptions

Returns

this

Defined in

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

uuid(options, validatorOptions)

uuid(options?: StringUuidOptions, validatorOptions?: ValidatorOptions): this

Parameters

Parameter	Type
options?	StringUuidOptions
validatorOptions?	ValidatorOptions

Returns

this

Defined in

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

---

when()

when<Key, This>(key: Key, options: WhenOptions<This, Key>, validatorOptions?: ValidatorOptions): this

Type Parameters

Type Parameter	Default type
Key extends WhenKey	-
This extends BaseValidator<any>	StringValidator<T>

Parameters

Parameter	Type
key	Key
options	WhenOptions<This, Key>
validatorOptions?	ValidatorOptions

Returns

this

Inherited from

BaseValidator.when

Defined in

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