[{"_1":2,"_445":-5,"_446":-5},"loaderData",{"_3":4,"_165":166},"routes/global-wrapper",{"_5":6,"_85":86,"_93":94,"_162":163,"_164":17},"search",{"_7":8,"_20":21},"selectableVersions",{"_9":10},"default",{"_11":12,"_19":17},"values",[13,14,15,16,17,18],"unstable","2025-10","2025-07","2025-04","2025-01","2024-10","stable_version","categories",[22,31,35,38,41,44,47,50,53,56,59,62,66,70,73,76,79,82],{"_23":24,"_25":26,"_27":28,"_29":30},"name","API: Admin Extensions","referenceName","admin-extensions","versioned",true,"cookieName","api_version",{"_23":32,"_25":33,"_27":34,"_29":30},"API: App Bridge Library","app-bridge-library",false,{"_23":36,"_25":37,"_27":34,"_29":30},"API: App home","app-home",{"_23":39,"_25":40,"_27":28,"_29":30},"API: Checkout UI extensions","checkout-ui-extensions",{"_23":42,"_25":43,"_27":28,"_29":30},"API: Customer account UI extensions","customer-account-ui-extensions",{"_23":45,"_25":46,"_27":34,"_29":30},"API: Generate docs","generate-docs",{"_23":48,"_25":49,"_27":28,"_29":30},"API: Hydrogen","hydrogen",{"_23":51,"_25":52,"_27":28,"_29":30},"API: Hydrogen React","hydrogen-react",{"_23":54,"_25":55,"_27":34,"_29":30},"API: MDX components","mdx-components",{"_23":57,"_25":58,"_27":28,"_29":30},"API: POS UI Extensions","pos-ui-extensions",{"_23":60,"_25":61,"_27":34,"_29":30},"API: Shop Minis","shop-minis",{"_23":63,"_25":64,"_27":28,"_29":65},"API: shopify app react router","shopify-app-react-router","api_version_shopify-app-react-router",{"_23":67,"_25":68,"_27":28,"_29":69},"API: shopify app remix","shopify-app-remix","api_version_shopify-app-remix",{"_23":71,"_25":72,"_27":34,"_29":30},"API: Shopify CLI","shopify-cli",{"_23":74,"_25":75,"_27":34,"_29":30},"API: Storefront web components","storefront-web-components",{"_23":77,"_25":78,"_27":34,"_29":30},"API: Tutorials","tutorials",{"_23":80,"_25":81,"_27":34,"_29":30},"API: Web Pixels API","web-pixels-api",{"_23":83,"_25":84,"_27":28,"_29":30},"API: Webhooks","webhooks","userPreferences",{"_87":88,"_89":90,"_30":17,"_91":92},"gqlLanguage","remix","webhooksReference","toml","pickerPreferences",{},"features",[95,96,97,98,99,100,101,102,103,104,105,106,107,108,109,110,111,112,113,114,115,116,117,118,119,120,121,122,123,124,125,126,127,128,129,130,131,132,133,134,135,136,137,138,139,140,141,142,143,144,145,146,147,148,149,150,151,152,153,154,155,156,157,158,159,160,161],"adaptive_rate_limiter","ai_theme_block_gen","automated_privacy","cli_managed_subscription_link_creation_and_migration","combined_listings","conditional_settings","customer_account_ui_extensions_stable_docs","dat_scheduled_feature_tho","dev_assistant_ui_changes","dev_assistant_vscode_extension","dev_tools_liquiddoc_v2","discounts_allocator_function","editor_extension_collections_docs","enforce_fulfillment_order_status_on_create_fulfillment","explicit_buyer_consent","flex_sections","functions_references","functions_wasm","functions-next","gql_ai","gql_ai_v2","gql_example_switcher","gql_operation_cache","headless_cmp","identity_dropdown","identity_integration","markdown_download","mcp_dev_docs","mockshop_ai","mockshop_ai_disable_force_ai","multi_class_discount_functions","multi_class_discount_ui","nested_lines","net_new_webhooks_reference_2024","next-gen-dev-platform","online_store_new_datasources","online_store_passing_preset_names","open_source_subscriptions_1p_app","optional_scopes","product_configuration_ui_extension_url_config","product_discount_cart_line_targeting","purchase_options_extensions","remove_php_example","rest_admin_api_deprecation","rev_share_jan24","sched_2","schedule_test","shipping_discount_functions_general_availability","shop_minis","ssr-changelog","ssr-erb","ssr-gqlMDX","ssr-graphql","ssr-liquid","ssr-markdown","ssr-rest","ssr-templatedRefs","ssr-tutorial","static_blocks","storefront_components","style_settings","subs_thank_you_extensions","theme_blocks","theme_blocks_data_sources","theme_blocks_ga","versioned_app_config","zero_redirect_auth","hostname","shopify-dev.shopifycloud.com","apiVersion","templated-resource-hydrogen",{"_167":168,"_431":28,"_432":433,"_438":439,"_164":440,"_441":49,"_442":443,"_444":34},"pageContent",{"_23":169,"_170":171,"_172":34,"_173":174,"_192":193,"_177":194,"_195":196,"_215":216,"_421":422,"_423":-7,"_424":-7,"_425":-7,"_426":427,"_428":429,"_430":-7},"createStorefrontClient","category","utilities","isVisualComponent","related",[175,180,183,186,189],{"_23":176,"_177":171,"_178":179},"CacheNone","type","url","/docs/api/hydrogen/2023-04/utilities/cachenone",{"_23":181,"_177":171,"_178":182},"CacheShort","/docs/api/hydrogen/2023-04/utilities/cacheshort",{"_23":184,"_177":171,"_178":185},"CacheLong","/docs/api/hydrogen/2023-04/utilities/cachelong",{"_23":187,"_177":171,"_178":188},"CacheCustom","/docs/api/hydrogen/2023-04/utilities/cachecustom",{"_23":190,"_177":171,"_178":191},"InMemoryCache","/docs/api/hydrogen/2023-04/utilities/inmemorycache","description","This function extends `createStorefrontClient` from [Hydrogen React](/docs/api/hydrogen-react/2023-04/utilities/createstorefrontclient). The additional arguments enable internationalization (i18n), caching, and other features particular to Remix and Oxygen.\n\nLearn more about [data fetching in Hydrogen](/docs/custom-storefronts/hydrogen/data-fetching/fetch-data).","utility","defaultExample",{"_192":197,"_198":199,"_214":-7},"I am the default example","codeblock",{"_200":201,"_203":213},"tabs",[202,209],{"_203":204,"_205":206,"_207":208},"title","JavaScript","code","import {createStorefrontClient} from '@shopify/hydrogen';\nimport {\n createRequestHandler,\n getStorefrontHeaders,\n} from '@shopify/remix-oxygen';\nexport default {\n async fetch(request, env, executionContext) {\n /* Create a Storefront client with your credentials and options */\n const {storefront} = createStorefrontClient({\n /* Cache API instance */\n cache: await caches.open('hydrogen'),\n /* Runtime utility in serverless environments */\n waitUntil: (p) => executionContext.waitUntil(p),\n /* Private Storefront API token for your store */\n privateStorefrontToken: env.PRIVATE_STOREFRONT_API_TOKEN,\n /* Public Storefront API token for your store */\n publicStorefrontToken: env.PUBLIC_STOREFRONT_API_TOKEN,\n /* Your store domain: \"{shop}.myshopify.com\" */\n storeDomain: env.PUBLIC_STORE_DOMAIN,\n /**\n * Storefront API headers containing:\n * - buyerIp: The IP address of the customer.\n * - requestGroupId: A unique ID to group all the logs for this request.\n * - cookie: The 'cookie' header from the request.\n */\n storefrontHeaders: getStorefrontHeaders(request),\n });\n\n const handleRequest = createRequestHandler({\n build: remixBuild,\n mode: process.env.NODE_ENV,\n /* Inject the Storefront client in the Remix context */\n getLoadContext: () => ({storefront}),\n });\n\n return handleRequest(request);\n },\n};\n","language","js",{"_203":210,"_205":211,"_207":212},"TypeScript","import {createStorefrontClient} from '@shopify/hydrogen';\nimport * as remixBuild from '@remix-run/dev/server-build';\nimport {\n createRequestHandler,\n getStorefrontHeaders,\n} from '@shopify/remix-oxygen';\n\nexport default {\n async fetch(\n request: Request,\n env: Record,\n executionContext: ExecutionContext,\n ) {\n /* Create a Storefront client with your credentials and options */\n const {storefront} = createStorefrontClient({\n /* Cache API instance */\n cache: await caches.open('hydrogen'),\n /* Runtime utility in serverless environments */\n waitUntil: (p: Promise) => executionContext.waitUntil(p),\n /* Private Storefront API token for your store */\n privateStorefrontToken: env.PRIVATE_STOREFRONT_API_TOKEN,\n /* Public Storefront API token for your store */\n publicStorefrontToken: env.PUBLIC_STOREFRONT_API_TOKEN,\n /* Your store domain: \"{shop}.myshopify.com\" */\n storeDomain: env.PUBLIC_STORE_DOMAIN,\n /**\n * Storefront API headers containing:\n * - buyerIp: The IP address of the customer.\n * - requestGroupId: A unique ID to group all the logs for this request.\n * - cookie: The 'cookie' header from the request.\n */\n storefrontHeaders: getStorefrontHeaders(request),\n });\n\n const handleRequest = createRequestHandler({\n build: remixBuild,\n mode: process.env.NODE_ENV,\n /* Inject the Storefront client in the Remix context */\n getLoadContext: () => ({storefront}),\n });\n\n return handleRequest(request);\n },\n};\n","ts","Example code","image","definitions",[217],{"_203":218,"_192":219,"_177":220,"_221":222},"Arguments","","CreateStorefrontClientGeneratedType","typeDefinitions",{"_220":223,"_236":237,"_241":242,"_249":274,"_284":285,"_292":293,"_344":345,"_347":348,"_350":351,"_354":355,"_357":358,"_362":363,"_365":366,"_368":369,"_390":391,"_395":396,"_398":399,"_371":403,"_412":413},{"_224":225,"_23":220,"_192":193,"_226":227,"_232":233,"_230":235},"filePath","/storefront.ts","params",[228],{"_23":229,"_192":219,"_230":231,"_224":225},"options","value","CreateStorefrontClientOptions","returns",{"_224":225,"_192":219,"_23":234,"_230":234},"StorefrontClient","export function createStorefrontClient(\n options: CreateStorefrontClientOptions,\n): StorefrontClient {\n const {\n storefrontHeaders,\n cache,\n waitUntil,\n buyerIp,\n i18n,\n requestGroupId,\n storefrontId,\n ...clientOptions\n } = options;\n if (!cache) {\n // TODO: should only warn in development\n warnOnce(\n 'Storefront API client created without a cache instance. This may slow down your sub-requests.',\n );\n }\n\n const {\n getPublicTokenHeaders,\n getPrivateTokenHeaders,\n getStorefrontApiUrl,\n getShopifyDomain,\n } = createStorefrontUtilities(clientOptions);\n\n const getHeaders = clientOptions.privateStorefrontToken\n ? getPrivateTokenHeaders\n : getPublicTokenHeaders;\n\n const defaultHeaders = getHeaders({\n contentType: 'json',\n buyerIp: storefrontHeaders?.buyerIp || buyerIp,\n });\n\n defaultHeaders[STOREFRONT_REQUEST_GROUP_ID_HEADER] =\n storefrontHeaders?.requestGroupId || requestGroupId || generateUUID();\n\n if (storefrontId) defaultHeaders[SHOPIFY_STOREFRONT_ID_HEADER] = storefrontId;\n if (LIB_VERSION) defaultHeaders['user-agent'] = `Hydrogen ${LIB_VERSION}`;\n\n if (storefrontHeaders && storefrontHeaders.cookie) {\n const cookies = getShopifyCookies(storefrontHeaders.cookie ?? '');\n\n if (cookies[SHOPIFY_Y])\n defaultHeaders[SHOPIFY_STOREFRONT_Y_HEADER] = cookies[SHOPIFY_Y];\n if (cookies[SHOPIFY_S])\n defaultHeaders[SHOPIFY_STOREFRONT_S_HEADER] = cookies[SHOPIFY_S];\n }\n\n // Deprecation warning\n if (!storefrontHeaders) {\n warnOnce(\n '\"requestGroupId\" and \"buyerIp\" will be deprecated in the next calendar release. Please use \"getStorefrontHeaders\"',\n );\n }\n\n async function fetchStorefrontApi({\n query,\n mutation,\n variables,\n cache: cacheOptions,\n headers = [],\n storefrontApiVersion,\n }: StorefrontQueryOptions | StorefrontMutationOptions): Promise {\n const userHeaders =\n headers instanceof Headers\n ? Object.fromEntries(headers.entries())\n : Array.isArray(headers)\n ? Object.fromEntries(headers)\n : headers;\n\n query = query ?? mutation;\n\n const queryVariables = {...variables};\n\n if (i18n) {\n if (!variables?.country && /\\$country/.test(query)) {\n queryVariables.country = i18n.country;\n }\n\n if (!variables?.language && /\\$language/.test(query)) {\n queryVariables.language = i18n.language;\n }\n }\n\n const url = getStorefrontApiUrl({storefrontApiVersion});\n const requestInit: RequestInit = {\n method: 'POST',\n headers: {...defaultHeaders, ...userHeaders},\n body: JSON.stringify({\n query,\n variables: queryVariables,\n }),\n };\n\n const [body, response] = await fetchWithServerCache(url, requestInit, {\n cacheInstance: mutation ? undefined : cache,\n cache: cacheOptions || CacheShort(),\n shouldCacheResponse: checkGraphQLErrors,\n waitUntil,\n });\n\n if (!response.ok) {\n /**\n * The Storefront API might return a string error, or a JSON-formatted {error: string}.\n * We try both and conform them to a single {errors} format.\n */\n let errors;\n try {\n errors = parseJSON(body);\n } catch (_e) {\n errors = [{message: body}];\n }\n\n throwError(response, errors);\n }\n\n const {data, errors} = body as StorefrontApiResponse;\n\n if (errors?.length) throwError(response, errors, StorefrontApiError);\n\n return data as T;\n }\n\n return {\n storefront: {\n /**\n * Sends a GraphQL query to the Storefront API.\n *\n * Example:\n *\n * ```js\n * async function loader ({context: {storefront}}) {\n * const data = await storefront.query('query { ... }', {\n * variables: {},\n * cache: storefront.CacheLong()\n * });\n * }\n * ```\n */\n query: ((query: string, payload) => {\n query = minifyQuery(query);\n if (isMutationRE.test(query))\n throw new Error('storefront.query cannot execute mutations');\n\n return fetchStorefrontApi({...payload, query});\n }),\n /**\n * Sends a GraphQL mutation to the Storefront API.\n *\n * Example:\n *\n * ```js\n * async function loader ({context: {storefront}}) {\n * await storefront.mutate('mutation { ... }', {\n * variables: {},\n * });\n * }\n * ```\n */\n mutate: ((mutation: string, payload) => {\n mutation = minifyQuery(mutation);\n if (isQueryRE.test(mutation))\n throw new Error('storefront.mutate cannot execute queries');\n\n return fetchStorefrontApi({...payload, mutation});\n }),\n cache,\n CacheNone,\n CacheLong,\n CacheShort,\n CacheCustom,\n generateCacheControlHeader,\n getPublicTokenHeaders,\n getPrivateTokenHeaders,\n getShopifyDomain,\n getApiUrl: getStorefrontApiUrl,\n /**\n * Wether it's a GraphQL error returned in the Storefront API response.\n *\n * Example:\n *\n * ```js\n * async function loader ({context: {storefront}}) {\n * try {\n * await storefront.query(...);\n * } catch(error) {\n * if (storefront.isApiError(error)) {\n * // ...\n * }\n *\n * throw error;\n * }\n * }\n * ```\n */\n isApiError: isStorefrontApiError,\n i18n: (i18n ?? defaultI18n) as TI18n,\n },\n };\n}","CreateStorefrontClientOptions",{"_224":225,"_238":239,"_23":236,"_230":240,"_192":219},"syntaxKind","TypeAliasDeclaration","HydrogenClientProps & StorefrontClientProps","HydrogenClientProps",{"_224":225,"_238":239,"_23":241,"_230":243,"_192":219,"_244":245},"{\n /** Storefront API headers. If on Oxygen, use `getStorefrontHeaders()` */\n storefrontHeaders?: StorefrontHeaders;\n /** An instance that implements the [Cache API](https://developer.mozilla.org/en-US/docs/Web/API/Cache) */\n cache?: Cache;\n /** @deprecated use storefrontHeaders instead */\n buyerIp?: string;\n /** @deprecated use storefrontHeaders instead */\n requestGroupId?: string | null;\n /** The globally unique identifier for the Shop */\n storefrontId?: string;\n /** The `waitUntil` function is used to keep the current request/response lifecycle alive even after a response has been sent. It should be provided by your platform. */\n waitUntil?: ExecutionContext['waitUntil'];\n /** An object containing a country code and language code */\n i18n?: TI18n;\n}","members",[246,252,256,261,263,266,270],{"_224":225,"_238":247,"_23":248,"_230":249,"_192":250,"_251":28},"PropertySignature","storefrontHeaders","StorefrontHeaders","Storefront API headers. If on Oxygen, use `getStorefrontHeaders()`","isOptional",{"_224":225,"_238":247,"_23":253,"_230":254,"_192":255,"_251":28},"cache","Cache","An instance that implements the [Cache API](https://developer.mozilla.org/en-US/docs/Web/API/Cache)",{"_224":225,"_238":247,"_23":257,"_230":258,"_192":219,"_251":28,"_259":260},"buyerIp","string","deprecationMessage","use storefrontHeaders instead",{"_224":225,"_238":247,"_23":262,"_230":258,"_192":219,"_251":28,"_259":260},"requestGroupId",{"_224":225,"_238":247,"_23":264,"_230":258,"_192":265,"_251":28},"storefrontId","The globally unique identifier for the Shop",{"_224":225,"_238":247,"_23":267,"_230":268,"_192":269,"_251":28},"waitUntil","ExecutionContext","The `waitUntil` function is used to keep the current request/response lifecycle alive even after a response has been sent. It should be provided by your platform.",{"_224":225,"_238":247,"_23":271,"_230":272,"_192":273,"_251":28},"i18n","TI18n","An object containing a country code and language code",{"_224":225,"_238":239,"_23":249,"_230":275,"_192":219,"_244":276},"{\n /** A unique ID that correlates all sub-requests together. */\n requestGroupId: string | null;\n /** The IP address of the client. */\n buyerIp: string | null;\n /** The cookie header from the client */\n cookie: string | null;\n}",[277,279,281],{"_224":225,"_238":247,"_23":262,"_230":258,"_192":278},"A unique ID that correlates all sub-requests together.",{"_224":225,"_238":247,"_23":257,"_230":258,"_192":280},"The IP address of the client.",{"_224":225,"_238":247,"_23":282,"_230":258,"_192":283},"cookie","The cookie header from the client","StorefrontClient",{"_224":225,"_238":239,"_23":284,"_230":286,"_192":287,"_244":288},"{\n storefront: Storefront;\n}","Wraps all the returned utilities from `createStorefrontClient`.",[289],{"_224":225,"_238":247,"_23":290,"_230":291,"_192":219},"storefront","Storefront","Storefront",{"_224":225,"_238":239,"_23":292,"_230":294,"_192":295,"_244":296},"{\n /** The function to run a query on Storefront API. */\n query: (\n query: RawGqlString,\n ...options: RawGqlString extends keyof StorefrontQueries // Do we have any generated query types?\n ? IsOptionalVariables extends true\n ? [StorefrontQuerySecondParam?] // Using codegen, query has no variables\n : [StorefrontQuerySecondParam] // Using codegen, query needs variables\n : [StorefrontQuerySecondParam?] // No codegen, variables always optional\n ) => Promise<\n RawGqlString extends keyof StorefrontQueries // Do we have any generated query types?\n ? StorefrontQueries[RawGqlString]['return'] // Using codegen, return type is known\n : OverrideReturnType // No codegen, let user specify return type\n >;\n /** The function to run a mutation on Storefront API. */\n mutate: (\n mutation: RawGqlString,\n ...options: RawGqlString extends keyof StorefrontMutations // Do we have any generated mutation types?\n ? IsOptionalVariables extends true\n ? [StorefrontMutateSecondParam?] // Using codegen, mutation has no variables\n : [StorefrontMutateSecondParam] // Using codegen, mutation needs variables\n : [StorefrontMutateSecondParam?] // No codegen, variables always optional\n ) => Promise<\n RawGqlString extends keyof StorefrontMutations // Do we have any generated mutation types?\n ? StorefrontMutations[RawGqlString]['return'] // Using codegen, return type is known\n : OverrideReturnType // No codegen, let user specify return type\n >;\n /** The cache instance passed in from the `createStorefrontClient` argument. */\n cache?: Cache;\n /** Re-export of [`CacheNone`](/docs/api/hydrogen/2023-04/utilities/cachenone). */\n CacheNone: typeof CacheNone;\n /** Re-export of [`CacheLong`](/docs/api/hydrogen/2023-04/utilities/cachelong). */\n CacheLong: typeof CacheLong;\n /** Re-export of [`CacheShort`](/docs/api/hydrogen/2023-04/utilities/cacheshort). */\n CacheShort: typeof CacheShort;\n /** Re-export of [`CacheCustom`](/docs/api/hydrogen/2023-04/utilities/cachecustom). */\n CacheCustom: typeof CacheCustom;\n /** Re-export of [`generateCacheControlHeader`](/docs/api/hydrogen/2023-04/utilities/generatecachecontrolheader). */\n generateCacheControlHeader: typeof generateCacheControlHeader;\n /** Returns an object that contains headers that are needed for each query to Storefront API GraphQL endpoint. See [`getPublicTokenHeaders` in Hydrogen React](/docs/api/hydrogen-react/2023-04/utilities/createstorefrontclient#:~:text=%27graphql%27.-,getPublicTokenHeaders,-(props%3F%3A) for more details. */\n getPublicTokenHeaders: ReturnType<\n typeof createStorefrontUtilities\n >['getPublicTokenHeaders'];\n /** Returns an object that contains headers that are needed for each query to Storefront API GraphQL endpoint for API calls made from a server. See [`getPrivateTokenHeaders` in Hydrogen React](/docs/api/hydrogen-react/2023-04/utilities/createstorefrontclient#:~:text=storefrontApiVersion-,getPrivateTokenHeaders,-(props%3F%3A) for more details.*/\n getPrivateTokenHeaders: ReturnType<\n typeof createStorefrontUtilities\n >['getPrivateTokenHeaders'];\n /** Creates the fully-qualified URL to your myshopify.com domain. See [`getShopifyDomain` in Hydrogen React](/docs/api/hydrogen-react/2023-04/utilities/createstorefrontclient#:~:text=StorefrontClientReturn-,getShopifyDomain,-(props%3F%3A) for more details. */\n getShopifyDomain: ReturnType<\n typeof createStorefrontUtilities\n >['getShopifyDomain'];\n /** Creates the fully-qualified URL to your store's GraphQL endpoint. See [`getStorefrontApiUrl` in Hydrogen React](/docs/api/hydrogen-react/2023-04/utilities/createstorefrontclient#:~:text=storeDomain-,getStorefrontApiUrl,-(props%3F%3A) for more details.*/\n getApiUrl: ReturnType<\n typeof createStorefrontUtilities\n >['getStorefrontApiUrl'];\n /** Determines if the error is resulted from a Storefront API call. */\n isApiError: (error: any) => boolean;\n /** The `i18n` object passed in from the `createStorefrontClient` argument. */\n i18n: TI18n;\n}","Interface to interact with the Storefront API.",[297,301,305,307,310,313,315,318,322,326,330,334,338,342],{"_224":225,"_238":247,"_23":298,"_230":299,"_192":300},"query","(query: RawGqlString, ...options: RawGqlString extends never ? IsOptionalVariables extends true ? [StorefrontQuerySecondParam?] : [StorefrontQuerySecondParam] : [StorefrontQuerySecondParam?]) => Promise","The function to run a query on Storefront API.",{"_224":225,"_238":247,"_23":302,"_230":303,"_192":304},"mutate","(mutation: RawGqlString, ...options: RawGqlString extends never ? IsOptionalVariables extends true ? [StorefrontMutateSecondParam?] : [StorefrontMutateSecondParam] : [StorefrontCommonOptions<{ readonly [variable: string]: unknown; }>?]) => Promise","The function to run a mutation on Storefront API.",{"_224":225,"_238":247,"_23":253,"_230":254,"_192":306,"_251":28},"The cache instance passed in from the `createStorefrontClient` argument.",{"_224":225,"_238":247,"_23":176,"_230":308,"_192":309},"() => NoStoreStrategy","Re-export of [`CacheNone`](/docs/api/hydrogen/2023-04/utilities/cachenone).",{"_224":225,"_238":247,"_23":184,"_230":311,"_192":312},"(overrideOptions?: AllCacheOptions) => AllCacheOptions","Re-export of [`CacheLong`](/docs/api/hydrogen/2023-04/utilities/cachelong).",{"_224":225,"_238":247,"_23":181,"_230":311,"_192":314},"Re-export of [`CacheShort`](/docs/api/hydrogen/2023-04/utilities/cacheshort).",{"_224":225,"_238":247,"_23":187,"_230":316,"_192":317},"(overrideOptions: AllCacheOptions) => AllCacheOptions","Re-export of [`CacheCustom`](/docs/api/hydrogen/2023-04/utilities/cachecustom).",{"_224":225,"_238":247,"_23":319,"_230":320,"_192":321},"generateCacheControlHeader","(cacheOptions: AllCacheOptions) => string","Re-export of [`generateCacheControlHeader`](/docs/api/hydrogen/2023-04/utilities/generatecachecontrolheader).",{"_224":225,"_238":247,"_23":323,"_230":324,"_192":325},"getPublicTokenHeaders","(props?: Partial> & Pick) => Record","Returns an object that contains headers that are needed for each query to Storefront API GraphQL endpoint. See [`getPublicTokenHeaders` in Hydrogen React](/docs/api/hydrogen-react/2023-04/utilities/createstorefrontclient#:~:text=%27graphql%27.-,getPublicTokenHeaders,-(props%3F%3A) for more details.",{"_224":225,"_238":247,"_23":327,"_230":328,"_192":329},"getPrivateTokenHeaders","(props?: Partial> & Pick & { buyerIp?: string; }) => Record","Returns an object that contains headers that are needed for each query to Storefront API GraphQL endpoint for API calls made from a server. See [`getPrivateTokenHeaders` in Hydrogen React](/docs/api/hydrogen-react/2023-04/utilities/createstorefrontclient#:~:text=storefrontApiVersion-,getPrivateTokenHeaders,-(props%3F%3A) for more details.",{"_224":225,"_238":247,"_23":331,"_230":332,"_192":333},"getShopifyDomain","(props?: Partial>) => string","Creates the fully-qualified URL to your myshopify.com domain. See [`getShopifyDomain` in Hydrogen React](/docs/api/hydrogen-react/2023-04/utilities/createstorefrontclient#:~:text=StorefrontClientReturn-,getShopifyDomain,-(props%3F%3A) for more details.",{"_224":225,"_238":247,"_23":335,"_230":336,"_192":337},"getApiUrl","(props?: Partial>) => string","Creates the fully-qualified URL to your store's GraphQL endpoint. See [`getStorefrontApiUrl` in Hydrogen React](/docs/api/hydrogen-react/2023-04/utilities/createstorefrontclient#:~:text=storeDomain-,getStorefrontApiUrl,-(props%3F%3A) for more details.",{"_224":225,"_238":247,"_23":339,"_230":340,"_192":341},"isApiError","(error: any) => boolean","Determines if the error is resulted from a Storefront API call.",{"_224":225,"_238":247,"_23":271,"_230":272,"_192":343},"The `i18n` object passed in from the `createStorefrontClient` argument.","IsOptionalVariables",{"_224":225,"_238":239,"_23":344,"_230":346,"_192":219},"Omit<\n OperationTypeValue['variables'],\n AutoAddedVariableNames\n> extends EmptyVariables\n ? true // No need to pass variables\n : GenericVariables extends OperationTypeValue['variables']\n ? true // We don't know what variables are needed\n : false","AutoAddedVariableNames",{"_224":225,"_238":239,"_23":347,"_230":349,"_192":219},"'country' | 'language'","EmptyVariables",{"_224":225,"_238":239,"_23":350,"_230":352,"_192":219,"_244":353},"{[key: string]: never}",[],"GenericVariables",{"_224":225,"_238":239,"_23":354,"_230":356,"_192":219},"ExecutionArgs['variableValues']","StorefrontQueries",{"_224":225,"_23":357,"_192":359,"_244":360,"_230":361},"Maps all the queries found in the project to variables and return types.",[],"export interface StorefrontQueries {\n // Example of how a generated query type looks like:\n // '#graphql query q1 {...}': {return: Q1Query; variables: Q1QueryVariables};\n}","StorefrontQuerySecondParam",{"_224":225,"_238":239,"_23":362,"_230":364,"_192":219},"(RawGqlString extends keyof StorefrontQueries\n ? StorefrontCommonOptions\n : StorefrontCommonOptions) & {cache?: CachingStrategy}","StorefrontCommonOptions",{"_224":225,"_238":239,"_23":365,"_230":367,"_192":219},"{\n headers?: HeadersInit;\n storefrontApiVersion?: string;\n} & (IsOptionalVariables<{variables: Variables}> extends true\n ? {variables?: Variables}\n : {variables: Variables})","CachingStrategy",{"_224":370,"_238":239,"_23":368,"_230":371,"_192":372,"_244":373},"/cache/strategies.ts","AllCacheOptions","Use the `CachingStrategy` to define a custom caching mechanism for your data. Or use one of the pre-defined caching strategies: CacheNone, CacheShort, CacheLong.",[374,377,381,384,387],{"_224":370,"_238":247,"_23":375,"_230":258,"_192":376,"_251":28},"mode","The caching mode, generally `public`, `private`, or `no-store`.",{"_224":370,"_238":247,"_23":378,"_230":379,"_192":380,"_251":28},"maxAge","number","The maximum amount of time in seconds that a resource will be considered fresh. See `max-age` in the [MDN docs](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Cache-Control#:~:text=Response%20Directives-,max%2Dage,-The%20max%2Dage).",{"_224":370,"_238":247,"_23":382,"_230":379,"_192":383,"_251":28},"staleWhileRevalidate","Indicate that the cache should serve the stale response in the background while revalidating the cache. See `stale-while-revalidate` in the [MDN docs](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Cache-Control#stale-while-revalidate).",{"_224":370,"_238":247,"_23":385,"_230":379,"_192":386,"_251":28},"sMaxAge","Similar to `maxAge` but specific to shared caches. See `s-maxage` in the [MDN docs](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Cache-Control#s-maxage).",{"_224":370,"_238":247,"_23":388,"_230":379,"_192":389,"_251":28},"staleIfError","Indicate that the cache should serve the stale response if an error occurs while revalidating the cache. See `stale-if-error` in the [MDN docs](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Cache-Control#stale-if-error).","StorefrontMutations",{"_224":225,"_23":390,"_192":392,"_244":393,"_230":394},"Maps all the mutations found in the project to variables and return types.",[],"export interface StorefrontMutations {\n // Example of how a generated mutation type looks like:\n // '#graphql mutation m1 {...}': {return: M1Mutation; variables: M1MutationVariables};\n}","StorefrontMutateSecondParam",{"_224":225,"_238":239,"_23":395,"_230":397,"_192":219},"RawGqlString extends keyof StorefrontMutations\n ? StorefrontCommonOptions\n : StorefrontCommonOptions","NoStoreStrategy",{"_224":370,"_238":239,"_23":398,"_230":400,"_192":219,"_244":401},"{\n mode: string;\n}",[402],{"_224":370,"_238":247,"_23":375,"_230":258,"_192":219},{"_224":370,"_23":371,"_192":404,"_244":405,"_230":411},"Override options for a cache strategy.",[406,407,408,409,410],{"_224":370,"_238":247,"_23":375,"_230":258,"_192":376,"_251":28},{"_224":370,"_238":247,"_23":378,"_230":379,"_192":380,"_251":28},{"_224":370,"_238":247,"_23":382,"_230":379,"_192":383,"_251":28},{"_224":370,"_238":247,"_23":385,"_230":379,"_192":386,"_251":28},{"_224":370,"_238":247,"_23":388,"_230":379,"_192":389,"_251":28},"export interface AllCacheOptions {\n /**\n * The caching mode, generally `public`, `private`, or `no-store`.\n */\n mode?: string;\n /**\n * The maximum amount of time in seconds that a resource will be considered fresh. See `max-age` in the [MDN docs](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Cache-Control#:~:text=Response%20Directives-,max%2Dage,-The%20max%2Dage).\n */\n maxAge?: number;\n /**\n * Indicate that the cache should serve the stale response in the background while revalidating the cache. See `stale-while-revalidate` in the [MDN docs](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Cache-Control#stale-while-revalidate).\n */\n staleWhileRevalidate?: number;\n /**\n * Similar to `maxAge` but specific to shared caches. See `s-maxage` in the [MDN docs](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Cache-Control#s-maxage).\n */\n sMaxAge?: number;\n /**\n * Indicate that the cache should serve the stale response if an error occurs while revalidating the cache. See `stale-if-error` in the [MDN docs](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Cache-Control#stale-if-error).\n */\n staleIfError?: number;\n}","I18nBase",{"_224":225,"_238":239,"_23":412,"_230":414,"_192":219,"_244":415},"{\n language: LanguageCode;\n country: CountryCode;\n}",[416,418],{"_224":225,"_238":247,"_23":207,"_230":417,"_192":219},"LanguageCode",{"_224":225,"_238":247,"_23":419,"_230":420,"_192":219},"country","CountryCode","version","2023-04","thumbnail","examples","subCategory","id","createstorefrontclient","categoryLabel","Utilities","subCategoryLabel","unsupported","navData",{"_203":434,"_435":436,"_437":34},"Hydrogen","navItems",[],"collapsed","versionUrls",{},"current","apiName","latestVersion","2025-05","isInternal","actionData","errors"]