effect-io-ai

Package: effect
Module: SchemaParser

SchemaParser.encodePromise

Creates a Promise-based encoder for input already typed as the schema’s decoded Type.

When to use

Use when you already have values typed as the schema’s decoded Type and need encoding to return a JavaScript Promise.

Details

The returned function resolves with the schema’s Encoded value on success and rejects with an Error whose cause is a SchemaIssue.Issue on encoding failure.

Gotchas

Causes that contain defects, interruptions, or other non-schema reasons reject with an Error whose cause is the underlying Cause.

See

• encodeUnknownPromise for encoding untyped input
• encodeEffect for effectful encoding or schemas with encoding service requirements

Signature

declare const encodePromise: <S extends Schema.ConstraintEncoder<unknown>>(schema: S, options?: SchemaAST.ParseOptions) => (input: S["Type"], options?: SchemaAST.ParseOptions) => Promise<S["Encoded"]>

Source

Since v3.10.0