(
exclusiveMaximum: bigint,
annotations?: Annotations.Filter
): SchemaAST.Filter<bigint>Validates that a BigInt is less than the specified value (exclusive).
Details
Arbitrary:
When generating test data with fast-check, this applies a max constraint of
exclusiveMaximum - 1n to ensure generated BigInts are less than the
specified value.
export const const isLessThanBigInt: (
exclusiveMaximum: bigint,
annotations?: Annotations.Filter
) => SchemaAST.Filter<bigint>
Validates that a BigInt is less than the specified value (exclusive).
Details
Arbitrary:
When generating test data with fast-check, this applies a max constraint of
exclusiveMaximum - 1n to ensure generated BigInts are less than the
specified value.
isLessThanBigInt = function makeIsLessThan<T>(options: {
readonly order: Order.Order<T>
readonly annotate?:
| ((
exclusiveMaximum: T
) => Annotations.Filter)
| undefined
readonly formatter?: Formatter<T> | undefined
}): (
exclusiveMaximum: T,
annotations?: Annotations.Filter
) => SchemaAST.Filter<T>
Creates a less-than (<) check for any ordered type from an Order.Order
instance.
makeIsLessThan({
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
annotate: (exclusiveMaximum: bigintexclusiveMaximum) => ({
Annotations.Filter.meta?: Annotations.Meta | undefined(property) Annotations.Filter.meta?: {
_tag: 'isLessThanBigInt';
exclusiveMaximum: bigint;
}
Optional metadata used to identify or extend the filter with custom data.
meta: {
_tag: "isLessThanBigInt"_tag: "isLessThanBigInt",
exclusiveMaximum: bigintexclusiveMaximum
}
})
})