NumberSchema <T>

Type parameters

• T = number

Hierarchy

• Schema<T>
• NumberCriterias<NumberSchema<T>>
• CommonCriterias<NumberSchema<T>>
  • NumberSchema

Index

Methods

• and
• between
• custom
• deprecate
• float
• gt
• gte
• int
• lt
• lte
• negative
• never
• notNullable
• notUndefinable
• nullable
• oneOf
• only
• optional
• or
• positive
• required
• schema
• state
• transform
• type
• undefinable
• validate
• when
• xor

Methods

and

• and(keys: string[], options?: Options): S

• Inherited from CommonCriterias.and

  Map a list of field names that must be defined alongside this field.

between

• between(min: number, max: number, options?: InclusiveOptions): S

• Inherited from NumberCriterias.between

  Require field value to be between 2 numbers.

custom

• custom(callback: CriteriaValidator<InferSchemaType<S>>): S

• Inherited from CommonCriterias.custom

  Set a callback to run custom validation logic.

deprecate

• deprecate(message: string): S

• Inherited from CommonCriterias.deprecate

  Set a message to log when this field is present.

float

• float(options?: Options): S

• Inherited from NumberCriterias.float

  Require field value to be a float (requires a decimal).

gt

• gt(min: number, options?: InclusiveOptions): S

• Inherited from NumberCriterias.gt

  Require field value to be greater than a number.

gte

• gte(min: number, options?: Options): S

• Inherited from NumberCriterias.gte

  Require field value to be greater than or equals to a number.

int

• int(options?: Options): S

• Inherited from NumberCriterias.int

  Require field value to be an integer.

lt

• lt(max: number, options?: InclusiveOptions): S

• Inherited from NumberCriterias.lt

  Require field value to be less than a number.

lte

• lte(max: number, options?: Options): S

• Inherited from NumberCriterias.lte

  Require field value to be less than or equals to a number.

negative

• negative(options?: Options): S

• Inherited from NumberCriterias.negative

  Require field value to be negative and not zero.

never

• never(options?: Options): NumberSchema<never>

• Mark that this field should never be used.

notNullable

• notNullable(options?: Options): NumberSchema<NotNull<T>>

• Disallow null values.

notUndefinable

• notUndefinable(): NumberSchema<NotUndefined<T>>

• Disallow undefined values. Will fallback to the default value.

nullable

• nullable(): NumberSchema<null | T>

• Allow and return null values.

oneOf

• oneOf<I>(list: I[], options?: Options): NumberSchema<InferNullable<T, I>>

• Require field value to be one of the provided numbers.

  ---

  Type parameters

  • I: number = number

only

• only(options?: Options): S

• Inherited from CommonCriterias.only

  Mark that this field can ONLY use a value that matches the default value.

optional

• optional(options?: Options): S

• Inherited from CommonCriterias.optional

  Require this field to NOT be explicitly defined.

or

• or(keys: string[], options?: Options): S

• Inherited from CommonCriterias.or

  Map a list of field names that must have at least 1 defined.

positive

• positive(options?: Options): S

• Inherited from NumberCriterias.positive

  Require field value to be positive and not zero.

required

• required(options?: Options): S

• Inherited from CommonCriterias.required

  Require this field to be explicitly defined.

schema

• schema(): string

• Inherited from Schema.schema

  The type of schema.

state

• state(): SchemaState<Output>

• Inherited from Schema.state

  The internal state object. Contains useful metadata.

transform

• transform(transformer: Transformer<InferSchemaType<S>>): S

• Inherited from CommonCriterias.transform

  Transform a value before it’s passed to the next criteria.

type

• type(): string

• Inherited from Schema.type

  The type of schema and it’s children (when applicable).

undefinable

• undefinable(): NumberSchema<undefined | T>

• Allow and return undefined values. Will NOT fallback to the default value.

validate

• validate(value: unknown, path?: string, options?: SchemaValidateOptions<UnknownObject, UnknownObject>): Output

• Inherited from Schema.validate

  Run all validation checks that have been enqueued and return a type casted value. If a value is undefined, inherit the default value, otherwise throw if required. If nullable and the value is null, return early.

when

• when(condition: WhenCondition<InferSchemaType<S>>, pass: AnySchema, fail?: AnySchema): S

• Inherited from CommonCriterias.when

  Validate with another schema when a condition is met.

xor

• xor(keys: string[], options?: Options): S

• Inherited from CommonCriterias.xor

  Map a list of field names that must not be defined alongside this field.