Interface ApiClientManager

Manages one or more GraphQL client instances that may be shared by multiple service clients, depending on their configuration.

interface ApiClientManager {
    getApiClientConfig(configNamespace?: string): ApiClientConfig;
    getClient(options?: ClientOptions): GraphQLClient;
    reset(): Promise<void>;
    setAuthClient(authClient: SudoUserClient): ApiClientManager;
    setConfig(config: ApiClientConfig): ApiClientManager;
    unsetConfig(): void;
}

Implemented by

DefaultApiClientManager

Index

Methods

getApiClientConfig getClient reset setAuthClient setConfig unsetConfig

Methods

getApiClientConfig

getApiClientConfig(configNamespace?: string): ApiClientConfig
Returns the default client config associated with the provided configNamespace, or the default configNamespace if none is provided.
Parameters
- OptionalconfigNamespace: string
  The namespace of the config to retrieve the default client options for.
Returns ApiClientConfig
The default client config associated with the provided configNamespace, or the default configNamespace if none is provided.
- Defined in src/defaultApiClientManager.ts:83

getClient

getClient(options?: ClientOptions): GraphQLClient
Create and fetch a new GraphQL client.
Parameters
- Optionaloptions: ClientOptions
  ClientOptions for configuring AmplifyClient connection and location
Returns GraphQLClient
GraphQLClient

Throws
ConfigurationNotSetError

Throws
SudoUserClientNotSetError
- Defined in src/defaultApiClientManager.ts:73

reset

reset(): Promise<void>
Clears caches on the client

Returns Promise<void>
- Defined in src/defaultApiClientManager.ts:88

setAuthClient

setAuthClient(authClient: SudoUserClient): ApiClientManager
Set an auth client that contains a jwtToken refresh method called getLatestAuthToken() of type string | (() => string | Promise<string>)
Parameters
- authClient: SudoUserClient
Returns ApiClientManager
Instance of this client manager
- Defined in src/defaultApiClientManager.ts:47

setConfig

setConfig(config: ApiClientConfig): ApiClientManager
Set configuration needed for Api Client
Parameters
- config: ApiClientConfig
  ApiClientConfig
Returns ApiClientManager
Instance of this client manager
- Defined in src/defaultApiClientManager.ts:56

unsetConfig

unsetConfig(): void
Used for unit testing scenarios. This will remove any config already set

Returns void
- Defined in src/defaultApiClientManager.ts:62