import { PaginationPayload, SortPayload, Identifier } from '../types';
interface UseGetManyReferenceOptions {
onSuccess?: (args?: any) => void;
onFailure?: (error: any) => void;
enabled?: boolean;
[key: string]: any;
}
/**
* Call the dataProvider.getManyReference() method and return the resolved result
* as well as the loading state.
*
* The return value updates according to the request state:
*
* - start: { loading: true, loaded: false, refetch }
* - success: { data: [data from store], ids: [ids from response], total: [total from response], loading: false, loaded: true, refetch }
* - error: { error: [error from response], loading: false, loaded: false, refetch }
*
* This hook will return the cached result when called a second time
* with the same parameters, until the response arrives.
*
* @param {string} resource The referenced resource name, e.g. 'comments'
* @param {string} target The target resource key, e.g. 'post_id'
* @param {Object} id The identifier of the record to look for in 'target'
* @param {Object} pagination The request pagination { page, perPage }, e.g. { page: 1, perPage: 10 }
* @param {Object} sort The request sort { field, order }, e.g. { field: 'id', order: 'DESC' }
* @param {Object} filter The request filters, e.g. { body: 'hello, world' }
* @param {string} referencingResource The resource name, e.g. 'posts'. Used to generate a cache key
* @param {Object} options Options object to pass to the dataProvider.
* @param {boolean} options.enabled Flag to conditionally run the query. If it's false, the query will not run
* @param {Function} options.onSuccess Side effect function to be executed upon success, e.g. { onSuccess: { refresh: true } }
* @param {Function} options.onFailure Side effect function to be executed upon failure, e.g. { onFailure: error => notify(error.message) }
*
* @returns The current request state. Destructure as { data, total, ids, error, loading, loaded, refetch }.
*
* @example
*
* import { useGetManyReference } from '../app';
*
* const PostComments = ({ post_id }) => {
* const { data, ids, loading, error } = useGetManyReference(
* 'comments',
* 'post_id',
* post_id,
* { page: 1, perPage: 10 },
* { field: 'published_at', order: 'DESC' }
* {},
* 'posts',
* );
* if (loading) { return
ERROR
; } * return