effect-io-ai

Package: effect
Module: SchemaIssue

SchemaIssue.UnexpectedKey

Represents a schema issue produced when an input object or tuple contains a key/index not declared by the schema.

When to use

Use when you need to detect excess properties during strict struct/tuple validation.

Details

• actual is the raw value at the unexpected key (plain unknown).
• ast is the schema that was being validated against.
• annotations on ast may contain a custom messageUnexpectedKey.

See

• MissingKey — the opposite case (required key absent)
• Pointer — wraps this issue with the unexpected key’s path

Signature

declare class UnexpectedKey { constructor(
    /**
     * The schema that caused the issue.
     */
    ast: SchemaAST.AST,
    /**
     * The input value that caused the issue.
     */
    actual: unknown
  ) }

Source

Since v4.0.0