Class NumberSchema

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

Subclasses should not override constructors.

Hierarchy (View Summary)

ValueSchema<number>
- NumberSchema

Index

Constructors

constructor

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

Properties

__type

__type: Invariant<number> = ...

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 number = ...

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 number
- 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 number
  Returns the input, cast as the validated type T

`Readonly`isValid

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

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(): NumberSchema
The base Object validator validating that the input is an object.

Returns NumberSchema
- Defined in NumberSchema.ts:111

Methods

and

and<U>(nextValidator: Validator<U>): ValueSchema<number & 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<number & 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

finite

finite(): this
Creates a validator that asserts that the input number is finite.

Returns this
- Defined in NumberSchema.ts:171

gt

gt(min: number): this
Creates a validator that asserts that the input number is greater than the provided minimum value.
Parameters
- min: number
  The minimum (exclusive) the value may be.
Returns this
- Defined in NumberSchema.ts:133

gte

gte(min: number): this
Creates a validator that asserts that the input number is at least the provided minimum value.
Parameters
- min: number
  The minimum (inclusive) the value may be.
Returns this
- Defined in NumberSchema.ts:123

lt

lt(max: number): this
Creates a validator that asserts that the input number is less than the provided maximum value.
Parameters
- max: number
  The maximum (exclusive) the value may be.
Returns this
- Defined in NumberSchema.ts:153

lte

lte(max: number): this
Creates a validator that asserts that the input number is at most the provided maximum value.
Parameters
- max: number
  The maximum (inclusive) the value may be.
Returns this
- Defined in NumberSchema.ts:143

maybe

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

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

optional

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

or

or<U>(nextValidator: Validator<U, any>): ValueSchema<number | 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<number | 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 | number>
Prepends this validator allowing for null.

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

orUndefined

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

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

required

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

safeInteger

safeInteger(): this
Creates a validator that asserts that the input number is a safe integer.

Returns this
- Defined in NumberSchema.ts:178

`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<number>
        ),
): any
Parameters
- currentValidator: Validator<any, any>
- previousSchema: undefined | SchemaBase<any>
- operation:
      | undefined
      | (
          (
              validatorA: Validator<any>,
              validatorB: Validator<any, any>,
          ) => Validator<number>
      )
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

within

within(min: number, max: number): this
Creates a validator that asserts that the input number is at least the provided minimum and at most the provided maximum values.
Parameters
- min: number
  The minimum (inclusive) value the input may be.
- max: number
  The maximum (inclusive) value the input may be.
Returns this
- Defined in NumberSchema.ts:164

Class NumberSchema

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns NumberSchema

Parameters

Returns NumberSchema

Properties

__type

Readonlyassert

Type declaration

Parameters

Returns asserts input is number

ReadonlyisValid

Accessors

description

Returns string

options

Returns { optional: false }

Staticbase

Returns NumberSchema

Methods

and

Type Parameters

Parameters

Returns ValueSchema<number & U>

See

Protectedchain

Parameters

Returns any

Protectedclone

Parameters

Returns any

finite

Returns this

gt

Parameters

Returns this

gte

Parameters

Returns this

lt

Parameters

Returns this

lte

Parameters

Returns this

maybe

Returns ValueSchema<undefined | null | number>

optional

Returns PropertyValidatorWithOptions<NumberSchema, number, { optional: true }>

or

Type Parameters

Parameters

Returns ValueSchema<number | U>

orNull

Returns ValueSchema<null | number>

orUndefined

Returns ValueSchema<undefined | number>

required

Returns PropertyValidatorWithOptions<NumberSchema, number, { optional: false }>

safeInteger

Returns this

Protectedself

Parameters

Returns any

Parameters

Returns any

Readonlyvalidate

Parameters

Returns readonly ValidationErrorMessage[]

within

Parameters

Returns this

`Readonly`assert

`Readonly`isValid

`Static`base

`Protected`chain

`Protected`clone

`Protected`self

`Readonly`validate