API reference / @evolu/common / Type / between
Variable: between()
const between: <Min, Max>(min, max) => BrandFactory<`Between${Min}-${Max}`, number, BetweenError<Min, Max>>;
Defined in: packages/common/src/Type.ts:1757
Number within a range, inclusive.
Example
const Between1And10 = between(1, 10)(PositiveNumber);
const result = Between1And10.from(5); // ok(5)
const errorResult = Between1And10.from(11); // err
Type Parameters
| Type Parameter |
|---|
Min extends number |
Max extends number |
Parameters
| Parameter | Type |
|---|---|
min | Min |
max | Max |
Returns
BrandFactory<`Between${Min}-${Max}`, number, BetweenError<Min, Max>>