Function number

Creates a number shape.

number<const C extends NumberConstraints = {}>(
constraints?: C,
): NumberShape<{ inferred from <C> }>
Creates a number shape.

Contradictory constraints are rejected as the shape is built, so a shape that exists admits at least one value.
Type Parameters
- const C extends NumberConstraints = {}
  The stated constraints
Parameters
- Optionalconstraints: C
  Optional shape constraints
Returns NumberShape<{ inferred from <C> }>
An immutable shape admitting the numbers the constraints bound, narrowed to the values they enumerate

Throws
TraceError Where the stated constraints contradict one another
- Defined in src/number/index.ts:330
number<const V extends readonly number[]>(...values: V): NumberShape<V[number]>
Creates a number shape admitting an enumerated set of values.

Reads bare numbers as the enumeration closing the domain to them, so that a set of admitted values is stated as number(1, 2, 3) rather than as number({ in: [1, 2, 3] }).
Type Parameters
- const V extends readonly number[]
  The values the shape admits
Parameters
- ...values: V
  The admitted values
Returns NumberShape<V[number]>
An immutable shape admitting values alone
- Defined in src/number/index.ts:344