Type alias GraphQLOptionsV6<FALLBACK_TYPES, TYPED_GQL_STRING, Options>

GraphQLOptionsV6<FALLBACK_TYPES, TYPED_GQL_STRING, Options>: Options["endpoint"] extends string
    ? Options["apiKey"] extends string
        ? {
            apiKey?: string;
            authMode?: GraphQLAuthMode;
            authToken?: string;
            query: TYPED_GQL_STRING | DocumentNode;
            userAgentSuffix?: string;
            variables?: GraphQLVariablesV6<FALLBACK_TYPES, TYPED_GQL_STRING>;
        }
        : {
            apiKey?: never;
            authMode?: never;
            authToken?: string;
            query: TYPED_GQL_STRING | DocumentNode;
            userAgentSuffix?: string;
            variables?: GraphQLVariablesV6<FALLBACK_TYPES, TYPED_GQL_STRING>;
        } | {
            apiKey: string;
            authMode: "apiKey";
            authToken?: string;
            query: TYPED_GQL_STRING | DocumentNode;
            userAgentSuffix?: string;
            variables?: GraphQLVariablesV6<FALLBACK_TYPES, TYPED_GQL_STRING>;
        } | {
            apiKey?: never;
            authMode: Exclude<GraphQLAuthMode, "apiKey">;
            authToken?: string;
            query: TYPED_GQL_STRING | DocumentNode;
            userAgentSuffix?: string;
            variables?: GraphQLVariablesV6<FALLBACK_TYPES, TYPED_GQL_STRING>;
        }
    : {
        apiKey?: string;
        authMode?: GraphQLAuthMode;
        authToken?: string;
        query: TYPED_GQL_STRING | DocumentNode;
        userAgentSuffix?: string;
        variables?: GraphQLVariablesV6<FALLBACK_TYPES, TYPED_GQL_STRING>;
    }

API V6 graphql({options}) type that can leverage branded graphql query objects and fallback types.

Type Parameters

Settings

Member Visibility

Theme