StringSchema | @bytesoftio/schema

Hierarchy

Schema<string>
- StringSchema

Implements

ValidationSchema<string>

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new StringSchema(): StringSchema

- Defined in schemas/StringSchema.ts:49
Returns StringSchema

Properties

Protected conditionalValidationDefinitions

conditionalValidationDefinitions: ValidationDefinition[] = []

Protected immutableMode

immutableMode: boolean = true

Protected sanitizerDefinitions

sanitizerDefinitions: SanitizerDefinition[] = []

Protected validationDefinitions

validationDefinitions: ValidationDefinition[] = []

Methods

Protected addConditionalValidationDefinition

addConditionalValidationDefinition(validationDefinition: ValidationDefinition): this

Inherited from StringSchema.addConditionalValidationDefinition
- Defined in Schema.ts:175
Parameters
- validationDefinition: ValidationDefinition
Returns this

Protected addSanitizerDefinition

addSanitizerDefinition(sanitizerDefinition: SanitizerDefinition): this

Inherited from StringSchema.addSanitizerDefinition
- Defined in Schema.ts:182
Parameters
- sanitizerDefinition: SanitizerDefinition
Returns this

Protected addValidationDefinition

addValidationDefinition(validationDefinition: ValidationDefinition): this

Inherited from StringSchema.addValidationDefinition
- Defined in Schema.ts:162
Parameters
- validationDefinition: ValidationDefinition
Returns this

alpha

alpha(message?: CustomValidationMessage): this

- Defined in schemas/StringSchema.ts:136
Parameters
- Optional message: CustomValidationMessage
Returns this

alphaDashes

alphaDashes(message?: CustomValidationMessage): this

- Defined in schemas/StringSchema.ts:144
Parameters
- Optional message: CustomValidationMessage
Returns this

alphaNumeric

alphaNumeric(message?: CustomValidationMessage): this

- Defined in schemas/StringSchema.ts:140
Parameters
- Optional message: CustomValidationMessage
Returns this

alphaNumericDashes

alphaNumericDashes(message?: CustomValidationMessage): this

- Defined in schemas/StringSchema.ts:152
Parameters
- Optional message: CustomValidationMessage
Returns this

alphaNumericUnderscores

alphaNumericUnderscores(message?: CustomValidationMessage): this

- Defined in schemas/StringSchema.ts:156
Parameters
- Optional message: CustomValidationMessage
Returns this

alphaUnderscores

alphaUnderscores(message?: CustomValidationMessage): this

- Defined in schemas/StringSchema.ts:148
Parameters
- Optional message: CustomValidationMessage
Returns this

also

also(validator: CustomValidation): this

Implementation of ValidationSchema.also

Inherited from StringSchema.also
- Defined in Schema.ts:44
Parameters
- validator: CustomValidation
Returns this

and

and(andValidator: CustomValidation): this

Implementation of ValidationSchema.and

Inherited from StringSchema.and
- Defined in Schema.ts:40
Parameters
- andValidator: CustomValidation
Returns this

between

between(minLength: LazyValue<number>, maxLength: LazyValue<number>, message?: CustomValidationMessage): this

- Defined in schemas/StringSchema.ts:92
Parameters
- minLength: LazyValue<number>
- maxLength: LazyValue<number>
- Optional message: CustomValidationMessage
Returns this

Protected clone

clone(): this

Inherited from StringSchema.clone
- Defined in Schema.ts:196
Returns this

Protected cloneInstance

cloneInstance(): this

Overrides Schema.cloneInstance
- Defined in schemas/StringSchema.ts:55
Returns this

Protected customSanitizeBehavior

customSanitizeBehavior<TValue, TSanitizedValue>(value: TValue): TSanitizedValue

Inherited from StringSchema.customSanitizeBehavior
- Defined in Schema.ts:154
Type parameters
- TValue
- TSanitizedValue
Parameters
- value: TValue
Returns TSanitizedValue

Protected customSanitizeBehaviorAsync

customSanitizeBehaviorAsync<TValue, TSanitizedValue>(value: TValue): Promise<TSanitizedValue>

Inherited from StringSchema.customSanitizeBehaviorAsync
- Defined in Schema.ts:158
Type parameters
- TValue
- TSanitizedValue
Parameters
- value: TValue
Returns Promise<TSanitizedValue>

Protected customTestingBehavior

customTestingBehavior(value: any, testResult: boolean): boolean

Inherited from StringSchema.customTestingBehavior
- Defined in Schema.ts:138
Parameters
- value: any
- testResult: boolean
Returns boolean

Protected customTestingBehaviorAsync

customTestingBehaviorAsync(value: any, testResult: boolean): Promise<boolean>

