(
maximum: bigint,
annotations?: Annotations.Filter
): SchemaAST.Filter<bigint>Validates that a BigInt is less than or equal to the specified value (inclusive).
Details
Arbitrary:
When generating test data with fast-check, this applies a max constraint
to ensure generated BigInt values are less than or equal to the specified
value.
export const const isLessThanOrEqualToBigInt: (
maximum: bigint,
annotations?: Annotations.Filter
) => SchemaAST.Filter<bigint>
Validates that a BigInt is less than or equal to the specified value
(inclusive).
Details
Arbitrary:
When generating test data with fast-check, this applies a max constraint
to ensure generated BigInt values are less than or equal to the specified
value.
isLessThanOrEqualToBigInt = function makeIsLessThanOrEqualTo<
T
>(options: {
readonly order: Order.Order<T>
readonly annotate?:
| ((
exclusiveMaximum: T
) => Annotations.Filter)
| undefined
readonly formatter?: Formatter<T> | undefined
}): (
maximum: T,
annotations?: Annotations.Filter
) => SchemaAST.Filter<T>
Creates a less-than-or-equal-to (<=) check for any ordered type from an
Order.Order instance.
makeIsLessThanOrEqualTo({
order: Order.Order<bigint>order: import OrderOrder.const BigInt: Order<bigint>Order instance for bigints that compares them numerically.
When to use
Use when you need numeric ordering for bigint values.
Details
Uses standard numeric comparison for bigint values and handles arbitrarily
large integers.
Example (Ordering BigInts)
import { Order } from "effect"
console.log(Order.BigInt(1n, 2n)) // -1
console.log(Order.BigInt(2n, 1n)) // 1
console.log(Order.BigInt(1n, 1n)) // 0
BigInt,
annotate?: | ((
exclusiveMaximum: bigint
) => Annotations.Filter)
| undefined
maximum: bigintmaximum) => ({
Annotations.Filter.meta?: Annotations.Meta | undefined(property) Annotations.Filter.meta?: {
_tag: 'isLessThanOrEqualToBigInt';
maximum: bigint;
}
Optional metadata used to identify or extend the filter with custom data.
meta: {
_tag: "isLessThanOrEqualToBigInt"_tag: "isLessThanOrEqualToBigInt",
maximum: bigintmaximum
}
})
})