@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.
52 lines • 3.23 kB
text/typescript
import { type QueryObserverResult, type UseQueryOptions } from "@tanstack/react-query";
import type { BaseKey, BaseRecord, GetOneResponse, HttpError, MetaQuery, Prettify } from "../../contexts/data/types";
import type { LiveModeProps } from "../../contexts/live/types";
import type { SuccessErrorNotification } from "../../contexts/notification/types";
import { type UseLoadingOvertimeOptionsProps, type UseLoadingOvertimeReturnType } from "../useLoadingOvertime";
export type UseOneProps<TQueryFnData, TError, TData> = {
/**
* Resource name for API data interactions
*/
resource?: string;
/**
* id of the item in the resource
* @type [`BaseKey`](/docs/api-reference/core/interfaceReferences/#basekey)
*/
id?: BaseKey;
/**
* react-query's [useQuery](https://tanstack.com/query/v5/docs/framework/react/reference/useQuery) options
*/
queryOptions?: Omit<UseQueryOptions<GetOneResponse<TQueryFnData>, TError, GetOneResponse<TData>>, "queryKey" | "queryFn"> & {
queryKey?: UseQueryOptions<GetOneResponse<TQueryFnData>, TError, GetOneResponse<TData>>["queryKey"];
queryFn?: UseQueryOptions<GetOneResponse<TQueryFnData>, TError, GetOneResponse<TData>>["queryFn"];
};
/**
* Metadata query for `dataProvider`,
*/
meta?: MetaQuery;
/**
* If there is more than one `dataProvider`, you should use the `dataProviderName` that you will use.
* @default `"default"``
*/
dataProviderName?: string;
} & SuccessErrorNotification<GetOneResponse<TData>, TError, Prettify<{
id?: BaseKey;
} & MetaQuery>> & LiveModeProps & UseLoadingOvertimeOptionsProps;
export type UseOneReturnType<TData, TError> = {
query: QueryObserverResult<GetOneResponse<TData>, TError>;
result: TData | undefined;
} & UseLoadingOvertimeReturnType;
/**
* `useOne` is a modified version of `react-query`'s {@link https://tanstack.com/query/v5/docs/framework/react/guides/queries `useQuery`} used for retrieving single items from a `resource`.
*
* It uses `getOne` method as query function from the `dataProvider` which is passed to `<Refine>`.
*
* @see {@link https://refine.dev/docs/api-reference/core/hooks/data/useOne} for more details.
*
* @typeParam TQueryFnData - Result data returned by the query function. Extends {@link https://refine.dev/docs/api-reference/core/interfaceReferences#baserecord `BaseRecord`}
* @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. Extends {@link https://refine.dev/docs/api-reference/core/interfaceReferences#baserecord `BaseRecord`}. Defaults to `TQueryFnData`
*
*/
export declare const useOne: <TQueryFnData extends BaseRecord = BaseRecord, TError extends HttpError = HttpError, TData extends BaseRecord = TQueryFnData>({ resource: resourceFromProp, id, queryOptions, successNotification, errorNotification, meta, liveMode, onLiveEvent, liveParams, dataProviderName, overtimeOptions, }: UseOneProps<TQueryFnData, TError, TData>) => UseOneReturnType<TData, TError> & UseLoadingOvertimeReturnType;
//# sourceMappingURL=useOne.d.ts.map