BrandTurner / bluefeather

A collection of Promise utilities.

Bluefeather

A collection of Promise utilities.

• Utility functions
  • delay
  • mapSeries
  • promisify

Utility functions

delay

type DelayType = (ms: number) => Promise<void>;

/**
 * Creates a promise that is scheduled to resolve after a set delay.
 */
const delay: DelayType;

mapSeries

type CallbackType = (currentValue: any, index: any, values: Iterable<any>) => any;

type MapSeriesType = (values: Array<any>, mapper: CallbackType) => Promise<Array<any>>;

/**
 * Creates a promise that is scheduled to resolve after a set delay.
 */
const mapSeries: MapSeriesType;

promisify

/**
 * @property multipleArguments Makes the resulting promise fulfill with an array of the callback's success value(s).
 */
type PromisifyOptionsType = {|
  multipleArguments?: boolean
|};

type PromisifyType = (nodeFunction: Function, options?: PromisifyOptionsType) => Function;

/**
 * Creates a function that when executed returns a promise whose fait depends
 * on the callback provided as the last parameter to the wrapped function.
 */
const promisify: PromisifyType;