@refinedev/core
Version:
refine is a React-based framework for building internal tools, rapidly. It ships with Ant Design System, an enterprise-level UI toolkit.
57 lines • 2.01 kB
text/typescript
import type { BaseKey, CrudFilter, CrudSort, MetaQuery, Pagination } from "../../../contexts/data/types";
import type { LiveEvent } from "../../../contexts/live/types";
export type UseSubscriptionProps = {
/**
* Channel name to subscribe.
*/
channel: string;
/**
* Callback that is run when new events from subscription arrive.
*/
onLiveEvent: (event: LiveEvent) => void;
/**
* Type of events to subscribe. `"*"` means all events.
* @type Array<"deleted" | "updated" | "created" | "*" | string>
*/
types?: LiveEvent["type"][];
/**
* Determines subscription should subscribe or not.
* @type Array<"deleted" | "updated" | "created" | "*" | string>
*/
enabled?: boolean;
params?: {
ids?: BaseKey[];
id?: BaseKey;
/**
* @deprecated `params.meta` is depcerated. Use `meta` directly from the root level instead.
*/
meta?: MetaQuery;
/**
* @deprecated `metaData` is deprecated with refine@4, refine will pass `meta` instead, however, we still support `metaData` for backward compatibility.
*/
metaData?: MetaQuery;
pagination?: Pagination;
/**
* @deprecated `hasPagination` is deprecated, use `pagination.mode` instead.
*/
hasPagination?: boolean;
/**
* @deprecated `sort` is deprecated, use `sorters` instead.
*/
sort?: CrudSort[];
sorters?: CrudSort[];
filters?: CrudFilter[];
subscriptionType?: "useList" | "useOne" | "useMany";
resource?: string;
[key: string]: any;
};
/**
* @deprecated use `meta.dataProviderName` instead.
*/
dataProviderName?: string;
meta?: MetaQuery & {
dataProviderName?: string;
};
};
export declare const useSubscription: ({ params, channel, types, enabled, onLiveEvent, dataProviderName, meta, }: UseSubscriptionProps) => void;
//# sourceMappingURL=index.d.ts.map