greaterThanOrEqualToBigInt - API reference

API reference › @evolu/common › Type › greaterThanOrEqualToBigInt

function greaterThanOrEqualToBigInt<Min extends bigint>(
  min: ValidateBrandFactoryBigInt<Min>,
): BrandFactory<
  `GreaterThanOrEqualTo${Min}n`,
  bigint,
  GreaterThanOrEqualToBigIntError<Min>
>;

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

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

The bigint counterpart of greaterThanOrEqualTo; see greaterThanBigInt. For non-negative bigints, use greaterThanOrEqualToBigInt(0n).

Example

import {
  assertErr,
  assertOk,
  BigInt,
  greaterThanOrEqualToBigInt,
} from "@evolu/common";

const AtLeastTen = greaterThanOrEqualToBigInt(10n)(BigInt);

assertOk(AtLeastTen.fromUnknown(10n), 10n);
assertErr(AtLeastTen.fromUnknown(9n), {
  type: "GreaterThanOrEqualTo10n",
  value: 9n,
  min: 10n,
});