Class StringSchema

A base class for validation state. Provides methods for chaining.

Subclasses should not override constructors.

Hierarchy (View Summary)

ValueSchema<string>
- StringSchema

Index

Constructors

constructor

new StringSchema(currentValidator: Validator<any, any>): StringSchema
Constructs the first link in a schema chain.
Parameters
- currentValidator: Validator<any, any>
Returns StringSchema
Inherited from ValueSchema.constructor
- Defined in SchemaBase.ts:45
new StringSchema(
    currentValidator: Validator<any, any>,
    previousSchema: SchemaBase<any>,
    operation: (
        validatorA: Validator<any>,
        validatorB: Validator<any, any>,
    ) => Validator<string>,
): StringSchema
Constructs linking to the given previous schema.
Parameters
- currentValidator: Validator<any, any>
- previousSchema: SchemaBase<any>
- operation: (
  validatorA: Validator<any>,
  validatorB: Validator<any, any>,
  ) => Validator<string>
Returns StringSchema
Inherited from ValueSchema.constructor
- Defined in SchemaBase.ts:54

Properties

__type

__type: Invariant<string> = ...

Enforces T is in an invariant position. This prevents a validator with more strict rules is assigned to a less strict type, which can cause unexpected validation errors.

`Readonly`assert

assert: (
    input: unknown,
    origin?: string,
    path?: readonly string[],
) => asserts input is string = ...

Validates the given input, asserting that the input is type T. If the input is not valid, a ValidationError will be thrown.

Type declaration

- (
      input: unknown,
      origin?: string,
      path?: readonly string[],
  ): asserts input is string
- Parameters
  - input: unknown
    The input to validate.
  - Optionalorigin: string
    The error origin. ErrorOrigin.API by default.
  - Optionalpath: readonly string[]
    The current field path to this validator.
  Returns asserts input is string
  Returns the input, cast as the validated type T

`Readonly`isValid

isValid: (input: unknown) => input is string = ...

Returns true if the input is valid according to this validator.

Accessors

description

get description(): string
A short description of the validator.

Returns string
Inherited from ValueSchema.description
- Defined in SchemaBase.ts:79

options

get options(): { optional: false }
Returns { optional: false }
Inherited from ValueSchema.options
- Defined in SchemaBase.ts:36

`Static`base

get base(): StringSchema
The base SetSchema instance validating that the input is a Set.

Returns StringSchema
- Defined in StringSchema.ts:87

Methods

and

and<U>(nextValidator: Validator<U>): ValueSchema<string & U>
Returns a validator that asserts if this validator and the next passes.
Type Parameters
- U
Parameters
- nextValidator: Validator<U>
  The validator to run after the current.
Returns ValueSchema<string & U>
Returns a new ValueSchema intersecting this validator and the next.

See
andValidators
Inherited from ValueSchema.and
- Defined in ValueSchema.ts:75

`Protected`chain

chain(nextValidator: Validator<any, any>): any
Constructs a new schema with a validator chaining the current validator with the provided next in an AND operation.
Parameters
- nextValidator: Validator<any, any>
  The validator to run after the current.
Returns any
Returns a new Schema instance the same class with a new validator chaining the current validator with the given next in an AND operation.
Inherited from ValueSchema.chain
- Defined in SchemaBase.ts:160

`Protected`clone

clone(transform?: (validator: Validator<any>) => Validator<any>): any
Clones this schema, transforming all validators with the given mutator.
Parameters
- transform: (validator: Validator<any>) => Validator<any> = ...
  A transformer which takes an existing validator in the chain and returns a new one. Validators should be considered to be immutable; transform should not change the input but instead return a new validator.
Returns any
Inherited from ValueSchema.clone
- Defined in SchemaBase.ts:109

matches

matches(regex: RegExp): StringSchema
Creates a validator that asserts that the input string matches the given regex.
Parameters
- regex: RegExp
Returns StringSchema
- Defined in StringSchema.ts:132

maxLength

maxLength(max: number): StringSchema
Creates a validator that asserts that the input string has at most the given maximum length.
Parameters
- max: number
  The string must be at most this length.
Returns StringSchema
- Defined in StringSchema.ts:116

maybe

maybe(): ValueSchema<undefined | null | string>
Prepends this validator allowing for null or undefined.

Returns ValueSchema<undefined | null | string>
Inherited from ValueSchema.maybe
- Defined in ValueSchema.ts:49

minLength

minLength(min: number): StringSchema
Creates a validator that asserts that the input string has at least the given minimum length.
Parameters
- min: number
  The string must be at least this length.
Returns StringSchema
- Defined in StringSchema.ts:106

notEmpty

