SchemaCompiler

The operations installed for an AST in the shared Schema parser registry.

Details

decodeEffect is required for complete decoding and detailed failures. decode, is, and make are optional optimizations, not requirements for an AST to be usable. The interpreter supplies only decodeEffect in this same format. An optional makeEffect supplies complete node construction. Otherwise the registry prepares and caches the interpreted constructor, never the decoder, for that operation. Public makers resolve the schema's exact type-side AST.

The registry wraps these operations in an internal entry. Decoding tries decode when present, returning its output on success or calling decodeEffect after invalid. Without decode, or for the missing sentinel, it calls decodeEffect directly. Type guards prefer is; otherwise they use ordinary decoding with the same fast-path/diagnostic fallback. A boolean false from is needs no diagnostic replay. Synchronous decoding and encoding share an adapter that returns successful decode output directly, without wrapping it in an intermediate Effect. Each operation is resolved lazily on first use, so unused fast paths need not be compiled. Synchronous construction tries make when present, returning its output on success or calling makeEffect after invalid. Compilers must omit make when replay could repeat observable construction work. Construction never uses is or decode. Field/element defaults belong to the parent occurrence, not to the root node or a Union member. Runtime options apply to construction too; Union candidate selection preserves the constructor's conservative handling of absent discriminants.

A compiled decoder that returns the decoded value without constructing diagnostic issues.

Details

This optional synchronous fast path lets valid inputs return their output without the detailed decoding pass. For decoding, the registry follows invalid with decodeEffect because the sentinel provides no error details and can also occur as a valid input value. Type guards without an is operation use this same fallback. Omit this operation when the fast path is unsupported or replay would be unsafe, including ASTs containing transformations or middleware.

It must honor every supported ParseOptions value. Return invalid for invalid input, never for an unsupported optimization. The detailed decoder must also accept valid data that happens to equal this marker. Do not call the detailed decoder and discard its failure: decoding would run decodeEffect again after invalid. User checks may themselves construct issues.

A compiled decoder that returns detailed Schema issues on failure.

Details

This required operation implements complete decoding for its AST, including transformations, middleware, and asynchronous work when present. It makes every parser API usable without optional fast paths and provides diagnostics after decode returns invalid. The implementation can also be interpreted; invoking decodeEffect does not imply a switch from compiled to interpreted parsing.

A compiled boolean validator.

Details

This optional fast path avoids constructing output. Omit it when validation requires reconstructed values, such as a Struct check that must see the object after excess properties are removed. Type guards then use ordinary decoding, including decode and its diagnostic fallback when available. It must honor the supplied parse options; public Schema.is and SchemaParser.is use the defaults.

A compiled constructor that returns the constructed value without detailed diagnostic issues.

Details

This optional synchronous fast path lets construction return directly when it succeeds. Return invalid to let makeEffect produce the normal detailed result. Implementations must be deterministic and free of side effects because a failed construction can be repeated by makeEffect.

Omit this operation when construction can execute defaults, Class constructors, transformations, middleware, or other effects that cannot be replayed safely. The operation must honor the supplied parse options and propagate missing when no value is produced.

A complete constructor that returns detailed Schema issues on failure.

Installs a compiled decoder for an exact AST in the shared Schema parser registry.

Details

A later call for the same AST replaces the previous entry. Parser functions that have already resolved and retained an earlier entry are not updated. This also applies when subsequent calls use different parse options. The decoder is trusted to implement the semantics of the supplied AST. Installation does not evaluate operation getters. Each operation, including an absent optional operation, is resolved once when first needed. Accessors retain the supplied decoder as their receiver. The supplied object is not mutated. JIT installation uses these same rules. Replacement includes construction: omitting makeEffect in the replacement selects interpreted detailed construction for new consumers, without merging the old operation into the new entry. An installed make can still handle synchronous successes. Already captured constructors keep their entry.

The result returned by Decode or Make when the fast path fails.

The sentinel distinguishing an absent input from a present undefined. Decoders and constructors propagate it as a successful result when no value is produced. Parents omit optional fields or report missing required keys; public root adapters reject it rather than returning it to callers.