How do I check if a JavaScript function returns a Promise?

In JavaScript, checking if a function returns a Promise can be achieved through several methods. First, it's important to understand that a Promise is an object representing the result of an asynchronous operation. Here are some general methods to check if a function returns a Promise:

Method 1: Using the instanceof Operator

The most straightforward approach is to use the instanceof operator. If an object is an instance of the Promise constructor, instanceof Promise will return true. For example:

javascript
function mightReturnPromise() {
    return new Promise((resolve, reject) => {
        resolve("Hello World");
    });
}

const result = mightReturnPromise();
console.log(result instanceof Promise);  // Output: true

In this example, we define a function mightReturnPromise that returns a new Promise object. Then we check if the return value is an instance of Promise.

Method 2: Checking for the .then Method

Since all Promise objects have a .then method, you can check if an object has the .then method to determine if it is a Promise. This method is applicable not only to native Promises but also to thenable objects that conform to the Promise specification.

javascript
function mightReturnPromise() {
    return new Promise((resolve, reject) => {
        resolve("Hello again");
    });
}

const result = mightReturnPromise();
console.log(typeof result.then === 'function');  // Output: true

The advantage of this method is that it can identify objects that adhere to the Promise specification but are not native Promises.

Method 3: Using Promise.resolve()

Another less common but effective method is to use Promise.resolve(). If the object passed to Promise.resolve() is a Promise, it will return the object unchanged.

javascript
function mightReturnPromise() {
    return new Promise((resolve, reject) => {
        resolve("Sample promise");
    });
}

const result = mightReturnPromise();
console.log(Promise.resolve(result) === result);  // Output: true

If result is a Promise, Promise.resolve(result) will return result itself, allowing you to verify if result is a Promise by comparing equality.

Summary

These are several methods to check if a JavaScript function returns a Promise. In practice, choose the most suitable method based on your specific requirements and environment. For example, if you are dealing with objects from third-party libraries and are unsure if they fully adhere to the Promise specification, checking for the .then method may be a safer choice.