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

    Variable PlanUpdateContentExperimental

    PlanUpdateContent: {
        isItems(
            value: PlanUpdateContent,
        ): value is PlanItems & { type: "items" };
        isFile(value: PlanUpdateContent): value is PlanFile & { type: "file" };
        isMarkdown(
            value: PlanUpdateContent,
        ): value is PlanMarkdown & { type: "markdown" };
        isCustom(
            value: PlanUpdateContent,
        ): value is { type: string; [key: string]: unknown } & { planId: string };
    }

    Validated type guards for PlanUpdateContent'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

    • isItems: function
      • Narrow to the items variant, validating its payload.

        Parameters

        • value: PlanUpdateContent

        Returns value is PlanItems & { type: "items" }

    • isFile: function
      • Narrow to the file variant, validating its payload.

        Parameters

        • value: PlanUpdateContent

        Returns value is PlanFile & { type: "file" }

    • isMarkdown: function
      • Narrow to the markdown variant, validating its payload.

        Parameters

        • value: PlanUpdateContent

        Returns value is PlanMarkdown & { type: "markdown" }

    • isCustom: function
      • Narrow to a custom or future variant: the type tag matches no known variant, with a valid payload.

        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: PlanUpdateContent

        Returns value is { type: string; [key: string]: unknown } & { planId: string }