between - API reference

API reference › @evolu/common › Type › between

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

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

Number Brand requiring a value within an inclusive range.

Example

import { assertOk, Number, between } from "@evolu/common";

const Percentage = between(0, 100)(Number);

assertOk(Percentage.fromUnknown(75), 75);