between - API reference

API reference › @evolu/common › Type › between

const between: <Min, Max>(
  min: Min,
  max: Max,
) => BrandFactory<`Between${Min}-${Max}`, number, BetweenError<Min, Max>>;

Defined in: packages/common/src/Type.ts:2369

Number within a range, inclusive.

Use numeric literal, not expression. See BrandFactory.

Example

const Between1And10 = between(1, 10)(PositiveNumber);
const result = Between1And10.from(5); // ok(5)
const errorResult = Between1And10.from(11); // err