greaterThanOrEqualTo - API reference

API reference › @evolu/common › Type › greaterThanOrEqualTo

function greaterThanOrEqualTo<Min>(
  min: ValidateBrandFactoryNumber<Min>,
): BrandFactory<
  `GreaterThanOrEqualTo${Min}`,
  number,
  GreaterThanOrEqualToError<Min>
>;

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

Number Brand requiring a value greater than or equal to min.

Example

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

const AtLeastTen = greaterThanOrEqualTo(10)(Number);

assertOk(AtLeastTen.fromUnknown(10), 10);