• Preparing search index...
  • The search index is not available
@shopify/cli-kit
  • @shopify/cli-kit
  • node/api/partners
  • partnersRequest

Function partnersRequest

  • partnersRequest<T>(
        query: string,
        token: string,
        variables?: GraphQLVariables,
        cacheOptions?: CacheOptions,
        preferredBehaviour?: RequestModeInput,
        unauthorizedHandler?: UnauthorizedHandler,
    ): Promise<T>
  • Executes a GraphQL query against the Partners API.

    Type Parameters

    • T

    Parameters

    • query: string

      GraphQL query to execute.

    • token: string

      Partners token.

    • Optionalvariables: GraphQLVariables

      GraphQL variables to pass to the query.

    • OptionalcacheOptions: CacheOptions

      Cache options.

    • OptionalpreferredBehaviour: RequestModeInput

      Preferred behaviour for the request.

    • OptionalunauthorizedHandler: UnauthorizedHandler

      Optional handler for unauthorized requests.

    Returns Promise<T>

    The response of the query of generic type .

    • Defined in packages/cli-kit/src/public/node/api/partners.ts:57

Settings

Member Visibility
@shopify/cli-kit
  • Loading...

Generated using TypeDoc