numberCriteria

Index

Functions

• between
• float
• gt
• gte
• int
• lt
• lte
• negative
• oneOf
• positive

Functions

between

• between(state: SchemaState<number>, min: number, max: number, options?: InclusiveOptions): Criteria<number>

• Require field value to be between 2 numbers.

float

• float(state: SchemaState<number>, options?: Options): Criteria<number>

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

gt

• gt(state: SchemaState<number>, min: number, options?: InclusiveOptions): Criteria<number>

• Require field value to be greater than a number.

gte

• gte(state: SchemaState<number>, min: number, options?: Options): Criteria<number>

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

int

• int(state: SchemaState<number>, options?: Options): Criteria<number>

• Require field value to be an integer.

lt

• lt(state: SchemaState<number>, max: number, options?: InclusiveOptions): Criteria<number>

• Require field value to be less than a number.

lte

• lte(state: SchemaState<number>, max: number, options?: Options): Criteria<number>

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

negative

• negative(state: SchemaState<number>, options?: Options): Criteria<number>

• Require field value to be negative and not zero.

oneOf

• oneOf(state: SchemaState<number>, list: number[], options?: Options): Criteria<number>

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

positive

• positive(state: SchemaState<number>, options?: Options): Criteria<number>

• Require field value to be positive and not zero.