@techsio/storefront-data/dist/categories/hooks.d.ts

Medusa-first storefront data layer built on TanStack Query.

import { type CacheConfig, type CacheStrategy } from "../shared/cache-config";
import type { ReadQueryOptions, SuspenseQueryOptions } from "../shared/hook-types";
import type { PrefetchSkipMode } from "../shared/prefetch";
import type { QueryNamespace } from "../shared/query-keys";
import type { CategoryDetailInputBase, CategoryListInputBase, CategoryListResponse, CategoryQueryKeys, CategoryService, UseCategoriesResult, UseCategoryResult, UseSuspenseCategoriesResult, UseSuspenseCategoryResult } from "./types";
export type CreateCategoryHooksConfig<TCategory, TListInput extends CategoryListInputBase, TListParams, TDetailInput extends CategoryDetailInputBase, TDetailParams> = {
    service: CategoryService<TCategory, TListParams, TDetailParams>;
    buildListParams?: (input: TListInput) => TListParams;
    buildDetailParams?: (input: TDetailInput) => TDetailParams;
    queryKeys?: CategoryQueryKeys<TListParams, TDetailParams>;
    queryKeyNamespace?: QueryNamespace;
    cacheConfig?: CacheConfig;
    defaultPageSize?: number;
};
export declare function createCategoryHooks<TCategory, TListInput extends CategoryListInputBase, TListParams, TDetailInput extends CategoryDetailInputBase, TDetailParams>({ service, buildListParams, buildDetailParams, queryKeys, queryKeyNamespace, cacheConfig, defaultPageSize, }: CreateCategoryHooksConfig<TCategory, TListInput, TListParams, TDetailInput, TDetailParams>): {
    getListQueryOptions: (input: TListInput, options?: {
        queryOptions?: ReadQueryOptions<CategoryListResponse<TCategory>> | undefined;
        cacheStrategy?: CacheStrategy;
    } | undefined) => import("../shared/hook-types").QueryFactoryOptions<CategoryListResponse<TCategory>>;
    getDetailQueryOptions: (input: TDetailInput, options?: {
        queryOptions?: ReadQueryOptions<TCategory | null> | undefined;
        cacheStrategy?: CacheStrategy;
    } | undefined) => import("../shared/hook-types").QueryFactoryOptions<TCategory | null>;
    useCategories: (input: TListInput, options?: {
        queryOptions?: ReadQueryOptions<CategoryListResponse<TCategory>>;
    }) => UseCategoriesResult<TCategory>;
    useSuspenseCategories: (input: TListInput, options?: {
        queryOptions?: SuspenseQueryOptions<CategoryListResponse<TCategory>>;
    }) => UseSuspenseCategoriesResult<TCategory>;
    useCategory: (input: TDetailInput, options?: {
        queryOptions?: ReadQueryOptions<TCategory | null>;
    }) => UseCategoryResult<TCategory>;
    useSuspenseCategory: (input: TDetailInput, options?: {
        queryOptions?: SuspenseQueryOptions<TCategory | null>;
    }) => UseSuspenseCategoryResult<TCategory>;
    usePrefetchCategories: (options?: {
        cacheStrategy?: CacheStrategy;
        defaultDelay?: number;
        skipIfCached?: boolean;
        skipMode?: PrefetchSkipMode;
    }) => {
        prefetchCategories: (input: TListInput) => Promise<void>;
        delayedPrefetch: (input: TListInput, delay?: number, prefetchId?: string) => string;
        cancelPrefetch: (prefetchId: string) => void;
    };
    usePrefetchCategory: (options?: {
        cacheStrategy?: CacheStrategy;
        defaultDelay?: number;
        skipIfCached?: boolean;
        skipMode?: PrefetchSkipMode;
    }) => {
        prefetchCategory: (input: TDetailInput) => Promise<void>;
        delayedPrefetch: (input: TDetailInput, delay?: number, prefetchId?: string) => string;
        cancelPrefetch: (prefetchId: string) => void;
    };
};
export type CategoryHooks<TCategory, TListInput extends CategoryListInputBase, TListParams, TDetailInput extends CategoryDetailInputBase, TDetailParams> = ReturnType<typeof createCategoryHooks<TCategory, TListInput, TListParams, TDetailInput, TDetailParams>>;
//# sourceMappingURL=hooks.d.ts.map