meet-hour-react-interval-hook/dist/Reacthook.d.ts

React hook for using self-correcting setInterval, augmented by management methods (start, stop, isActive) and also using React Class Based Component

declare type EmptyCallback = () => void;
export declare type IntervalHookCallback = (ticks?: number) => void;
export declare type IntervalHookFinishCallback = () => void;
export declare type IntervalHookStartMethod = EmptyCallback;
export declare type IntervalHookStopMethod = (triggerFinishCallback?: boolean) => void;
export declare type IntervalHookIsActiveMethod = () => boolean;
export interface IntervalHookOptions {
    onFinish?: IntervalHookFinishCallback;
    autoStart?: boolean;
    immediate?: boolean;
    selfCorrecting?: boolean;
}
export declare type IntervalHookResult = {
    start: IntervalHookStartMethod;
    stop: IntervalHookStopMethod;
    isActive: IntervalHookIsActiveMethod;
};
export declare function useInterval(callback: IntervalHookCallback, interval?: number, { onFinish, autoStart, immediate, selfCorrecting }?: IntervalHookOptions): IntervalHookResult;
export {};