@aws-amplify/api

Functions

• generateClient()

Type Aliases

• Client

function generateClient

generateClient: {
    <
        T extends Record<any, any> = never,
        Options extends CommonPublicClientOptions = DefaultCommonClientOptions
    >(
        ctx: AmplifyContext,
        options?: Options
    ): V6Client<T, Options>;
    <
        T extends Record<any, any> = never,
        Options extends CommonPublicClientOptions = DefaultCommonClientOptions
    >(
        options?: Options
    ): V6Client<T, Options>;
};

• Generates an API client bound to a specific AmplifyContext instead of the global Amplify singleton. Use this overload when you need to scope a client to an explicit context (e.g. multi-tenant or server-side rendering scenarios) rather than the shared singleton configuration.

  Parameter ctx

  The AmplifyContext the client should resolve its configuration and auth from.

  Parameter options

  Optional client options.

  Returns

  V6Client

  Throws

  Error - Throws error when client cannot be generated due to configuration issues.

  Example 1

  import { generateClient } from 'aws-amplify/api';
  // `listTodos` is a generated GraphQL query document (from your API's codegen output).
  
  const client = generateClient(ctx);
  const result = await client.graphql({ query: listTodos });

• Generates an API client that can work with models or raw GraphQL

  Returns

  V6Client

  Throws

  Error - Throws error when client cannot be generated due to configuration issues.

type Client

type Client<T extends Record<any, any> = never> = V6Client<T>;