effect-io-ai

Package: effect
Module: BigInt

BigInt.clamp

Restricts the given bigint to be within the range specified by the minimum and maximum values.

• If the bigint is less than the minimum value, the function returns the minimum value.
• If the bigint is greater than the maximum value, the function returns the maximum value.
• Otherwise, it returns the original bigint.

Example

import * as assert from "node:assert"
import { BigInt } from "effect"

const clamp = BigInt.clamp({ minimum: 1n, maximum: 5n })

assert.equal(clamp(3n), 3n)
assert.equal(clamp(0n), 1n)
assert.equal(clamp(6n), 5n)

Signature

declare const clamp: { (options: { minimum: bigint; maximum: bigint; }): (self: bigint) => bigint; (self: bigint, options: { minimum: bigint; maximum: bigint; }): bigint; }

Source

Since v2.0.0