notEmpty(): StringSchema
Creates a validator that asserts that the input is not empty.

Returns StringSchema
- Defined in StringSchema.ts:96

noWhitespace

noWhitespace(): StringSchema
Creates a validator that asserts that the input string has no whitespace characters. Whitespace characters include space, new line, carriage return, and tab.

Returns StringSchema
- Defined in StringSchema.ts:124

optional

optional(): PropertyValidatorWithOptions<
    StringSchema,
    string,
    { optional: true },
>
Returns PropertyValidatorWithOptions<StringSchema, string, { optional: true }>
Inherited from ValueSchema.optional
- Defined in SchemaBase.ts:164

or

or<U>(nextValidator: Validator<U, any>): ValueSchema<string | U>
Returns a validator that asserts if this validator or the next passes.

Implementation note: subclasses should not change the schema instance returned unless all chainable validators accept input type 'unknown'.
Type Parameters
- U
Parameters
- nextValidator: Validator<U, any>
  The validator to run after the current.
Returns ValueSchema<string | U>
Returns a new ValueSchema providing the union of this validator and the next.
Inherited from ValueSchema.or
- Defined in ValueSchema.ts:89

orNull

orNull(): ValueSchema<null | string>
Prepends this validator allowing for null.

Returns ValueSchema<null | string>
Inherited from ValueSchema.orNull
- Defined in ValueSchema.ts:56

orUndefined

orUndefined(): ValueSchema<undefined | string>
Prepends this validator allowing for undefined.

Returns ValueSchema<undefined | string>
Inherited from ValueSchema.orUndefined
- Defined in ValueSchema.ts:63

required

required(): PropertyValidatorWithOptions<
    StringSchema,
    string,
    { optional: false },
>
Returns PropertyValidatorWithOptions<StringSchema, string, { optional: false }>
Inherited from ValueSchema.required
- Defined in SchemaBase.ts:177

`Protected`self

self(current: Validator<any, any>): any
Parameters
- current: Validator<any, any>
Returns any
Inherited from ValueSchema.self
- Defined in SchemaBase.ts:123
self(
    currentValidator: Validator<any, any>,
    previousSchema: undefined | SchemaBase<any>,
    operation:
        | undefined
        | (
            (
                validatorA: Validator<any>,
                validatorB: Validator<any, any>,
            ) => Validator<string>
        ),
): any
Parameters
- currentValidator: Validator<any, any>
- previousSchema: undefined | SchemaBase<any>
- operation:
      | undefined
      | (
          (
              validatorA: Validator<any>,
              validatorB: Validator<any, any>,
          ) => Validator<string>
      )
Returns any
Inherited from ValueSchema.self
- Defined in SchemaBase.ts:125

`Readonly`validate

validate(
    input: unknown,
    options?: ValidationOptions,
    path?: readonly string[],
): readonly ValidationErrorMessage[]
Parameters
- input: unknown
  The input to validate.
- Optionaloptions: ValidationOptions
  Validation options.
- Optionalpath: readonly string[]
  The current field path to this validator.
Returns readonly ValidationErrorMessage[]
Returns an array of validation failures. If options.all is not true, only the first error will be returned.
Inherited from ValueSchema.validate
- Defined in SchemaBase.ts:95

Class StringSchema

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns StringSchema

Parameters

Returns StringSchema

Properties

__type

Readonlyassert

Type declaration

Parameters

Returns asserts input is string

ReadonlyisValid

Accessors

description

Returns string

options

Returns { optional: false }

Staticbase

Returns StringSchema

Methods

and

Type Parameters

Parameters

Returns ValueSchema<string & U>

See

Protectedchain

Parameters

Returns any

Protectedclone

Parameters

Returns any

matches

Parameters

Returns StringSchema

maxLength

Parameters

Returns StringSchema

maybe

Returns ValueSchema<undefined | null | string>

minLength

Parameters

Returns StringSchema

notEmpty

Returns StringSchema

noWhitespace

Returns StringSchema

optional

Returns PropertyValidatorWithOptions<StringSchema, string, { optional: true }>

or

Type Parameters

Parameters

Returns ValueSchema<string | U>

orNull

Returns ValueSchema<null | string>

orUndefined

Returns ValueSchema<undefined | string>

required

Returns PropertyValidatorWithOptions<StringSchema, string, { optional: false }>

Protectedself

Parameters

Returns any

Parameters

Returns any

Readonlyvalidate

Parameters

Returns readonly ValidationErrorMessage[]

Settings

On This Page

`Readonly`assert

`Readonly`isValid

`Static`base

`Protected`chain

`Protected`clone

`Protected`self

`Readonly`validate