Inherited from StringSchema.customTestingBehaviorAsync
- Defined in Schema.ts:142
Parameters
- value: any
- testResult: boolean
Returns Promise<boolean>

Protected customValidationBehavior

customValidationBehavior(value: any, errors: ValidationError[]): ValidationError[]

Inherited from StringSchema.customValidationBehavior
- Defined in Schema.ts:146
Parameters
- value: any
- errors: ValidationError[]
Returns ValidationError[]

Protected customValidationBehaviorAsync

customValidationBehaviorAsync(value: any, errors: ValidationError[]): Promise<ValidationError[]>

Inherited from StringSchema.customValidationBehaviorAsync
- Defined in Schema.ts:150
Parameters
- value: any
- errors: ValidationError[]
Returns Promise<ValidationError[]>

date

date(message?: CustomValidationMessage): this

- Defined in schemas/StringSchema.ts:160
Parameters
- Optional message: CustomValidationMessage
Returns this

dateAfter

dateAfter(after: LazyValue<Date>, message?: CustomValidationMessage): this

- Defined in schemas/StringSchema.ts:180
Parameters
- after: LazyValue<Date>
- Optional message: CustomValidationMessage
Returns this

dateAfterOrSame

dateAfterOrSame(after: LazyValue<Date>, message?: CustomValidationMessage): this

- Defined in schemas/StringSchema.ts:184
Parameters
- after: LazyValue<Date>
- Optional message: CustomValidationMessage
Returns this

dateBefore

dateBefore(before: LazyValue<Date>, message?: CustomValidationMessage): this

- Defined in schemas/StringSchema.ts:172
Parameters
- before: LazyValue<Date>
- Optional message: CustomValidationMessage
Returns this

dateBeforeOrSame

dateBeforeOrSame(before: LazyValue<Date>, message?: CustomValidationMessage): this

- Defined in schemas/StringSchema.ts:176
Parameters
- before: LazyValue<Date>
- Optional message: CustomValidationMessage
Returns this

dateBetween

dateBetween(after: LazyValue<Date>, before: LazyValue<Date>, message?: CustomValidationMessage): this

- Defined in schemas/StringSchema.ts:188
Parameters
- after: LazyValue<Date>
- before: LazyValue<Date>
- Optional message: CustomValidationMessage
Returns this

dateBetweenOrSame

dateBetweenOrSame(after: LazyValue<Date>, before: LazyValue<Date>, message?: CustomValidationMessage): this

- Defined in schemas/StringSchema.ts:192
Parameters
- after: LazyValue<Date>
- before: LazyValue<Date>
- Optional message: CustomValidationMessage
Returns this

dateTime

dateTime(message?: CustomValidationMessage): this

- Defined in schemas/StringSchema.ts:168
Parameters
- Optional message: CustomValidationMessage
Returns this

email

email(message?: CustomValidationMessage): this

- Defined in schemas/StringSchema.ts:100
Parameters
- Optional message: CustomValidationMessage
Returns this

endsWith

endsWith(find: LazyValue<string>, message?: CustomValidationMessage): this

- Defined in schemas/StringSchema.ts:112
Parameters
- find: LazyValue<string>
- Optional message: CustomValidationMessage
Returns this

equals

equals(equal: LazyValue<string>, message?: CustomValidationMessage): this

- Defined in schemas/StringSchema.ts:76
Parameters
- equal: LazyValue<string>
- Optional message: CustomValidationMessage
Returns this

includes

includes(find: LazyValue<string>, message?: CustomValidationMessage): this

- Defined in schemas/StringSchema.ts:116
Parameters
- find: LazyValue<string>
- Optional message: CustomValidationMessage
Returns this

length

length(exactLength: LazyValue<number>, message?: CustomValidationMessage): this

- Defined in schemas/StringSchema.ts:80
Parameters
- exactLength: LazyValue<number>
- Optional message: CustomValidationMessage
Returns this

map

map(sanitizer: SanitizerFunction): this

Implementation of ValidationSchema.map

Inherited from StringSchema.map
- Defined in Schema.ts:53
Parameters
- sanitizer: SanitizerFunction
Returns this

matches

matches(regex: LazyValue<RegExp>, message?: CustomValidationMessage): this

- Defined in schemas/StringSchema.ts:96
Parameters
- regex: LazyValue<RegExp>
- Optional message: CustomValidationMessage
Returns this

max

max(maxLength: LazyValue<number>, message?: CustomValidationMessage): this

- Defined in schemas/StringSchema.ts:88
Parameters
- maxLength: LazyValue<number>
- Optional message: CustomValidationMessage
Returns this

min

min(minLength: LazyValue<number>, message?: CustomValidationMessage): this

