UseQueryWithPaginationReturnType

The return type of the useQueryWithPagination hook comprises of the data, error logs, loading indicator, and pagination object.

Example

{
  "data": {},
  "error": {},
  "loading": false,
  "pagination": {
    "hasNextPage": true,
    "hasPrevPage": true,
    "getNextPage": () => {},
    "getPrevPage": () => {}
  }
}

Type Signature

type UseQueryWithPaginationReturnType = {
  data: any;
  error: any;
  loading: boolean;
  pagination: Pagination;
};

Fields

Param	Type	Default Value	Description
data	any	null	Response data from GraphQL query if API call succeeds.
error	any	null	Error logs from GraphQL query if API call failed.
loading	boolean	false	Returns true to indicate if the API call is in a loading state, otherwise false.
pagination	Pagination	-	A pagination object that returns the pagination state and function to change pages