BigIntThe bigint type with optional validation checks.
modelsBigIntMeta
Source effect/SchemaRepresentation.ts:2385 lines
export interface BigInt {
readonly BigInt._tag: "BigInt"_tag: "BigInt"
readonly BigInt.annotations?: Schema.Annotations.Annotations | undefinedannotations?: import SchemaSchema.Annotations.interface Annotations.AnnotationsThis interface is used to define the annotations that can be attached to a
schema. You can extend this interface to define your own annotations.
Details
Note that both a missing key or undefined is used to indicate that the
annotation is not present.
This means that can remove any annotation by setting it to undefined.
Example (Defining your own annotations)
import { Schema } from "effect"
// Extend the Annotations interface with a custom `version` annotation
declare module "effect/Schema" {
namespace Annotations {
interface Annotations {
readonly version?:
| readonly [major: number, minor: number, patch: number]
| undefined
}
}
}
// The `version` annotation is now recognized by the TypeScript compiler
const schema = Schema.String.annotate({ version: [1, 2, 0] })
// const version: readonly [major: number, minor: number, patch: number] | undefined
const version = Schema.resolveAnnotations(schema)?.["version"]
if (version) {
// Access individual parts of the version
console.log(version[1])
// Output: 2
}
Annotations | undefined
readonly BigInt.checks: ReadonlyArray<Check<BigIntMeta>>checks: interface ReadonlyArray<T>ReadonlyArray<type Check<M> = Filter<M> | FilterGroup<M>A validation constraint attached to a type. Either a single
Filter
or a
FilterGroup
combining multiple checks.
Check<type BigIntMeta =
| {
readonly _tag: "isGreaterThanOrEqualToBigInt"
readonly minimum: bigint
}
| {
readonly _tag: "isLessThanOrEqualToBigInt"
readonly maximum: bigint
}
| {
readonly _tag: "isGreaterThanBigInt"
readonly exclusiveMinimum: bigint
}
| {
readonly _tag: "isLessThanBigInt"
readonly exclusiveMaximum: bigint
}
| {
readonly _tag: "isBetweenBigInt"
readonly minimum: bigint
readonly maximum: bigint
readonly exclusiveMinimum?:
| boolean
| undefined
readonly exclusiveMaximum?:
| boolean
| undefined
}
Metadata union for bigint-specific validation checks (min, max, between).
BigIntMeta>>
}Referenced by 1 symbols