- Defined in schemas/StringSchema.ts:84
Parameters
- minLength: LazyValue<number>
- Optional message: CustomValidationMessage
Returns this

noneOf

noneOf(blacklist: LazyValue<string[]>, message?: CustomValidationMessage): this

- Defined in schemas/StringSchema.ts:128
Parameters
- blacklist: LazyValue<string[]>
- Optional message: CustomValidationMessage
Returns this

numeric

numeric(message?: CustomValidationMessage): this

- Defined in schemas/StringSchema.ts:132
Parameters
- Optional message: CustomValidationMessage
Returns this

omits

omits(find: LazyValue<string>, message?: CustomValidationMessage): this

- Defined in schemas/StringSchema.ts:120
Parameters
- find: LazyValue<string>
- Optional message: CustomValidationMessage
Returns this

oneOf

oneOf(whitelist: LazyValue<string[]>, message?: CustomValidationMessage): this

- Defined in schemas/StringSchema.ts:124
Parameters
- whitelist: LazyValue<string[]>
- Optional message: CustomValidationMessage
Returns this

optional

optional(message?: CustomValidationMessage): this

- Defined in schemas/StringSchema.ts:70
Parameters
- Optional message: CustomValidationMessage
Returns this

or

or(orValidator: CustomValidation): this

Implementation of ValidationSchema.or

Inherited from StringSchema.or
- Defined in Schema.ts:36
Parameters
- orValidator: CustomValidation
Returns this

Protected removeValidationDefinitionsOfType

removeValidationDefinitionsOfType(type: ValidationType): this

Inherited from StringSchema.removeValidationDefinitionsOfType
- Defined in Schema.ts:189
Parameters
- type: ValidationType
Returns this

required

required(required?: LazyValue<boolean>, message?: CustomValidationMessage): this

- Defined in schemas/StringSchema.ts:64
Parameters
- Optional required: LazyValue<boolean>
- Optional message: CustomValidationMessage
Returns this

sanitize

sanitize<TValue, TSanitizedValue>(value: TValue): TSanitizedValue

Implementation of ValidationSchema.sanitize

Inherited from StringSchema.sanitize
- Defined in Schema.ts:96
Type parameters
- TValue
- TSanitizedValue
Parameters
- value: TValue
Returns TSanitizedValue

sanitizeAndTest

sanitizeAndTest<TValue, TSanitizedValue>(value: any): [boolean, TSanitizedValue]

Implementation of ValidationSchema.sanitizeAndTest

Inherited from StringSchema.sanitizeAndTest
- Defined in Schema.ts:110
Type parameters
- TValue
- TSanitizedValue
Parameters
- value: any
Returns [boolean, TSanitizedValue]

sanitizeAndTestAsync

sanitizeAndTestAsync<TValue, TSanitizedValue>(value: any): Promise<[boolean, TSanitizedValue]>

Implementation of ValidationSchema.sanitizeAndTestAsync

Inherited from StringSchema.sanitizeAndTestAsync
- Defined in Schema.ts:117
Type parameters
- TValue
- TSanitizedValue
Parameters
- value: any
Returns Promise<[boolean, TSanitizedValue]>

sanitizeAndValidate

sanitizeAndValidate<TValue, TSanitizedValue>(value: any): [ValidationError[] | undefined, TSanitizedValue]

Implementation of ValidationSchema.sanitizeAndValidate

Inherited from StringSchema.sanitizeAndValidate
- Defined in Schema.ts:124
Type parameters
- TValue
- TSanitizedValue
Parameters
- value: any
Returns [ValidationError[] | undefined, TSanitizedValue]

sanitizeAndValidateAsync

sanitizeAndValidateAsync<TValue, TSanitizedValue>(value: any): Promise<[ValidationError[] | undefined, TSanitizedValue]>

Implementation of ValidationSchema.sanitizeAndValidateAsync

Inherited from StringSchema.sanitizeAndValidateAsync
- Defined in Schema.ts:131
Type parameters
- TValue
- TSanitizedValue
Parameters
- value: any
Returns Promise<[ValidationError[] | undefined, TSanitizedValue]>

sanitizeAsync

sanitizeAsync<TValue, TSanitizedValue>(value: TValue): Promise<TSanitizedValue>

Implementation of ValidationSchema.sanitizeAsync

Inherited from StringSchema.sanitizeAsync
- Defined in Schema.ts:103
Type parameters
- TValue
- TSanitizedValue
Parameters
- value: TValue
Returns Promise<TSanitizedValue>

sanitizer

sanitizer(sanitizer: SanitizerFunction): this

Implementation of ValidationSchema.sanitizer

