DeclarationA custom type declaration, such as Date, Option, or ReadonlySet.
When to use
Use when inspecting or transforming non-primitive schema types.
Details
typeParameters holds the inner type arguments, such as the A in
Option<A>. encodedSchema is the fallback representation when no
Reviver recognizes this declaration. annotations.typeConstructor
identifies the declaration kind, such as { _tag: "effect/Option" }.
export interface Declaration {
readonly Declaration._tag: "Declaration"_tag: "Declaration"
readonly Declaration.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 Declaration.typeParameters: ReadonlyArray<Representation>typeParameters: interface ReadonlyArray<T>ReadonlyArray<type Representation =
| Declaration
| Reference
| Suspend
| Null
| Undefined
| Void
| Never
| Unknown
| Any
| String
| Number
| Boolean
| BigInt
| Symbol
| Literal
| UniqueSymbol
| ObjectKeyword
| Enum
| TemplateLiteral
| Arrays
| Objects
| Union
The core tagged union of all supported schema shapes.
Details
Each variant has a _tag discriminator. Switch on _tag to handle each
shape. Most variants carry optional annotations and some carry checks
for validation constraints.
Representation>
readonly Declaration.checks: ReadonlyArray<Check<DeclarationMeta>>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 DeclarationMeta = DateMeta | SizeMetaMetadata union for
Declaration
checks — either
DateMeta
or
SizeMeta
.
DeclarationMeta>>
readonly Declaration.encodedSchema: RepresentationencodedSchema: type Representation =
| Declaration
| Reference
| Suspend
| Null
| Undefined
| Void
| Never
| Unknown
| Any
| String
| Number
| Boolean
| BigInt
| Symbol
| Literal
| UniqueSymbol
| ObjectKeyword
| Enum
| TemplateLiteral
| Arrays
| Objects
| Union
The core tagged union of all supported schema shapes.
Details
Each variant has a _tag discriminator. Switch on _tag to handle each
shape. Most variants carry optional annotations and some carry checks
for validation constraints.
Representation
}