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

    Variable SessionConfigOptionExperimental

    SessionConfigOption: {
        isSelect(
            value: SessionConfigOption,
        ): value is SessionConfigSelect & { type: "select" } & Pick<
            SessionConfigOption,
            "_meta"
            | "description"
            | "name"
            | "category"
            | "configId",
        >;
        isBoolean(
            value: SessionConfigOption,
        ): value is SessionConfigBoolean & { type: "boolean" } & Pick<
            SessionConfigOption,
            "_meta"
            | "description"
            | "name"
            | "category"
            | "configId",
        >;
        isCustom(
            value: SessionConfigOption,
        ): value is { type: string; [key: string]: unknown } & Pick<
            SessionConfigOption,
            "_meta"
            | "description"
            | "name"
            | "category"
            | "configId",
        >;
    }

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

    • isSelect: function
      • Narrow to the select variant, validating its payload.

        Parameters

        • value: SessionConfigOption

        Returns value is SessionConfigSelect & { type: "select" } & Pick<
            SessionConfigOption,
            "_meta"
            | "description"
            | "name"
            | "category"
            | "configId",
        >

    • isBoolean: function
      • Narrow to the boolean variant, validating its payload.

        Parameters

        • value: SessionConfigOption

        Returns value is SessionConfigBoolean & { type: "boolean" } & Pick<
            SessionConfigOption,
            "_meta"
            | "description"
            | "name"
            | "category"
            | "configId",
        >

    • 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: SessionConfigOption

        Returns value is { type: string; [key: string]: unknown } & Pick<
            SessionConfigOption,
            "_meta"
            | "description"
            | "name"
            | "category"
            | "configId",
        >