ACP v2 TypeScript SDK — EXPERIMENTAL DRAFT - v1.3.0
    Preparing search index...

    Variable StateUpdateExperimental

    StateUpdate: {
        isRunning(
            value: StateUpdate,
        ): value is RunningStateUpdate & { state: "running" };
        isIdle(value: StateUpdate): value is IdleStateUpdate & { state: "idle" };
        isRequiresAction(
            value: StateUpdate,
        ): value is RequiresActionStateUpdate & { state: "requires_action" };
        isCustom(
            value: StateUpdate,
        ): value is { state: string; [key: string]: unknown };
    }

    Validated type guards for StateUpdate's known variants.

    Each guard validates the variant's payload, not just its discriminant tag: a malformed known variant (right tag, wrong payload) matches no guard — mirroring wire validation, which rejects such values instead of classifying them as custom.

    Guards check the value as given: fields that wire deserialization salvages to a default (e.g. a malformed _meta) are only normalized by parsing, and for ambiguous raw shapes (a known tag combined with another variant's payload) guards are conservative where wire parsing may still accept the value — narrow wire-parsed values when exact parity matters.

    Type Declaration

    • isRunning: function
    • isIdle: function
    • isRequiresAction: function
    • isCustom: function
      • Narrow to a custom or future variant: the state tag matches no known variant.

        TypeScript keeps the known variants in the narrowed union (they are structural subtypes of the catch-all), so read vendor payload keys via a widening cast: (value as Record<string, unknown>).someKey.

        Parameters

        • value: StateUpdate

        Returns value is { state: string; [key: string]: unknown }