Alokai

storeConfig

Fetch store configuration

Signature

declare function storeConfig(
	context: Context,
	customQuery?: CustomQuery,
	customHeaders?: CustomHeaders
): Promise<ApolloQueryResult<StoreConfig>>;

Parameters

NameRequiredTypeDescription
contextRequiredContext
customQueryOptionalCustomQuery
customHeadersOptionalCustomHeaders

Referenced Types

Examples

Simple usage:

import { sdk } from '~/sdk.config.ts';

// fetch store configuration
const result = await sdk.magento.storeConfig();

// result?.data?.storeConfig contains the store configuration
module.exports = {
  integrations: {
    magento: {
      customQueries: {
        'store-config-custom-query': ({ variables, metadata }) => ({
           variables,
           query: `
             query storeConfig {
               storeConfig {
                 ${metadata?.fields}
               }
             }
           `
        }),
      },
    }
  }
};

Using a custom GraphQL query to select only the fields you need

import { sdk } from '~/sdk.config.ts';
// we want to fetch only logo related data
const customQuery = {
  storeConfig: 'store-config-custom-query',
  metadata: {
    fields: 'logo_alt logo_height logo_width'
  }
};

const result = await sdk.magento.storeConfig(customQuery);

On this page