import { UseCancelToken } from './types'; /** * When a component unmounts, we need to cancel any potentially * ongoing Axios calls that result in a state update on success / fail. * This hook sets up the appropriate useEffect to handle the canceling. * This hook also allows manual requests cancellation. * https://dev.to/tmns/usecanceltoken-a-custom-react-hook-for-cancelling-axios-requests-1ia4 * * @returns {source: ref, newCancelToken: function, cancelPreviousRequest: function, isCancel: function} * source - used to access/set Axios cancel token source. * newCancelToken - used to generate the cancel token sent in the Axios request. * cancelPreviousRequest - used to manually cancel the previous Axios request. * isCancel - used to check if the error returned in Axios response is a cancel token error. */ export declare const useCancelToken: () => UseCancelToken;