@refinedev/core
Version:
Refine is a React meta-framework for building enterprise-level, data-intensive applications rapidly with support for modern UI libraries and headless integrations.
22 lines • 1.27 kB
TypeScript
import { type UseQueryOptions, type UseQueryResult } from "@tanstack/react-query";
import type { HttpError } from "../../../contexts/data/types";
import type { MakeOptional } from "../../../definitions/types";
export type UseLogProps<TQueryFnData, TError, TData> = {
resource: string;
action?: string;
meta?: Record<number | string, any>;
author?: Record<number | string, any>;
queryOptions?: MakeOptional<UseQueryOptions<TQueryFnData, TError, TData>, "queryKey" | "queryFn">;
};
/**
* useLogList is used to get and filter audit logs.
*
* @see {@link https://refine.dev/docs/api-reference/core/hooks/audit-log/useLogList} for more details.
*
* @typeParam TQueryFnData - Result data returned by the query function.
* @typeParam TError - Custom error object that extends {@link https://refine.dev/docs/api-reference/core/interfaceReferences#httperror `HttpError`}
* @typeParam TData - Result data returned by the `select` function. Defaults to `TQueryFnData`
*
*/
export declare const useLogList: <TQueryFnData = any, TError extends HttpError = HttpError, TData = TQueryFnData>({ resource, action, meta, author, queryOptions, }: UseLogProps<TQueryFnData, TError, TData>) => UseQueryResult<TData, TError>;
//# sourceMappingURL=index.d.ts.map