useLogList Hook | Options, Patterns & Edge Cases | Refine v5 - Refine

If you need to list audit log events, you can use the useLogList hook of Refine, which uses the get method from auditLogProvider under the hood.

Usage

tsx

import { useLogList } from "@refinedev/core";

const postAuditLogResults = useLogList({
  resource: "posts",
});

API Reference

Properties

Property	Type	Default
resource <PropTag asterisk />	`string`	Action that it reads from route
action	`string`
author	`Record<string, any>`
meta	`Record<string, any>`
queryOptions	`UseQueryOptions<TQueryFnData, TError, TData>`

Type Parameters

Property	Description	Type	Default
TQueryFnData	Result data returned by the query function. Extends `BaseRecord`	`BaseRecord`	`BaseRecord`
TError	Custom error object that extends `HttpError`	`HttpError`	`HttpError`
TData	Result data returned by the `select` function. Extends `BaseRecord`. If not specified, the value of `TQueryFnData` will be used as the default value.	`BaseRecord`	`TQueryFnData`

Return values

Description	Type
Result of the `react-query`'s `useQuery`	`UseQueryResult<{ data: TData; }>`