@techsio/storefront-data
Version:
Medusa-first storefront data layer built on TanStack Query.
43 lines • 1.42 kB
TypeScript
import type Medusa from "@medusajs/js-sdk";
import type { HttpTypes } from "@medusajs/types";
import type { OrderService } from "./types";
export type MedusaOrderServiceConfig = {
defaultFields?: string;
defaultListFields?: string;
defaultDetailFields?: string;
defaultOrder?: string;
returnNullOnNotFound?: boolean;
};
export type MedusaOrderListInput = {
limit?: number;
offset?: number;
};
export type MedusaOrderListHookInput = MedusaOrderListInput & {
page?: number;
enabled?: boolean;
};
export type MedusaOrderDetailInput = {
id?: string;
};
export type MedusaOrderDetailHookInput = MedusaOrderDetailInput & {
enabled?: boolean;
};
/**
* Creates an OrderService for Medusa SDK
*
* @example
* ```typescript
* import { createOrderHooks } from "@techsio/storefront-data/orders/hooks"
* import { createMedusaOrderService } from "@techsio/storefront-data/orders/medusa-service"
* import { sdk } from "@/lib/medusa-client"
*
* const orderHooks = createOrderHooks({
* service: createMedusaOrderService(sdk, {
* defaultFields: "id,display_id,status,total,items,created_at",
* }),
* queryKeys: orderQueryKeys,
* })
* ```
*/
export declare function createMedusaOrderService(sdk: Medusa, config?: MedusaOrderServiceConfig): OrderService<HttpTypes.StoreOrder, MedusaOrderListInput, MedusaOrderDetailInput>;
//# sourceMappingURL=medusa-service.d.ts.map