Hyperlinkv0.8.0-beta.28

← SchemaParser

SchemaParser.encodeExitconsteffect/SchemaParser.ts:758
<S extends Schema.ConstraintEncoder<unknown>>(
  schema: S,
  options?: SchemaAST.ParseOptions
): (
  input: S["Type"],
  options?: SchemaAST.ParseOptions
) => Exit.Exit<S["Encoded"], SchemaIssue.Issue>

Creates a synchronous encoder for input already typed as the schema's decoded Type, reporting failure safely as an Exit.

When to use

Use when you need synchronous encoding of already typed schema values 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.

encodingencodeUnknownExitencodeEffect
Source effect/SchemaParser.ts:7585 lines
export const encodeExit: <S extends Schema.ConstraintEncoder<unknown>>(
  schema: S,
  options?: SchemaAST.ParseOptions
) => (input: S["Type"], options?: SchemaAST.ParseOptions) => Exit.Exit<S["Encoded"], SchemaIssue.Issue> =
  encodeUnknownExit