SetupContext
Contains current request and response object, integration configuration and helper methods. Currently it uses Middleware's IntegrationContext type utility instead of creating its own context.
interface SetupContext {
client: ApolloClient<InMemoryCache>;
config: Config<InMemoryCache>;
customQueries?: any;
extendQuery<Type extends Record<string, ContextQuery>, Key extends keyof Type>(customQuery: CustomQuery, queries: Type): Record<Key, ContextQuery>;
extensions: ApiClientExtension[];
req: Request;
res: Response;
}Properties
| Name | Required | Type | Description |
|---|---|---|---|
client | Required | ApolloClient<InMemoryCache> | Apollo GraphQL client used to send requests to commercetools platform |
config | Required | Config<InMemoryCache> | Integration configuration |
customQueries | Optional | any | Custom queries registered in middleware.config.js |
extensions | Required | ApiClientExtension[] | Array of registered integration extensions |
req | Required | Request | Request object |
res | Required | Response | Response object |
extendQuery
Helper function for handling default and custom queries
Signature
extendQuery<Type extends Record<string,
ContextQuery>,
Key extends keyof Type>(
customQuery: CustomQuery,
queries: Type
): Record<Key,
ContextQuery>;Parameters
| Name | Required | Type | Description |
|---|---|---|---|
customQuery | Required | CustomQuery | custom query to be used instead of the default query |
queries | Required | Type | default queries and variables |
Returns
Resolved queries
Referenced Types
Referenced Types
ApolloClientInMemoryCache- Config
- ApiClientExtension
e.Requeste.Response