Schema.Union<
readonly [
Schema.Union<
readonly [
Schema.Struct<{ readonly _tag: Schema.tag<"isDateValid"> }>,
Schema.Struct<{
readonly _tag: Schema.tag<"isGreaterThanDate">
readonly exclusiveMinimum: Schema.Date
}>,
Schema.Struct<{
readonly _tag: Schema.tag<"isGreaterThanOrEqualToDate">
readonly minimum: Schema.Date
}>,
Schema.Struct<{
readonly _tag: Schema.tag<"isLessThanDate">
readonly exclusiveMaximum: Schema.Date
}>,
Schema.Struct<{
readonly _tag: Schema.tag<"isLessThanOrEqualToDate">
readonly maximum: Schema.Date
}>,
Schema.Struct<{
readonly _tag: Schema.tag<"isBetweenDate">
readonly minimum: Schema.Date
readonly maximum: Schema.Date
readonly exclusiveMinimum: Schema.optional<Schema.Boolean>
readonly exclusiveMaximum: Schema.optional<Schema.Boolean>
}>
]
>,
Schema.Union<
readonly [
Schema.Struct<{
readonly _tag: Schema.tag<"isMinSize">
readonly minSize: Schema.Int
}>,
Schema.Struct<{
readonly _tag: Schema.tag<"isMaxSize">
readonly maxSize: Schema.Int
}>,
Schema.Struct<{
readonly _tag: Schema.tag<"isSizeBetween">
readonly minimum: Schema.Int
readonly maximum: Schema.Int
}>
]
>
]
>Schema for DeclarationMeta.
schemasDeclarationMeta
Source effect/SchemaRepresentation.ts:14934 lines
export const const $DeclarationMeta: Schema.Union<
readonly [
Schema.Union<
readonly [
Schema.Struct<{
readonly _tag: Schema.tag<"isDateValid">
}>,
Schema.Struct<{
readonly _tag: Schema.tag<"isGreaterThanDate">
readonly exclusiveMinimum: Schema.Date
}>,
Schema.Struct<{
readonly _tag: Schema.tag<"isGreaterThanOrEqualToDate">
readonly minimum: Schema.Date
}>,
Schema.Struct<{
readonly _tag: Schema.tag<"isLessThanDate">
readonly exclusiveMaximum: Schema.Date
}>,
Schema.Struct<{
readonly _tag: Schema.tag<"isLessThanOrEqualToDate">
readonly maximum: Schema.Date
}>,
Schema.Struct<{
readonly _tag: Schema.tag<"isBetweenDate">
readonly minimum: Schema.Date
readonly maximum: Schema.Date
readonly exclusiveMinimum: Schema.optional<Schema.Boolean>
readonly exclusiveMaximum: Schema.optional<Schema.Boolean>
}>
]
>,
Schema.Union<
readonly [
Schema.Struct<{
readonly _tag: Schema.tag<"isMinSize">
readonly minSize: Schema.Int
}>,
Schema.Struct<{
readonly _tag: Schema.tag<"isMaxSize">
readonly maxSize: Schema.Int
}>,
Schema.Struct<{
readonly _tag: Schema.tag<"isSizeBetween">
readonly minimum: Schema.Int
readonly maximum: Schema.Int
}>
]
>
]
>
const $DeclarationMeta: {
Type: { [K in keyof Members]: Members[K]["Type"]; }[number];
Encoded: { [K in keyof Members]: Members[K]["Encoded"]; }[number];
DecodingServices: { [K in keyof Members]: Members[K]["DecodingServices"]; }[number];
EncodingServices: { [K in keyof Members]: Members[K]["EncodingServices"]; }[number];
Iso: { [K in keyof Members]: Members[K]["Iso"]; }[number];
members: Members;
mapMembers: (f: (members: readonly [Schema.Union<readonly [Schema.Struct<{ readonly _tag: Schema.tag<'isDateValid'> }>, Schema.Struct<{ readonly _tag: Schema.tag<'isGreaterThanDate'>; readonly exclusiveMinimum: Schema.Date }>, Schema.Struct<{ readonly…;
Rebuild: Rebuild;
ast: Ast;
annotate: (annotations: Schema.Annotations.Bottom<Schema.Struct.ReadonlySide<{ readonly _tag: Schema.tag<'isDateValid'>; }, 'Type'> | Schema.Struct.ReadonlySide<{ readonly _tag: Schema.tag<'isGreaterThanDate'>; readonly exclusiveMinimum: Schema.Date…;
annotateKey: (annotations: Schema.Annotations.Key<Schema.Struct.ReadonlySide<{ readonly _tag: Schema.tag<'isDateValid'> }, 'Type'> | Schema.Struct.ReadonlySide<{ readonly _tag: Schema.tag<'isGreaterThanDate'>; readonly exclusiveMinimum: Schema.Date }, …;
check: (checks_0: SchemaAST.Check<Schema.Struct.ReadonlySide<{ readonly _tag: Schema.tag<'isDateValid'> }, 'Type'> | Schema.Struct.ReadonlySide<{ readonly _tag: Schema.tag<'isGreaterThanDate'>; readonly exclusiveMinimum: Schema.Date }, 'Type'> | …;
rebuild: (ast: SchemaAST.Union<SchemaAST.Union<SchemaAST.Objects>>) => Schema.Union<readonly [Schema.Union<readonly [Schema.Struct<{ readonly _tag: Schema.tag<'isDateValid'> }>, Schema.Struct<{ readonly _tag: Schema.tag<'isGreaterThanDate'>; readon…;
make: (input: { readonly _tag?: 'isDateValid' | undefined } | { readonly exclusiveMinimum: globalThis.Date; readonly _tag?: 'isGreaterThanDate' | undefined } | { readonly minimum: globalThis.Date; readonly _tag?: 'isGreaterThanOrEqualToDate' | u…;
makeOption: (input: { readonly _tag?: 'isDateValid' | undefined } | { readonly exclusiveMinimum: globalThis.Date; readonly _tag?: 'isGreaterThanDate' | undefined } | { readonly minimum: globalThis.Date; readonly _tag?: 'isGreaterThanOrEqualToDate' | u…;
makeEffect: (input: { readonly _tag?: 'isDateValid' | undefined } | { readonly exclusiveMinimum: globalThis.Date; readonly _tag?: 'isGreaterThanDate' | undefined } | { readonly minimum: globalThis.Date; readonly _tag?: 'isGreaterThanOrEqualToDate' | u…;
pipe: { <A>(this: A): A; <A, B = never>(this: A, ab: (_: A) => B): B; <A, B = never, C = never>(this: A, ab: (_: A) => B, bc: (_: B) => C): C; <A, B = never, C = never, D = never>(this: A, ab: (_: A) => B, bc: (_: B) => C, cd: (_: C) => D): D; <…;
}
Schema for
DeclarationMeta
.
$DeclarationMeta = import SchemaSchema.function Union<
Members extends ReadonlyArray<Constraint>
>(
members: Members,
options?: { mode?: "anyOf" | "oneOf" }
): Union<Members>
Creates a union schema from an array of member schemas. Members are tested in
order; the first match is returned.
Details
Optionally, specify mode:
"anyOf" (default) — matches if any member matches."oneOf" — matches if exactly one member matches.
Example (Defining a string or number union)
import { Schema } from "effect"
const schema = Schema.Union([Schema.String, Schema.Number])
Schema.decodeUnknownSync(schema)("hello") // "hello"
Schema.decodeUnknownSync(schema)(42) // 42
Union([
const $DateMeta: Schema.Union<
readonly [
Schema.Struct<{
readonly _tag: Schema.tag<"isDateValid">
}>,
Schema.Struct<{
readonly _tag: Schema.tag<"isGreaterThanDate">
readonly exclusiveMinimum: Schema.Date
}>,
Schema.Struct<{
readonly _tag: Schema.tag<"isGreaterThanOrEqualToDate">
readonly minimum: Schema.Date
}>,
Schema.Struct<{
readonly _tag: Schema.tag<"isLessThanDate">
readonly exclusiveMaximum: Schema.Date
}>,
Schema.Struct<{
readonly _tag: Schema.tag<"isLessThanOrEqualToDate">
readonly maximum: Schema.Date
}>,
Schema.Struct<{
readonly _tag: Schema.tag<"isBetweenDate">
readonly minimum: Schema.Date
readonly maximum: Schema.Date
readonly exclusiveMinimum: Schema.optional<Schema.Boolean>
readonly exclusiveMaximum: Schema.optional<Schema.Boolean>
}>
]
>
const $DateMeta: {
Type: { [K in keyof Members]: Members[K]["Type"]; }[number];
Encoded: { [K in keyof Members]: Members[K]["Encoded"]; }[number];
DecodingServices: { [K in keyof Members]: Members[K]["DecodingServices"]; }[number];
EncodingServices: { [K in keyof Members]: Members[K]["EncodingServices"]; }[number];
Iso: { [K in keyof Members]: Members[K]["Iso"]; }[number];
members: Members;
mapMembers: (f: (members: readonly [Schema.Struct<{ readonly _tag: Schema.tag<'isDateValid'> }>, Schema.Struct<{ readonly _tag: Schema.tag<'isGreaterThanDate'>; readonly exclusiveMinimum: Schema.Date }>, Schema.Struct<{ readonly _tag: Schema.tag<'isGr…;
Rebuild: Rebuild;
ast: Ast;
annotate: (annotations: Schema.Annotations.Bottom<Schema.Struct.ReadonlySide<{ readonly _tag: Schema.tag<'isDateValid'>; }, 'Type'> | Schema.Struct.ReadonlySide<{ readonly _tag: Schema.tag<'isGreaterThanDate'>; readonly exclusiveMinimum: Schema.Date…;
annotateKey: (annotations: Schema.Annotations.Key<Schema.Struct.ReadonlySide<{ readonly _tag: Schema.tag<'isDateValid'> }, 'Type'> | Schema.Struct.ReadonlySide<{ readonly _tag: Schema.tag<'isGreaterThanDate'>; readonly exclusiveMinimum: Schema.Date }, …;
check: (checks_0: SchemaAST.Check<Schema.Struct.ReadonlySide<{ readonly _tag: Schema.tag<'isDateValid'> }, 'Type'> | Schema.Struct.ReadonlySide<{ readonly _tag: Schema.tag<'isGreaterThanDate'>; readonly exclusiveMinimum: Schema.Date }, 'Type'> | …;
rebuild: (ast: SchemaAST.Union<SchemaAST.Objects>) => Schema.Union<readonly [Schema.Struct<{ readonly _tag: Schema.tag<'isDateValid'> }>, Schema.Struct<{ readonly _tag: Schema.tag<'isGreaterThanDate'>; readonly exclusiveMinimum: Schema.Date }>, Sch…;
make: (input: { readonly _tag?: 'isDateValid' | undefined } | { readonly exclusiveMinimum: globalThis.Date; readonly _tag?: 'isGreaterThanDate' | undefined } | { readonly minimum: globalThis.Date; readonly _tag?: 'isGreaterThanOrEqualToDate' | u…;
makeOption: (input: { readonly _tag?: 'isDateValid' | undefined } | { readonly exclusiveMinimum: globalThis.Date; readonly _tag?: 'isGreaterThanDate' | undefined } | { readonly minimum: globalThis.Date; readonly _tag?: 'isGreaterThanOrEqualToDate' | u…;
makeEffect: (input: { readonly _tag?: 'isDateValid' | undefined } | { readonly exclusiveMinimum: globalThis.Date; readonly _tag?: 'isGreaterThanDate' | undefined } | { readonly minimum: globalThis.Date; readonly _tag?: 'isGreaterThanOrEqualToDate' | u…;
pipe: { <A>(this: A): A; <A, B = never>(this: A, ab: (_: A) => B): B; <A, B = never, C = never>(this: A, ab: (_: A) => B, bc: (_: B) => C): C; <A, B = never, C = never, D = never>(this: A, ab: (_: A) => B, bc: (_: B) => C, cd: (_: C) => D): D; <…;
}
Schema for
DateMeta
.
$DateMeta,
const $SizeMeta: Schema.Union<
readonly [
Schema.Struct<{
readonly _tag: Schema.tag<"isMinSize">
readonly minSize: Schema.Int
}>,
Schema.Struct<{
readonly _tag: Schema.tag<"isMaxSize">
readonly maxSize: Schema.Int
}>,
Schema.Struct<{
readonly _tag: Schema.tag<"isSizeBetween">
readonly minimum: Schema.Int
readonly maximum: Schema.Int
}>
]
>
const $SizeMeta: {
Type: { [K in keyof Members]: Members[K]["Type"]; }[number];
Encoded: { [K in keyof Members]: Members[K]["Encoded"]; }[number];
DecodingServices: { [K in keyof Members]: Members[K]["DecodingServices"]; }[number];
EncodingServices: { [K in keyof Members]: Members[K]["EncodingServices"]; }[number];
Iso: { [K in keyof Members]: Members[K]["Iso"]; }[number];
members: Members;
mapMembers: (f: (members: readonly [Schema.Struct<{ readonly _tag: Schema.tag<'isMinSize'>; readonly minSize: Schema.Int }>, Schema.Struct<{ readonly _tag: Schema.tag<'isMaxSize'>; readonly maxSize: Schema.Int }>, Schema.Struct<{ readonly _tag: Schema…;
Rebuild: Rebuild;
ast: Ast;
annotate: (annotations: Schema.Annotations.Bottom<Schema.Struct.ReadonlySide<{ readonly _tag: Schema.tag<'isMinSize'>; readonly minSize: Schema.Int; }, 'Type'> | Schema.Struct.ReadonlySide<{ readonly _tag: Schema.tag<'isMaxSize'>; readonly maxSize: …;
annotateKey: (annotations: Schema.Annotations.Key<Schema.Struct.ReadonlySide<{ readonly _tag: Schema.tag<'isMinSize'>; readonly minSize: Schema.Int }, 'Type'> | Schema.Struct.ReadonlySide<{ readonly _tag: Schema.tag<'isMaxSize'>; readonly maxSize: Sche…;
check: (checks_0: SchemaAST.Check<Schema.Struct.ReadonlySide<{ readonly _tag: Schema.tag<'isMinSize'>; readonly minSize: Schema.Int }, 'Type'> | Schema.Struct.ReadonlySide<{ readonly _tag: Schema.tag<'isMaxSize'>; readonly maxSize: Schema.Int }, …;
rebuild: (ast: SchemaAST.Union<SchemaAST.Objects>) => Schema.Union<readonly [Schema.Struct<{ readonly _tag: Schema.tag<'isMinSize'>; readonly minSize: Schema.Int }>, Schema.Struct<{ readonly _tag: Schema.tag<'isMaxSize'>; readonly maxSize: Schema.I…;
make: (input: { readonly minSize: number; readonly _tag?: 'isMinSize' | undefined } | { readonly maxSize: number; readonly _tag?: 'isMaxSize' | undefined } | { readonly minimum: number; readonly maximum: number; readonly _tag?: 'isSizeBetween' |…;
makeOption: (input: { readonly minSize: number; readonly _tag?: 'isMinSize' | undefined } | { readonly maxSize: number; readonly _tag?: 'isMaxSize' | undefined } | { readonly minimum: number; readonly maximum: number; readonly _tag?: 'isSizeBetween' |…;
makeEffect: (input: { readonly minSize: number; readonly _tag?: 'isMinSize' | undefined } | { readonly maxSize: number; readonly _tag?: 'isMaxSize' | undefined } | { readonly minimum: number; readonly maximum: number; readonly _tag?: 'isSizeBetween' |…;
pipe: { <A>(this: A): A; <A, B = never>(this: A, ab: (_: A) => B): B; <A, B = never, C = never>(this: A, ab: (_: A) => B, bc: (_: B) => C): C; <A, B = never, C = never, D = never>(this: A, ab: (_: A) => B, bc: (_: B) => C, cd: (_: C) => D): D; <…;
}
Schema for
SizeMeta
.
$SizeMeta
]).Bottom<unknown, unknown, unknown, unknown, Union<...>, Union<...>, ... 8 more ..., "required">.annotate(annotations: Schema.Annotations.Bottom<Schema.Struct<Fields extends Schema.Struct.Fields>.ReadonlySide<{
readonly _tag: Schema.tag<"isDateValid">;
}, "Type"> | Schema.Struct.ReadonlySide<{
readonly _tag: Schema.tag<"isGreaterThanDate">;
readonly exclusiveMinimum: Schema.Date;
}, "Type"> | Schema.Struct.ReadonlySide<{
readonly _tag: Schema.tag<"isGreaterThanOrEqualToDate">;
readonly minimum: Schema.Date;
}, "Type"> | Schema.Struct.ReadonlySide<{
readonly _tag: Schema.tag<"isLessThanDate">;
readonly exclusiveMaximum: Schema.Date;
}, "Type"> | ... 4 more ... | Schema.Struct.ReadonlySide<...>, readonly []>): Schema.Union<...>
Annotations.Bottom<T, TypeParameters extends ReadonlyArray<Constraint>>.identifier?: string | undefinedStable identifier for this schema node.
Details
Identifiers are used by schema tooling, including JSON Schema
generation, to name references. The default formatter also uses
identifier as the expected label for type-level failures, such as
Expected UserId, got null.
identifier does not name a failed filter or refinement. If the base
type matches and a filter fails, put expected or message on the
filter/refinement instead.
identifier: "DeclarationMeta" })Referenced by 1 symbols