Revert "Improve ora.promise() (sindresorhus#181)"

This reverts commit 9c01990.

index.d.ts

@@ -133,22 +133,6 @@ declare namespace ora {
 		readonly prefixText?: string | PrefixTextGenerator;
 	}
 
-	interface PromiseOptions<T> extends Options {
-		/**
-		The new text of the spinner when the promise is resolved.
-
-		If undefined, will keep the initial text.
-		*/
-		successText?: string | ((result: T) => string);
-
-		/**
-		The new text of the spinner when the promise is rejected.
-
-		If undefined, will keep the initial text.
-		*/
-		failText?: string | ((error: Error) => string);
-	}
-
 	interface Ora {
 		/**
 		A boolean of whether the instance is currently spinning.
@@ -275,19 +259,19 @@ declare const ora: {
 	}, 1000);
 	```
 	*/
-	(options?: string | ora.Options): ora.Ora;
+	(options?: ora.Options | string): ora.Ora;
 
 	/**
-	Starts a spinner for a function or a promise. The spinner is stopped with `.succeed()` if the promise fulfills or with `.fail()` if it rejects. Returns the Promise.
+	Starts a spinner for a promise. The spinner is stopped with `.succeed()` if the promise fulfills or with `.fail()` if it rejects.
 
 	@param action - The promise to start the spinner for.
 	@param options - If a string is provided, it is treated as a shortcut for `options.text`.
 	@returns The spinner instance.
 	*/
-	promise<T>(
-		action: PromiseLike<T> | ((spinner: ora.Ora) => PromiseLike<T>),
-		options?: string | ora.PromiseOptions<T>
-	): Promise<T>;
+	promise(
+		action: PromiseLike<unknown>,
+		options?: ora.Options | string
+	): ora.Ora;
 };
 
 export = ora;

index.js

@@ -393,35 +393,23 @@ const oraFactory = function (options) {
 
 module.exports = oraFactory;
 
-// https://github.com/sindresorhus/ora/issues/169#issuecomment-873269524
-module.exports.promise = async (action, options) => {
-	const actionIsFunction = typeof action === 'function';
+module.exports.promise = (action, options) => {
 	// eslint-disable-next-line promise/prefer-await-to-then
-	const actionIsPromise = typeof action.then === 'function';
-
-	if (!actionIsFunction && !actionIsPromise) {
-		throw new TypeError('Parameter `action` must be a Function or a Promise');
+	if (typeof action.then !== 'function') {
+		throw new TypeError('Parameter `action` must be a Promise');
 	}
 
-	const {successText, failText} = typeof options === 'object' ?
-		options :
-		{successText: undefined, failText: undefined};
-
-	const spinner = new Ora(options); // Set the initial string or ora options.
+	const spinner = new Ora(options);
 	spinner.start();
-	try {
-		const promise = actionIsFunction ? action(spinner) : action;
-		const result = await promise;
-		spinner.succeed(successText === undefined ?
-			undefined :
-			(typeof successText === 'string' ? successText : successText(result))
-		);
-		return result;
-	} catch (error) {
-		spinner.fail(failText === undefined ?
-			undefined :
-			(typeof failText === 'string' ? failText : failText(error))
-		);
-		throw error;
-	}
+
+	(async () => {
+		try {
+			await action;
+			spinner.succeed();
+		} catch {
+			spinner.fail();
+		}
+	})();
+
+	return spinner;
 };

index.test-d.ts

@@ -45,27 +45,11 @@ spinner.render();
 spinner.frame();
 
 const resolves = Promise.resolve(1);
-void promise(resolves, 'foo');
-void promise(resolves, {
+promise(resolves, 'foo');
+promise(resolves, {
 	stream: new PassThroughStream(),
 	text: 'foo',
 	color: 'blue',
 	isEnabled: true,
 	isSilent: false
 });
-void promise(async () => {
-	await resolves;
-}, 'foo');
-void promise(async spinner => {
-	spinner.prefixText = 'foo';
-	await resolves;
-	return 7;
-}, {
-	stream: new PassThroughStream(),
-	text: 'foo',
-	color: 'blue',
-	isEnabled: true,
-	isSilent: false,
-	successText: result => `Resolved with number ${result}`,
-	failText: 'bar'
-});

readme.md

@@ -226,28 +226,11 @@ Change the spinner indent.
 ### ora.promise(action, text)
 ### ora.promise(action, options)
 
-Starts a spinner for a function or a promise. The spinner is stopped with `.succeed()` if the promise fulfills or with `.fail()` if it rejects. Returns the promise.
+Starts a spinner for a promise. The spinner is stopped with `.succeed()` if the promise fulfills or with `.fail()` if it rejects. Returns the spinner instance.
 
 #### action
 
-Type: `Promise | ((spinner: ora.Ora) => Promise)`
-
-#### options
-
-Type: `object`
-
-All of the [options](#options) plus the following:
-
-##### successText
-Type: `string | ((result: T) => string)`
-
-The new text of the spinner when the promise is resolved. If undefined, will keep the initial text.
-
-##### failText
-Type: `string | ((error: Error) => string)`
-
-The new text of the spinner when the promise is rejected. If undefined, will keep the initial text.
-
+Type: `Promise`
 
 ## FAQ
 

test.js

@@ -169,13 +169,15 @@ test('.promise() - rejects', async t => {
 	const output = getStream(stream);
 	const rejects = Promise.reject(new Error()); // eslint-disable-line unicorn/error-message
 
+	Ora.promise(rejects, {
+		stream,
+		text: 'foo',
+		color: false,
+		isEnabled: true
+	});
+
 	try {
-		await Ora.promise(rejects, {
-			stream,
-			text: 'foo',
-			color: false,
-			isEnabled: true
-		})
+		await rejects;
 	} catch {}
 
 	stream.end();