export interface SpinnerPromiseOptions { promise: Promise; startMessage: string; stopMessage?: string; } /** * @summary Create a CLI Spinner that spins on a promise * @name SpinnerPromise * @public * @memberof visuals * * @description * This function will start a Spinner and stop it when the * passed promise is either fulfilled or rejected. The function * returns the passed promise which will be in either rejected or * resolved state. * * @param {Object} options - spinner promise options * @param {Promise} options.promise - promise to spin upon * @param {String} options.startMessage - start spinner message * @param {String} options.stopMessage - stop spinner message * @fulfil {Object} value - resolved or rejected promise * @returns {Promise} * * @example * visuals.SpinnerPromise * promise: scanDevicesPromise * startMessage: "Scanning devices" * stopMessage: "Scanned devices" * .then (devices) -> * console.log devices */ export declare const createSpinnerPromise: (options: SpinnerPromiseOptions) => Promise;