effect-io-ai

Package: effect
Module: SchemaParser

SchemaParser.encodeUnknownExit

Creates a synchronous encoder for unknown input that reports failure safely as an Exit.

When to use

Use when you need synchronous encoding of unknown input into an Exit whose failure contains SchemaIssue.Issue.

Details

The returned function produces Exit.Success with the schema’s Encoded value or Exit.Failure with a SchemaIssue.Issue.

Gotchas

Because this adapter runs synchronously, async encoding work can produce an Exit.Failure with a defect cause. When the cause contains both schema issues and non-schema reasons, all reasons remain in the returned Cause.

See

• encodeExit for input already typed as the schema’s decoded Type
• encodeUnknownEffect for effectful encoding that preserves service requirements

Signature

declare const encodeUnknownExit: <S extends Schema.ConstraintEncoder<unknown>>(schema: S, options?: SchemaAST.ParseOptions) => (input: unknown, options?: SchemaAST.ParseOptions) => Exit.Exit<S["Encoded"], SchemaIssue.Issue>

Source

Since v4.0.0