react-promise-tracker/index.d.ts

Simple React Promise tracker Hook/HOC helper to add loading spinner indicators

// Type definitions for react-promise-tracker
// Project: https://github.com/Lemoncode/react-promise-tracker
// Definitions by: Lemoncode <https://github.com/lemoncode>

import * as React from "react";

/**
 * It tracks a promise while in pending state.
 * @param promise Input promise to be tracked.
 * @returns It returns the same promise as input.
 */
export function trackPromise<T>(promise: Promise<T>, area?: string): Promise<T>;

/**
 * Configuration contract: user can setup areas (display more than one spinner) or delay when
 * the spinner is shown (this is useful when a user has a fast connection, to avoid unneccessary flickering)
 */

interface Config {
   area?: string;
   delay?: number;
}

/**
 * It wraps a given React component into a new component that adds properties to watch
 * pending promises (HOC).
 * @param component Input component to be wrapped.
 * @returns It returns a new component that extends the input one.
 */

export interface ComponentToWrapProps {
  config: Config;
  promiseInProgress: boolean;
}

export interface TrackerHocProps {
  config?: Config;
}

export function promiseTrackerHoc<P>(component: React.ComponentType<P & ComponentToWrapProps>): React.ComponentType<P & TrackerHocProps>;

/**
 * React Promise Tracker custom hook, this hook will expose a promiseInProgress boolean flag.
 *
 * @param configuration (optional can be null).
 * @returns promiseInProgressFlag.
 */
export function usePromiseTracker(outerConfig? : Config) : { promiseInProgress : boolean };