Inherited from StringSchema.sanitizer
- Defined in Schema.ts:58
Parameters
- sanitizer: SanitizerFunction
Returns this

Protected skipClone

skipClone(fn: () => void): void

Inherited from StringSchema.skipClone
- Defined in Schema.ts:204
Parameters
- fn: () => void
  - - (): void
    - Returns void
Returns void

startsWith

startsWith(find: LazyValue<string>, message?: CustomValidationMessage): this

- Defined in schemas/StringSchema.ts:108
Parameters
- find: LazyValue<string>
- Optional message: CustomValidationMessage
Returns this

test

test(value: any): boolean

Implementation of ValidationSchema.test

Inherited from StringSchema.test
- Defined in Schema.ts:62
Parameters
- value: any
Returns boolean

testAsync

testAsync(value: any): Promise<boolean>

Implementation of ValidationSchema.testAsync

Inherited from StringSchema.testAsync
- Defined in Schema.ts:70
Parameters
- value: any
Returns Promise<boolean>

time

time(message?: CustomValidationMessage): this

- Defined in schemas/StringSchema.ts:164
Parameters
- Optional message: CustomValidationMessage
Returns this

timeAfter

timeAfter(after: LazyValue<string>, message?: CustomValidationMessage): this

- Defined in schemas/StringSchema.ts:204
Parameters
- after: LazyValue<string>
- Optional message: CustomValidationMessage
Returns this

timeAfterOrSame

timeAfterOrSame(after: LazyValue<string>, message?: CustomValidationMessage): this

- Defined in schemas/StringSchema.ts:208
Parameters
- after: LazyValue<string>
- Optional message: CustomValidationMessage
Returns this

timeBefore

timeBefore(before: LazyValue<string>, message?: CustomValidationMessage): this

- Defined in schemas/StringSchema.ts:196
Parameters
- before: LazyValue<string>
- Optional message: CustomValidationMessage
Returns this

timeBeforeOrSame

timeBeforeOrSame(before: LazyValue<string>, message?: CustomValidationMessage): this

- Defined in schemas/StringSchema.ts:200
Parameters
- before: LazyValue<string>
- Optional message: CustomValidationMessage
Returns this

timeBetween

timeBetween(after: LazyValue<string>, before: LazyValue<string>, message?: CustomValidationMessage): this

- Defined in schemas/StringSchema.ts:212
Parameters
- after: LazyValue<string>
- before: LazyValue<string>
- Optional message: CustomValidationMessage
Returns this

timeBetweenOrSame

timeBetweenOrSame(after: LazyValue<string>, before: LazyValue<string>, message?: CustomValidationMessage): this

- Defined in schemas/StringSchema.ts:216
Parameters
- after: LazyValue<string>
- before: LazyValue<string>
- Optional message: CustomValidationMessage
Returns this

toCamelCase

toCamelCase(): this

- Defined in schemas/StringSchema.ts:236
Returns this

toCapitalized

toCapitalized(): this

- Defined in schemas/StringSchema.ts:232
Returns this

toConstantCase

toConstantCase(): this

- Defined in schemas/StringSchema.ts:248
Returns this

toDefault

toDefault(defaultValue?: LazyValue<string>): this

- Defined in schemas/StringSchema.ts:220
Parameters
- Default value defaultValue: LazyValue<string> = ""
Returns this

toKebabCase

toKebabCase(): this

- Defined in schemas/StringSchema.ts:244
Returns this

toLowerCase

toLowerCase(): this

- Defined in schemas/StringSchema.ts:228
Returns this

toSnakeCase

toSnakeCase(): this

- Defined in schemas/StringSchema.ts:240
Returns this

toTrimmed

toTrimmed(): this

- Defined in schemas/StringSchema.ts:252
Returns this

toUpperCase

toUpperCase(): this

- Defined in schemas/StringSchema.ts:224
Returns this

url

url(message?: CustomValidationMessage): this

- Defined in schemas/StringSchema.ts:104
Parameters
- Optional message: CustomValidationMessage
Returns this

validate

validate(value: any): ValidationError[] | undefined

Implementation of ValidationSchema.validate

Inherited from StringSchema.validate
- Defined in Schema.ts:78
Parameters
- value: any
Returns ValidationError[] | undefined

validateAsync

validateAsync(value: any): Promise<ValidationError[] | undefined>

Implementation of ValidationSchema.validateAsync

Inherited from StringSchema.validateAsync
- Defined in Schema.ts:87
Parameters
- value: any
Returns Promise<ValidationError[] | undefined>

validator

validator(validator: CustomValidation): this

Implementation of ValidationSchema.validator

Inherited from StringSchema.validator
- Defined in Schema.ts:49
Parameters
- validator: CustomValidation
Returns this