A11 TypeScript API - v0.7.0
    Preparing search index...

    Class ActionSchema

    Typed port and header contract for an Action.

    A schema is the stable boundary between callers and handlers: it names the operation, defines input/output AsyncNodes, declares metadata headers, and optionally maps outputs into an LLM/tool JSON result. Registries use the schema to instantiate local handlers. A remote call sends the action name and port mappings, not this schema; the peer resolves its own registration, so caller and receiver schemas must agree on the wire-facing contract.

    Index
    description: string

    Developer and model-facing operation description.

    headers: Map<string, ActionHeaderSchema>

    Named binary metadata contracts.

    inputs: Map<string, ActionPortSchema>

    Named input contracts.

    name: string

    Registered operation name.

    outputs: Map<string, ActionPortSchema>

    Named output contracts.

    outputToJsonField: Map<string, string>

    Output ports mapped to tool-result JSON fields.

    • Map an output into a JSON field, or $ as the whole result value.

      Parameters

      • outputName: string
      • fieldName: string = ''

      Returns Status