useCacheableRead

Category:

Context & Language

Uses the cacheable GET route for fresh default guests. Everything else stays POST.

Types

export function canUseCacheableGet({
  headers,
  session,
  cart,
  ssrWithoutUserContext,
}: {
  headers: Record<string, unknown>;
  session?: SessionContext;
  cart?: Schemas["Cart"];
  ssrWithoutUserContext?: boolean;
}): boolean

source code

export function useCacheableRead(): UseCacheableReadReturn

source code

export type UseCacheableReadReturn = {
  /**
   * Same as `apiClient.invoke` for a POST read. Uses the GET twin for fresh
   * default guests.
   */
  invokeRead: ReturnType<
    typeof createAPIClient<Pick<operations, CacheableReadOperation>>
  >["invoke"];
};

source code