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

Function partnersRequestDoc

  • partnersRequestDoc<TResult, TVariables extends Variables>(
        query: TypedDocumentNode<TResult, TVariables>,
        token: string,
        variables?: TVariables,
        preferredBehaviour?: RequestModeInput,
        unauthorizedHandler?: UnauthorizedHandler,
    ): Promise<TResult>
  • Executes a GraphQL query against the Partners API. Uses typed documents.

    Type Parameters

    • TResult
    • TVariables extends Variables

    Parameters

    • query: TypedDocumentNode<TResult, TVariables>

      GraphQL query to execute.

    • token: string

      Partners token.

    • Optionalvariables: TVariables

      GraphQL variables to pass to the query.

    • OptionalpreferredBehaviour: RequestModeInput

      Preferred behaviour for the request.

    • OptionalunauthorizedHandler: UnauthorizedHandler

      Optional handler for unauthorized requests.

    Returns Promise<TResult>

    The response of the query of generic type .

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

Settings

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

Generated using TypeDoc