Cause<E, D>Creates a schema for Cause values using separate schemas for typed failures
and unexpected defects.
When to use
Use to validate, transform, or serialize Effect failure causes when typed failures and unexpected defects need separate schemas.
Details
The error schema is applied to Fail reasons and the defect schema is
applied to Die reasons. Interrupt reasons do not use either schema and
carry only an optional fiber id.
export interface interface Cause<E extends Constraint, D extends Constraint>Creates a schema for Cause values using separate schemas for typed failures
and unexpected defects.
When to use
Use to validate, transform, or serialize Effect failure causes when typed
failures and unexpected defects need separate schemas.
Details
The error schema is applied to Fail reasons and the defect schema is
applied to Die reasons. Interrupt reasons do not use either schema and
carry only an optional fiber id.
Type-level representation returned by
Cause
.
Cause<function (type parameter) E in Cause<E extends Constraint, D extends Constraint>E extends Constraint, function (type parameter) D in Cause<E extends Constraint, D extends Constraint>D extends Constraint> extends
interface declareConstructor<T, E, TypeParameters extends ReadonlyArray<Constraint>, Iso = T>Creates a schema for a parametric type (a generic container such as
Array<A>, Option<A>, etc.) by accepting a list of type-parameter schemas
and a decoder factory.
When to use
Use when you are defining a schema for a generic container whose validation
depends on one or more type-parameter schemas.
Details
The outer call declareConstructor<T, E, Iso>() fixes the decoded type T,
the encoded type E, and the optional iso type. The inner call receives:
typeParameters — the concrete schemas for each type variable
run — a factory that, given resolved codecs for each type parameter,
returns a parsing function (u, ast, options) => Effect<T, Issue>
annotations — optional metadata
Type-level representation returned by
declareConstructor
.
declareConstructor<
import Cause_Cause_.type Cause_.Cause = /*unresolved*/ anyCause<function (type parameter) E in Cause<E extends Constraint, D extends Constraint>E["Type"]>,
import Cause_Cause_.type Cause_.Cause = /*unresolved*/ anyCause<function (type parameter) E in Cause<E extends Constraint, D extends Constraint>E["Encoded"]>,
readonly [function (type parameter) E in Cause<E extends Constraint, D extends Constraint>E, function (type parameter) D in Cause<E extends Constraint, D extends Constraint>D],
type CauseIso<
E extends Constraint,
D extends Constraint
> = readonly CauseReasonIso<E, D>[]
Iso representation used for Cause schemas: an ordered array of
CauseReasonIso values.
When to use
Use when working with the ISO shape of a Cause schema, such as toIso
optics or codecs that expose a cause as its ordered array of encoded reasons.
CauseIso<function (type parameter) E in Cause<E extends Constraint, D extends Constraint>E, function (type parameter) D in Cause<E extends Constraint, D extends Constraint>D>
>
{
readonly "Rebuild": interface Cause<E extends Constraint, D extends Constraint>Creates a schema for Cause values using separate schemas for typed failures
and unexpected defects.
When to use
Use to validate, transform, or serialize Effect failure causes when typed
failures and unexpected defects need separate schemas.
Details
The error schema is applied to Fail reasons and the defect schema is
applied to Die reasons. Interrupt reasons do not use either schema and
carry only an optional fiber id.
Type-level representation returned by
Cause
.
Cause<function (type parameter) E in Cause<E extends Constraint, D extends Constraint>E, function (type parameter) D in Cause<E extends Constraint, D extends Constraint>D>
readonly Cause<E extends Constraint, D extends Constraint>.error: E extends Constrainterror: function (type parameter) E in Cause<E extends Constraint, D extends Constraint>E
readonly Cause<E extends Constraint, D extends Constraint>.defect: D extends Constraintdefect: function (type parameter) D in Cause<E extends Constraint, D extends Constraint>D
}
/**
* Iso representation used for `Cause` schemas: an ordered array of
* `CauseReasonIso` values.
*
* **When to use**
*
* Use when working with the ISO shape of a `Cause` schema, such as `toIso`
* optics or codecs that expose a cause as its ordered array of encoded reasons.
*
* @see {@link Cause} for constructing schemas for full Cause values
* @see {@link CauseReasonIso} for the ISO shape of each array element
*
* @category Cause
* @since 4.0.0
*/
export type type CauseIso<
E extends Constraint,
D extends Constraint
> = readonly CauseReasonIso<E, D>[]
Iso representation used for Cause schemas: an ordered array of
CauseReasonIso values.
When to use
Use when working with the ISO shape of a Cause schema, such as toIso
optics or codecs that expose a cause as its ordered array of encoded reasons.
CauseIso<function (type parameter) E in type CauseIso<E extends Constraint, D extends Constraint>E extends Constraint, function (type parameter) D in type CauseIso<E extends Constraint, D extends Constraint>D extends Constraint> = interface ReadonlyArray<T>ReadonlyArray<type CauseReasonIso<
E extends Constraint,
D extends Constraint
> =
| {
readonly _tag: "Fail"
readonly error: E["Iso"]
}
| {
readonly _tag: "Die"
readonly error: D["Iso"]
}
| {
readonly _tag: "Interrupt"
readonly fiberId: number | undefined
}
Iso representation used for CauseReason schemas.
Details
Failures are represented with a Fail tag and encoded error, defects with a
Die tag and encoded defect, and interrupts with an optional fiberId.
CauseReasonIso<function (type parameter) E in type CauseIso<E extends Constraint, D extends Constraint>E, function (type parameter) D in type CauseIso<E extends Constraint, D extends Constraint>D>>
/**
* Creates a schema for `Cause` values using separate schemas for typed failures
* and unexpected defects.
*
* **When to use**
*
* Use to validate, transform, or serialize Effect failure causes when typed
* failures and unexpected defects need separate schemas.
*
* **Details**
*
* The `error` schema is applied to `Fail` reasons and the `defect` schema is
* applied to `Die` reasons. Interrupt reasons do not use either schema and
* carry only an optional fiber id.
*
* @see {@link CauseReason} for the schema used by each individual cause reason
* @see {@link CauseIso} for the ordered array representation used by the schema ISO
*
* @category Cause
* @since 3.10.0
*/
export function function Cause<
E extends Constraint,
D extends Constraint
>(error: E, defect: D): Cause<E, D>
Creates a schema for Cause values using separate schemas for typed failures
and unexpected defects.
When to use
Use to validate, transform, or serialize Effect failure causes when typed
failures and unexpected defects need separate schemas.
Details
The error schema is applied to Fail reasons and the defect schema is
applied to Die reasons. Interrupt reasons do not use either schema and
carry only an optional fiber id.
Cause<function (type parameter) E in Cause<E extends Constraint, D extends Constraint>(error: E, defect: D): Cause<E, D>E extends Constraint, function (type parameter) D in Cause<E extends Constraint, D extends Constraint>(error: E, defect: D): Cause<E, D>D extends Constraint>(error: E extends Constrainterror: function (type parameter) E in Cause<E extends Constraint, D extends Constraint>(error: E, defect: D): Cause<E, D>E, defect: D extends Constraintdefect: function (type parameter) D in Cause<E extends Constraint, D extends Constraint>(error: E, defect: D): Cause<E, D>D): interface Cause<E extends Constraint, D extends Constraint>Creates a schema for Cause values using separate schemas for typed failures
and unexpected defects.
When to use
Use to validate, transform, or serialize Effect failure causes when typed
failures and unexpected defects need separate schemas.
Details
The error schema is applied to Fail reasons and the defect schema is
applied to Die reasons. Interrupt reasons do not use either schema and
carry only an optional fiber id.
Type-level representation returned by
Cause
.
Cause<function (type parameter) E in Cause<E extends Constraint, D extends Constraint>(error: E, defect: D): Cause<E, D>E, function (type parameter) D in Cause<E extends Constraint, D extends Constraint>(error: E, defect: D): Cause<E, D>D> {
const const schema: declareConstructor<
Cause_.Cause<E["Type"]>,
Cause_.Cause<E["Encoded"]>,
readonly [E, D],
CauseIso<E, D>
>
const schema: {
Rebuild: Rebuild;
Iso: Iso;
ast: Ast;
Type: T;
Encoded: E;
DecodingServices: RD;
EncodingServices: RE;
annotate: (annotations: Annotations.Bottom<Cause_.Cause<E['Type']>, readonly [E, D]>) => declareConstructor<Cause_.Cause<E['Type']>, Cause_.Cause<E['Encoded']>, readonly [E, D], CauseIso<E, D>>;
annotateKey: (annotations: Annotations.Key<Cause_.Cause<E['Type']>>) => declareConstructor<Cause_.Cause<E['Type']>, Cause_.Cause<E['Encoded']>, readonly [E, D], CauseIso<E, D>>;
check: (checks_0: SchemaAST.Check<Cause_.Cause<E['Type']>>, ...checks: Array<SchemaAST.Check<Cause_.Cause<E['Type']>>>) => declareConstructor<Cause_.Cause<E['Type']>, Cause_.Cause<E['Encoded']>, readonly [E, D], CauseIso<E, D>>;
rebuild: (ast: SchemaAST.Declaration) => declareConstructor<Cause_.Cause<E['Type']>, Cause_.Cause<E['Encoded']>, readonly [E, D], CauseIso<E, D>>;
make: (input: Cause_.Cause<E['Type']>, options?: MakeOptions) => Cause_.Cause<E['Type']>;
makeOption: (input: Cause_.Cause<E['Type']>, options?: MakeOptions) => Option_.Option<Cause_.Cause<E['Type']>>;
makeEffect: (input: Cause_.Cause<E['Type']>, options?: MakeOptions) => Effect.Effect<Cause_.Cause<E['Type']>, SchemaError, never>;
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 = function declareConstructor<
T,
E = T,
Iso = T
>(): <
TypeParameters extends ReadonlyArray<Constraint>
>(
typeParameters: TypeParameters,
run: (typeParameters: {
readonly [K in keyof TypeParameters]: Codec<
TypeParameters[K]["Type"],
TypeParameters[K]["Encoded"]
>
}) => (
u: unknown,
self: SchemaAST.Declaration,
options: SchemaAST.ParseOptions
) => Effect.Effect<T, SchemaIssue.Issue>,
annotations?: Annotations.Declaration<
T,
TypeParameters
>
) => declareConstructor<T, E, TypeParameters, Iso>
Creates a schema for a parametric type (a generic container such as
Array<A>, Option<A>, etc.) by accepting a list of type-parameter schemas
and a decoder factory.
When to use
Use when you are defining a schema for a generic container whose validation
depends on one or more type-parameter schemas.
Details
The outer call declareConstructor<T, E, Iso>() fixes the decoded type T,
the encoded type E, and the optional iso type. The inner call receives:
typeParameters — the concrete schemas for each type variable
run — a factory that, given resolved codecs for each type parameter,
returns a parsing function (u, ast, options) => Effect<T, Issue>
annotations — optional metadata
declareConstructor<import Cause_Cause_.type Cause_.Cause = /*unresolved*/ anyCause<function (type parameter) E in Cause<E extends Constraint, D extends Constraint>(error: E, defect: D): Cause<E, D>E["Type"]>, import Cause_Cause_.type Cause_.Cause = /*unresolved*/ anyCause<function (type parameter) E in Cause<E extends Constraint, D extends Constraint>(error: E, defect: D): Cause<E, D>E["Encoded"]>, type CauseIso<
E extends Constraint,
D extends Constraint
> = readonly CauseReasonIso<E, D>[]
Iso representation used for Cause schemas: an ordered array of
CauseReasonIso values.
When to use
Use when working with the ISO shape of a Cause schema, such as toIso
optics or codecs that expose a cause as its ordered array of encoded reasons.
CauseIso<function (type parameter) E in Cause<E extends Constraint, D extends Constraint>(error: E, defect: D): Cause<E, D>E, function (type parameter) D in Cause<E extends Constraint, D extends Constraint>(error: E, defect: D): Cause<E, D>D>>()(
[error: E extends Constrainterror, defect: D extends Constraintdefect],
([error: Codec<
E["Type"],
E["Encoded"],
never,
never
>
(parameter) error: {
Encoded: E;
DecodingServices: RD;
EncodingServices: RE;
Rebuild: Codec<T, E, RD, RE>;
Type: T;
Iso: Iso;
ast: Ast;
annotate: (annotations: Annotations.Bottom<E['Type'], any>) => Codec<E['Type'], E['Encoded'], never, never>;
annotateKey: (annotations: Annotations.Key<E['Type']>) => Codec<E['Type'], E['Encoded'], never, never>;
check: (checks_0: SchemaAST.Check<E['Type']>, ...checks: Array<SchemaAST.Check<E['Type']>>) => Codec<E['Type'], E['Encoded'], never, never>;
rebuild: (ast: SchemaAST.AST) => Codec<E['Type'], E['Encoded'], never, never>;
make: (input: unknown, options?: MakeOptions) => E['Type'];
makeOption: (input: unknown, options?: MakeOptions) => Option_.Option<E['Type']>;
makeEffect: (input: unknown, options?: MakeOptions) => Effect.Effect<E['Type'], SchemaError, never>;
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; <…;
}
error, defect: Codec<
D["Type"],
D["Encoded"],
never,
never
>
(parameter) defect: {
Encoded: E;
DecodingServices: RD;
EncodingServices: RE;
Rebuild: Codec<T, E, RD, RE>;
Type: T;
Iso: Iso;
ast: Ast;
annotate: (annotations: Annotations.Bottom<D['Type'], any>) => Codec<D['Type'], D['Encoded'], never, never>;
annotateKey: (annotations: Annotations.Key<D['Type']>) => Codec<D['Type'], D['Encoded'], never, never>;
check: (checks_0: SchemaAST.Check<D['Type']>, ...checks: Array<SchemaAST.Check<D['Type']>>) => Codec<D['Type'], D['Encoded'], never, never>;
rebuild: (ast: SchemaAST.AST) => Codec<D['Type'], D['Encoded'], never, never>;
make: (input: unknown, options?: MakeOptions) => D['Type'];
makeOption: (input: unknown, options?: MakeOptions) => Option_.Option<D['Type']>;
makeEffect: (input: unknown, options?: MakeOptions) => Effect.Effect<D['Type'], SchemaError, never>;
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; <…;
}
defect]) => {
const const failures: $Array<
CauseReason<
Codec<E["Type"], E["Encoded"], never, never>,
Codec<D["Type"], D["Encoded"], never, never>
>
>
const failures: {
Type: ReadonlyArray<S["Type"]>;
Encoded: ReadonlyArray<S["Encoded"]>;
DecodingServices: S["DecodingServices"];
EncodingServices: S["EncodingServices"];
Iso: ReadonlyArray<S["Iso"]>;
value: S;
Rebuild: Rebuild;
ast: Ast;
annotate: (annotations: Annotations.Bottom<ReadonlyArray<Cause_.Reason<E['Type']>>, readonly []>) => $Array<CauseReason<Codec<E['Type'], E['Encoded'], never, never>, Codec<D['Type'], D['Encoded'], never, never>>>;
annotateKey: (annotations: Annotations.Key<ReadonlyArray<Cause_.Reason<E['Type']>>>) => $Array<CauseReason<Codec<E['Type'], E['Encoded'], never, never>, Codec<D['Type'], D['Encoded'], never, never>>>;
check: (checks_0: SchemaAST.Check<ReadonlyArray<Cause_.Reason<E['Type']>>>, ...checks: Array<SchemaAST.Check<ReadonlyArray<Cause_.Reason<E['Type']>>>>) => $Array<CauseReason<Codec<E['Type'], E['Encoded'], never, never>, Codec<D['Type'], D['Encode…;
rebuild: (ast: SchemaAST.Arrays) => $Array<CauseReason<Codec<E['Type'], E['Encoded'], never, never>, Codec<D['Type'], D['Encoded'], never, never>>>;
make: (input: ReadonlyArray<Cause_.Reason<E['Type']>>, options?: MakeOptions) => ReadonlyArray<Cause_.Reason<E['Type']>>;
makeOption: (input: ReadonlyArray<Cause_.Reason<E['Type']>>, options?: MakeOptions) => Option_.Option<ReadonlyArray<Cause_.Reason<E['Type']>>>;
makeEffect: (input: ReadonlyArray<Cause_.Reason<E['Type']>>, options?: MakeOptions) => Effect.Effect<ReadonlyArray<Cause_.Reason<E['Type']>>, SchemaError, never>;
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; <…;
}
failures = const ArraySchema: ArrayLambda
<CauseReason<Codec<E["Type"], E["Encoded"], never, never>, Codec<D["Type"], D["Encoded"], never, never>>>(self: CauseReason<Codec<E["Type"], E["Encoded"], never, never>, Codec<D["Type"], D["Encoded"], never, never>>) => $Array<CauseReason<Codec<E["Type"], E["Encoded"], never, never>, Codec<D["Type"], D["Encoded"], never, never>>>
ArraySchema(function CauseReason<
E extends Constraint,
D extends Constraint
>(error: E, defect: D): CauseReason<E, D>
Creates a schema for Cause.Reason values using separate schemas for typed
failures and unexpected defects.
When to use
Use when serializing or decoding individual cause reasons separately from a
full failure cause, with distinct schemas for typed errors and defects.
Details
Fail reasons use the error schema, Die reasons use the defect schema,
and Interrupt reasons carry only an optional fiber id.
CauseReason(error: Codec<
E["Type"],
E["Encoded"],
never,
never
>
(parameter) error: {
Encoded: E;
DecodingServices: RD;
EncodingServices: RE;
Rebuild: Codec<T, E, RD, RE>;
Type: T;
Iso: Iso;
ast: Ast;
annotate: (annotations: Annotations.Bottom<E['Type'], any>) => Codec<E['Type'], E['Encoded'], never, never>;
annotateKey: (annotations: Annotations.Key<E['Type']>) => Codec<E['Type'], E['Encoded'], never, never>;
check: (checks_0: SchemaAST.Check<E['Type']>, ...checks: Array<SchemaAST.Check<E['Type']>>) => Codec<E['Type'], E['Encoded'], never, never>;
rebuild: (ast: SchemaAST.AST) => Codec<E['Type'], E['Encoded'], never, never>;
make: (input: unknown, options?: MakeOptions) => E['Type'];
makeOption: (input: unknown, options?: MakeOptions) => Option_.Option<E['Type']>;
makeEffect: (input: unknown, options?: MakeOptions) => Effect.Effect<E['Type'], SchemaError, never>;
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; <…;
}
error, defect: Codec<
D["Type"],
D["Encoded"],
never,
never
>
(parameter) defect: {
Encoded: E;
DecodingServices: RD;
EncodingServices: RE;
Rebuild: Codec<T, E, RD, RE>;
Type: T;
Iso: Iso;
ast: Ast;
annotate: (annotations: Annotations.Bottom<D['Type'], any>) => Codec<D['Type'], D['Encoded'], never, never>;
annotateKey: (annotations: Annotations.Key<D['Type']>) => Codec<D['Type'], D['Encoded'], never, never>;
check: (checks_0: SchemaAST.Check<D['Type']>, ...checks: Array<SchemaAST.Check<D['Type']>>) => Codec<D['Type'], D['Encoded'], never, never>;
rebuild: (ast: SchemaAST.AST) => Codec<D['Type'], D['Encoded'], never, never>;
make: (input: unknown, options?: MakeOptions) => D['Type'];
makeOption: (input: unknown, options?: MakeOptions) => Option_.Option<D['Type']>;
makeEffect: (input: unknown, options?: MakeOptions) => Effect.Effect<D['Type'], SchemaError, never>;
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; <…;
}
defect))
return (input: unknowninput, ast: SchemaAST.Declaration(parameter) ast: {
_tag: 'Declaration';
typeParameters: ReadonlyArray<AST>;
run: (typeParameters: ReadonlyArray<AST>) => (input: unknown, self: Declaration, options: ParseOptions) => Effect.Effect<any, SchemaIssue.Issue, any>;
encodingChecks: Checks | undefined;
getParser: () => SchemaParser.Parser;
_rebuild: (recur: (ast: AST) => AST, checks: Checks | undefined, encodingChecks: Checks | undefined) => Declaration;
recur: (recur: (ast: AST) => AST) => Declaration;
flip: (recur: (ast: AST) => AST) => Declaration;
getExpected: () => string;
annotations: Schema.Annotations.Annotations | undefined;
checks: Checks | undefined;
encoding: Encoding | undefined;
context: Context | undefined;
toString: () => string;
}
ast, options: SchemaAST.ParseOptions(parameter) options: {
errors: "first" | "all" | undefined;
onExcessProperty: "ignore" | "error" | "preserve" | undefined;
propertyOrder: "none" | "original" | undefined;
disableChecks: boolean | undefined;
concurrency: number | "unbounded" | undefined;
}
options) => {
if (!import Cause_Cause_.isCause(input: unknowninput)) {
return import EffectEffect.fail(new import SchemaIssueSchemaIssue.constructor InvalidType(ast: SchemaAST.AST, actual: StandardJSONSchemaV1<unknown>): SchemaIssue.InvalidTypeRepresents a schema issue produced when the runtime type of the input does not match the type
expected by the schema (e.g. got null when string was expected).
When to use
Use when you need to detect basic type mismatches, such as a wrong primitive
or null where an object was expected.
Details
ast is the schema node that expected a different type.
actual is Option.some(value) when the input was present, or
Option.none() when no value was provided.
- The default formatter renders this as
"Expected <type>, got <actual>".
Example (Formatting output)
import { Schema } from "effect"
try {
Schema.decodeUnknownSync(Schema.String)(42)
} catch (e) {
if (Schema.isSchemaError(e)) {
console.log(String(e.issue))
// "Expected string, got 42"
}
}
InvalidType(ast: SchemaAST.Declaration(parameter) ast: {
_tag: 'Declaration';
typeParameters: ReadonlyArray<AST>;
run: (typeParameters: ReadonlyArray<AST>) => (input: unknown, self: Declaration, options: ParseOptions) => Effect.Effect<any, SchemaIssue.Issue, any>;
encodingChecks: Checks | undefined;
getParser: () => SchemaParser.Parser;
_rebuild: (recur: (ast: AST) => AST, checks: Checks | undefined, encodingChecks: Checks | undefined) => Declaration;
recur: (recur: (ast: AST) => AST) => Declaration;
flip: (recur: (ast: AST) => AST) => Declaration;
getExpected: () => string;
annotations: Schema.Annotations.Annotations | undefined;
checks: Checks | undefined;
encoding: Encoding | undefined;
context: Context | undefined;
toString: () => string;
}
ast, import Option_Option_.some(input: unknowninput)))
}
return import EffectEffect.mapBothEager(import SchemaParserSchemaParser.function decodeUnknownEffect<
S extends Schema.Constraint
>(
schema: S,
options?: SchemaAST.ParseOptions
): (
input: unknown,
options?: SchemaAST.ParseOptions
) => Effect.Effect<
S["Type"],
SchemaIssue.Issue,
S["DecodingServices"]
>
Creates an effectful decoder for unknown input.
When to use
Use when you need to decode untyped boundary input in an Effect whose
failure channel is SchemaIssue.Issue, while preserving transformations
and service requirements.
Details
The returned function succeeds with the schema's decoded Type or fails with a
SchemaIssue.Issue. Decoding service requirements are preserved in the returned
Effect. Parse options may be provided when creating the decoder and overridden
when applying it.
decodeUnknownEffect(const failures: $Array<
CauseReason<
Codec<E["Type"], E["Encoded"], never, never>,
Codec<D["Type"], D["Encoded"], never, never>
>
>
const failures: {
Type: ReadonlyArray<S["Type"]>;
Encoded: ReadonlyArray<S["Encoded"]>;
DecodingServices: S["DecodingServices"];
EncodingServices: S["EncodingServices"];
Iso: ReadonlyArray<S["Iso"]>;
value: S;
Rebuild: Rebuild;
ast: Ast;
annotate: (annotations: Annotations.Bottom<ReadonlyArray<Cause_.Reason<E['Type']>>, readonly []>) => $Array<CauseReason<Codec<E['Type'], E['Encoded'], never, never>, Codec<D['Type'], D['Encoded'], never, never>>>;
annotateKey: (annotations: Annotations.Key<ReadonlyArray<Cause_.Reason<E['Type']>>>) => $Array<CauseReason<Codec<E['Type'], E['Encoded'], never, never>, Codec<D['Type'], D['Encoded'], never, never>>>;
check: (checks_0: SchemaAST.Check<ReadonlyArray<Cause_.Reason<E['Type']>>>, ...checks: Array<SchemaAST.Check<ReadonlyArray<Cause_.Reason<E['Type']>>>>) => $Array<CauseReason<Codec<E['Type'], E['Encoded'], never, never>, Codec<D['Type'], D['Encode…;
rebuild: (ast: SchemaAST.Arrays) => $Array<CauseReason<Codec<E['Type'], E['Encoded'], never, never>, Codec<D['Type'], D['Encoded'], never, never>>>;
make: (input: ReadonlyArray<Cause_.Reason<E['Type']>>, options?: MakeOptions) => ReadonlyArray<Cause_.Reason<E['Type']>>;
makeOption: (input: ReadonlyArray<Cause_.Reason<E['Type']>>, options?: MakeOptions) => Option_.Option<ReadonlyArray<Cause_.Reason<E['Type']>>>;
makeEffect: (input: ReadonlyArray<Cause_.Reason<E['Type']>>, options?: MakeOptions) => Effect.Effect<ReadonlyArray<Cause_.Reason<E['Type']>>, SchemaError, never>;
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; <…;
}
failures)(input: Cause_.Cause<unknown>(parameter) input: {
reasons: ReadonlyArray<Reason<E>>;
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; <…;
toString: () => string;
toJSON: () => unknown;
}
input.reasons, options: SchemaAST.ParseOptions(parameter) options: {
errors: "first" | "all" | undefined;
onExcessProperty: "ignore" | "error" | "preserve" | undefined;
propertyOrder: "none" | "original" | undefined;
disableChecks: boolean | undefined;
concurrency: number | "unbounded" | undefined;
}
options), {
onSuccess: <E>(
reasons: ReadonlyArray<Reason<E>>
) => Cause<E>
onSuccess: import Cause_Cause_.fromReasons,
onFailure: (issue: any) => SchemaIssue.CompositeonFailure: (issue: SchemaIssue.Issueissue) =>
new import SchemaIssueSchemaIssue.constructor Composite(ast: SchemaAST.AST, actual: StandardJSONSchemaV1<unknown>, issues: readonly [SchemaIssue.Issue, ...Array<SchemaIssue.Issue>]): SchemaIssue.CompositeRepresents a schema issue that groups multiple child issues under a single schema node.
When to use
Use when you need to walk the issue tree for struct/tuple schemas that collect
all field errors rather than failing on the first.
Details
issues is a non-empty readonly array (at least one child).
actual is Option.some(value) when the input was present, or
Option.none() when absent.
- Formatters flatten
Composite by recursing into each child.
Composite(ast: SchemaAST.Declaration(parameter) ast: {
_tag: 'Declaration';
typeParameters: ReadonlyArray<AST>;
run: (typeParameters: ReadonlyArray<AST>) => (input: unknown, self: Declaration, options: ParseOptions) => Effect.Effect<any, SchemaIssue.Issue, any>;
encodingChecks: Checks | undefined;
getParser: () => SchemaParser.Parser;
_rebuild: (recur: (ast: AST) => AST, checks: Checks | undefined, encodingChecks: Checks | undefined) => Declaration;
recur: (recur: (ast: AST) => AST) => Declaration;
flip: (recur: (ast: AST) => AST) => Declaration;
getExpected: () => string;
annotations: Schema.Annotations.Annotations | undefined;
checks: Checks | undefined;
encoding: Encoding | undefined;
context: Context | undefined;
toString: () => string;
}
ast, import Option_Option_.some(input: Cause_.Cause<unknown>(parameter) input: {
reasons: ReadonlyArray<Reason<E>>;
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; <…;
toString: () => string;
toJSON: () => unknown;
}
input), [new import SchemaIssueSchemaIssue.constructor Pointer(path: ReadonlyArray<PropertyKey>, issue: SchemaIssue.Issue): SchemaIssue.PointerWraps an inner
Issue
with a property-key path, indicating where in
a nested structure the error occurred.
When to use
Use when you need to walk the issue tree to accumulate path segments for error
reporting.
Details
path is an array of property keys (strings, numbers, or symbols).
- Has no
actual value —
getActual
returns Option.none().
- Formatters concatenate nested
Pointer paths into a single path like
["a"]["b"][0].
Pointer(["failures"], issue: SchemaIssue.Issueissue)])
})
}
},
{
Annotations.Declaration<Cause_.Cause<E["Type"]>, readonly [E, D]>.typeConstructor?: {
readonly [key: string]: unknown;
readonly _tag: string;
} | undefined
typeConstructor: {
_tag: string_tag: "effect/Cause"
},
Annotations.Declaration<Cause_.Cause<E["Type"]>, readonly [E, D]>.generation?: {
readonly runtime: string;
readonly Type: string;
readonly Encoded?: string | undefined;
readonly importDeclaration?: string | undefined;
} | undefined
generation: {
runtime: stringruntime: `Schema.Cause(?, ?)`,
type Type: stringType: `Cause.Cause<?, ?>`,
importDeclaration?: string | undefinedimportDeclaration: `import * as Cause from "effect/Cause"`
},
Annotations.Augment.expected?: string | undefinedHuman-readable description of what a value is expected to satisfy.
Details
For filter and refinement failures, the default formatter uses
message first, then expected, and finally falls back to <filter>.
Use this to name a failed filter in the default message:
Expected <expected>, got <actual>.
expected: "Cause",
Annotations.Declaration<Cause_.Cause<E["Type"]>, readonly [E, D]>.toCodec?: ((typeParameters: readonly [Codec<E["Encoded"], E["Encoded"], never, never>, Codec<D["Encoded"], D["Encoded"], never, never>]) => SchemaAST.Link) | undefinedtoCodec: ([error: Codec<
E["Encoded"],
E["Encoded"],
never,
never
>
(parameter) error: {
Encoded: E;
DecodingServices: RD;
EncodingServices: RE;
Rebuild: Codec<T, E, RD, RE>;
Type: T;
Iso: Iso;
ast: Ast;
annotate: (annotations: Annotations.Bottom<E['Encoded'], any>) => Codec<E['Encoded'], E['Encoded'], never, never>;
annotateKey: (annotations: Annotations.Key<E['Encoded']>) => Codec<E['Encoded'], E['Encoded'], never, never>;
check: (checks_0: SchemaAST.Check<E['Encoded']>, ...checks: Array<SchemaAST.Check<E['Encoded']>>) => Codec<E['Encoded'], E['Encoded'], never, never>;
rebuild: (ast: SchemaAST.AST) => Codec<E['Encoded'], E['Encoded'], never, never>;
make: (input: unknown, options?: MakeOptions) => E['Encoded'];
makeOption: (input: unknown, options?: MakeOptions) => Option_.Option<E['Encoded']>;
makeEffect: (input: unknown, options?: MakeOptions) => Effect.Effect<E['Encoded'], SchemaError, never>;
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; <…;
}
error, defect: Codec<
D["Encoded"],
D["Encoded"],
never,
never
>
(parameter) defect: {
Encoded: E;
DecodingServices: RD;
EncodingServices: RE;
Rebuild: Codec<T, E, RD, RE>;
Type: T;
Iso: Iso;
ast: Ast;
annotate: (annotations: Annotations.Bottom<D['Encoded'], any>) => Codec<D['Encoded'], D['Encoded'], never, never>;
annotateKey: (annotations: Annotations.Key<D['Encoded']>) => Codec<D['Encoded'], D['Encoded'], never, never>;
check: (checks_0: SchemaAST.Check<D['Encoded']>, ...checks: Array<SchemaAST.Check<D['Encoded']>>) => Codec<D['Encoded'], D['Encoded'], never, never>;
rebuild: (ast: SchemaAST.AST) => Codec<D['Encoded'], D['Encoded'], never, never>;
make: (input: unknown, options?: MakeOptions) => D['Encoded'];
makeOption: (input: unknown, options?: MakeOptions) => Option_.Option<D['Encoded']>;
makeEffect: (input: unknown, options?: MakeOptions) => Effect.Effect<D['Encoded'], SchemaError, never>;
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; <…;
}
defect]) =>
function link<T>(): <
To extends Constraint
>(
encodeTo: To,
transformation: {
readonly decode: SchemaGetter.Getter<
T,
NoInfer<To["Type"]>
>
readonly encode: SchemaGetter.Getter<
NoInfer<To["Type"]>,
T
>
}
) => SchemaAST.Link
Constructs an SchemaAST.Link that describes how a value of type T encodes to and decodes from a To schema.
Used when building low-level AST transformations that bridge two schema types.
link<import Cause_Cause_.type Cause_.Cause = /*unresolved*/ anyCause<function (type parameter) E in Cause<E extends Constraint, D extends Constraint>(error: E, defect: D): Cause<E, D>E["Encoded"]>>()(
const ArraySchema: ArrayLambda
<CauseReason<Codec<E["Encoded"], E["Encoded"], never, never>, Codec<D["Encoded"], D["Encoded"], never, never>>>(self: CauseReason<Codec<E["Encoded"], E["Encoded"], never, never>, Codec<D["Encoded"], D["Encoded"], never, never>>) => $Array<CauseReason<Codec<E["Encoded"], E["Encoded"], never, never>, Codec<D["Encoded"], D["Encoded"], never, never>>>
ArraySchema(function CauseReason<
E extends Constraint,
D extends Constraint
>(error: E, defect: D): CauseReason<E, D>
Creates a schema for Cause.Reason values using separate schemas for typed
failures and unexpected defects.
When to use
Use when serializing or decoding individual cause reasons separately from a
full failure cause, with distinct schemas for typed errors and defects.
Details
Fail reasons use the error schema, Die reasons use the defect schema,
and Interrupt reasons carry only an optional fiber id.
CauseReason(error: Codec<
E["Encoded"],
E["Encoded"],
never,
never
>
(parameter) error: {
Encoded: E;
DecodingServices: RD;
EncodingServices: RE;
Rebuild: Codec<T, E, RD, RE>;
Type: T;
Iso: Iso;
ast: Ast;
annotate: (annotations: Annotations.Bottom<E['Encoded'], any>) => Codec<E['Encoded'], E['Encoded'], never, never>;
annotateKey: (annotations: Annotations.Key<E['Encoded']>) => Codec<E['Encoded'], E['Encoded'], never, never>;
check: (checks_0: SchemaAST.Check<E['Encoded']>, ...checks: Array<SchemaAST.Check<E['Encoded']>>) => Codec<E['Encoded'], E['Encoded'], never, never>;
rebuild: (ast: SchemaAST.AST) => Codec<E['Encoded'], E['Encoded'], never, never>;
make: (input: unknown, options?: MakeOptions) => E['Encoded'];
makeOption: (input: unknown, options?: MakeOptions) => Option_.Option<E['Encoded']>;
makeEffect: (input: unknown, options?: MakeOptions) => Effect.Effect<E['Encoded'], SchemaError, never>;
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; <…;
}
error, defect: Codec<
D["Encoded"],
D["Encoded"],
never,
never
>
(parameter) defect: {
Encoded: E;
DecodingServices: RD;
EncodingServices: RE;
Rebuild: Codec<T, E, RD, RE>;
Type: T;
Iso: Iso;
ast: Ast;
annotate: (annotations: Annotations.Bottom<D['Encoded'], any>) => Codec<D['Encoded'], D['Encoded'], never, never>;
annotateKey: (annotations: Annotations.Key<D['Encoded']>) => Codec<D['Encoded'], D['Encoded'], never, never>;
check: (checks_0: SchemaAST.Check<D['Encoded']>, ...checks: Array<SchemaAST.Check<D['Encoded']>>) => Codec<D['Encoded'], D['Encoded'], never, never>;
rebuild: (ast: SchemaAST.AST) => Codec<D['Encoded'], D['Encoded'], never, never>;
make: (input: unknown, options?: MakeOptions) => D['Encoded'];
makeOption: (input: unknown, options?: MakeOptions) => Option_.Option<D['Encoded']>;
makeEffect: (input: unknown, options?: MakeOptions) => Effect.Effect<D['Encoded'], SchemaError, never>;
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; <…;
}
defect)),
import SchemaTransformationSchemaTransformation.function transform<T, E>(options: {
readonly decode: (input: E) => T
readonly encode: (input: T) => E
}): Transformation<T, E>
Creates a Transformation from pure (sync, infallible) decode and encode
functions.
When to use
Use when you need an infallible schema transformation that does not require
Effect services.
Details
- Each function receives the input and returns the output directly.
- Skips
None inputs (missing keys) — functions are only called on present values.
- Does not allocate Effects internally; uses optimized sync path.
Example (Converting between cents and dollars)
import { Schema, SchemaTransformation } from "effect"
const CentsFromDollars = Schema.Number.pipe(
Schema.decodeTo(
Schema.Number,
SchemaTransformation.transform({
decode: (dollars) => dollars * 100,
encode: (cents) => cents / 100
})
)
)
transform({
decode: <E>(
reasons: ReadonlyArray<Reason<E>>
) => Cause<E>
decode: import Cause_Cause_.fromReasons,
encode: (input: any) => anyencode: ({ reasons: failures: ReadonlyArray<
Cause_.Reason<E["Encoded"]>
>
failures }) => failures: ReadonlyArray<
Cause_.Reason<E["Encoded"]>
>
failures
})
),
Annotations.Declaration<Cause_.Cause<E["Type"]>, readonly [E, D]>.toArbitrary?: Annotations.ToArbitrary.Declaration<Cause_.Cause<E["Type"]>, readonly [E, D]> | undefinedtoArbitrary: ([error: Annotations.ToArbitrary.TypeParameter<
E["Type"]
>
(parameter) error: {
arbitrary: FastCheck.Arbitrary<T>;
terminal: FastCheck.Arbitrary<T> | undefined;
}
error, defect: Annotations.ToArbitrary.TypeParameter<
D["Type"]
>
(parameter) defect: {
arbitrary: FastCheck.Arbitrary<T>;
terminal: FastCheck.Arbitrary<T> | undefined;
}
defect]) => function causeToArbitrary<E["Type"], D["Type"]>(error: Annotations.ToArbitrary.TypeParameter<E["Type"]>, defect: Annotations.ToArbitrary.TypeParameter<D["Type"]>): (fc: typeof FastCheck, ctx: Annotations.ToArbitrary.Context) => {
arbitrary: any;
terminal: any;
}
causeToArbitrary(error: Annotations.ToArbitrary.TypeParameter<
E["Type"]
>
(parameter) error: {
arbitrary: FastCheck.Arbitrary<T>;
terminal: FastCheck.Arbitrary<T> | undefined;
}
error, defect: Annotations.ToArbitrary.TypeParameter<
D["Type"]
>
(parameter) defect: {
arbitrary: FastCheck.Arbitrary<T>;
terminal: FastCheck.Arbitrary<T> | undefined;
}
defect),
Annotations.Declaration<Cause_.Cause<E["Type"]>, readonly [E, D]>.toEquivalence?: Annotations.ToEquivalence.Declaration<Cause_.Cause<E["Type"]>, readonly [E, D]> | undefinedtoEquivalence: ([error: Equivalence.Equivalence<E["Type"]>error, defect: Equivalence.Equivalence<D["Type"]>defect]) => function causeToEquivalence<E>(
error: Equivalence.Equivalence<E>,
defect: Equivalence.Equivalence<unknown>
): (
a: Cause_.Cause<E>,
b: Cause_.Cause<E>
) => boolean
causeToEquivalence(error: Equivalence.Equivalence<E["Type"]>error, defect: Equivalence.Equivalence<D["Type"]>defect),
Annotations.Declaration<Cause_.Cause<E["Type"]>, readonly [E, D]>.toFormatter?: Annotations.ToFormatter.Declaration<Cause_.Cause<E["Type"]>, readonly [E, D]> | undefinedtoFormatter: ([error: Formatter<E["Type"], string>error, defect: Formatter<D["Type"], string>defect]) => function causeToFormatter<E>(
error: Formatter<E>,
defect: Formatter<unknown>
): (t: Cause_.Cause<E>) => string
causeToFormatter(error: Formatter<E["Type"], string>error, defect: Formatter<D["Type"], string>defect)
}
)
return const make: <S extends Constraint>(
ast: S["ast"],
options?: object
) => S
Creates a schema from an AST (Abstract Syntax Tree) node.
Details
This is the fundamental constructor for all schemas in the Effect Schema
library. It takes an AST node and wraps it in a fully-typed schema that
preserves all type information and provides the complete schema API.
The make function is used internally to create all primitive schemas like
String, Number, Boolean, etc., as well as more complex schemas. It's
the bridge between the untyped AST representation and the strongly-typed
schema.
make(const schema: declareConstructor<
Cause_.Cause<E["Type"]>,
Cause_.Cause<E["Encoded"]>,
readonly [E, D],
CauseIso<E, D>
>
const schema: {
Rebuild: Rebuild;
Iso: Iso;
ast: Ast;
Type: T;
Encoded: E;
DecodingServices: RD;
EncodingServices: RE;
annotate: (annotations: Annotations.Bottom<Cause_.Cause<E['Type']>, readonly [E, D]>) => declareConstructor<Cause_.Cause<E['Type']>, Cause_.Cause<E['Encoded']>, readonly [E, D], CauseIso<E, D>>;
annotateKey: (annotations: Annotations.Key<Cause_.Cause<E['Type']>>) => declareConstructor<Cause_.Cause<E['Type']>, Cause_.Cause<E['Encoded']>, readonly [E, D], CauseIso<E, D>>;
check: (checks_0: SchemaAST.Check<Cause_.Cause<E['Type']>>, ...checks: Array<SchemaAST.Check<Cause_.Cause<E['Type']>>>) => declareConstructor<Cause_.Cause<E['Type']>, Cause_.Cause<E['Encoded']>, readonly [E, D], CauseIso<E, D>>;
rebuild: (ast: SchemaAST.Declaration) => declareConstructor<Cause_.Cause<E['Type']>, Cause_.Cause<E['Encoded']>, readonly [E, D], CauseIso<E, D>>;
make: (input: Cause_.Cause<E['Type']>, options?: MakeOptions) => Cause_.Cause<E['Type']>;
makeOption: (input: Cause_.Cause<E['Type']>, options?: MakeOptions) => Option_.Option<Cause_.Cause<E['Type']>>;
makeEffect: (input: Cause_.Cause<E['Type']>, options?: MakeOptions) => Effect.Effect<Cause_.Cause<E['Type']>, SchemaError, never>;
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.Bottom<Cause_.Cause<E["Type"]>, Cause_.Cause<E["Encoded"]>, (E | D)["DecodingServices"], (E | D)["EncodingServices"], Declaration, declareConstructor<Cause_.Cause<E["Type"]>, Cause_.Cause<E["Encoded"]>, readonly [...], CauseIso<...>>, ... 8 more ..., "required">["ast"]: SchemaAST.Declaration(property) Bottom<Cause_.Cause<E["Type"]>, Cause_.Cause<E["Encoded"]>, (E | D)["DecodingServices"], (E | D)["EncodingServices"], Declaration, declareConstructor<Cause_.Cause<E["Type"]>, Cause_.Cause<E["Encoded"]>, readonly [...], CauseIso<...>>, ... 8 more ..., "required">["ast"]: {
_tag: 'Declaration';
typeParameters: ReadonlyArray<AST>;
run: (typeParameters: ReadonlyArray<AST>) => (input: unknown, self: Declaration, options: ParseOptions) => Effect.Effect<any, SchemaIssue.Issue, any>;
encodingChecks: Checks | undefined;
getParser: () => SchemaParser.Parser;
_rebuild: (recur: (ast: AST) => AST, checks: Checks | undefined, encodingChecks: Checks | undefined) => Declaration;
recur: (recur: (ast: AST) => AST) => Declaration;
flip: (recur: (ast: AST) => AST) => Declaration;
getExpected: () => string;
annotations: Schema.Annotations.Annotations | undefined;
checks: Checks | undefined;
encoding: Encoding | undefined;
context: Context | undefined;
toString: () => string;
}
ast, { error: E extends Constrainterror, defect: D extends Constraintdefect })
}