How to know if a function is async?

Question

I have to pass a function to another function, and execute it as a callback. The problem is that sometimes this function is async, like:

async function() {
 // Some async actions
}

So I want to execute await callback() or callback() depending on the type of function that it is receiving.

Is there a way to know the type of the function??

Answer 1

Theory

Native async functions may be identifiable when being converted to strings:

asyncFn[Symbol.toStringTag] === 'AsyncFunction'

Or by AsyncFunction constructor:

const AsyncFunction = (async () => {}).constructor;

asyncFn instanceof AsyncFunction === true

This won't work with Babel/TypeScript output, because asyncFn is regular function in transpiled code, it is an instance of Function or GeneratorFunction, not AsyncFunction. To make sure that it won't give false positives for generator and regular functions in transpiled code:

const AsyncFunction = (async () => {}).constructor;
const GeneratorFunction = (function* () => {}).constructor;

(asyncFn instanceof AsyncFunction && AsyncFunction !== Function && AsyncFunction !== GeneratorFunction) === true

Since native async functions were officially introduced to Node.js in 2017, the question likely refers to Babel implementation of async function, which relies on transform-async-to-generator to transpile async to generator functions, may also use transform-regenerator to transpile generator to regular functions.

The result of async function call is a promise. According to the proposal, a promise or a non-promise may be passed to await, so await callback() is universal.

There are only few edge cases when this may be needed. For instance, native async functions use native promises internally and don't pick up global Promise if its implementation was changed:

let NativePromise = Promise;
Promise = CustomPromiseImplementation;

Promise.resolve() instanceof Promise === true
(async () => {})() instanceof Promise === false;
(async () => {})() instanceof NativePromise === true;

This may affect function behaviour (this is a known problem for Angular and Zone.js promise implementation). Even then it's preferable to detect that function return value is not expected Promise instance instead of detecting that a function is async, because the same problem is applicable to any function that uses alternative promise implementation, not just async (the solution to said Angular problem is to wrap async return value with Promise.resolve).

Practice

From the outside, async function is just a function that unconditionally returns native promise, therefore it should be treated like one. Even if a function once was defined async, it can be transpiled at some point and become regular function.

A function that can return a promise

In ES6, a function that potentially returns a promise can be used with Promise.resolve (lets synchronous errors) or wrapped Promise constructor (handles synchronous errors):

Promise.resolve(fnThatPossiblyReturnsAPromise())
.then(result => ...);

new Promise(resolve => resolve(fnThatPossiblyReturnsAPromiseOrThrows()))
.then(result => ...);

In ES2017, this is done with await (this is how the example from the question is supposed to be written):

let result = await fnThatPossiblyReturnsAPromiseOrThrows();
...

A function that should return a promise

Checking if an object is a promise is a matter of a separate question, but generally it shouldn't be too strict or loose in order to cover corner cases. instanceof Promise may not work if global Promise was replaced, Promise !== (async () => {})().constructor. This can happen when Angular and non-Angular applications interface.

A function that requires to be async, i.e. to always return a promise should be called first, then returned value is checked to be a promise:

let promise = fnThatShouldReturnAPromise();
if (promise && typeof promise.then === 'function' && promise[Symbol.toStringTag] === 'Promise') {
  // is compliant native promise implementation
} else {
  throw new Error('async function expected');
}

TL;DR: async functions shouldn't be distinguished from regular functions that return promises. There is no reliable way and no practical reason to detect non-native transpiled async functions.

Answer 2

I prefer this simple way:

theFunc.constructor.name == 'AsyncFunction'

Answer 3

Both @rnd, and @estus are correct.

But to answer the question with an actual working solution here you go

function isAsync (func) {
    const string = func.toString().trim();

    return !!(
        // native
        string.match(/^async /) ||
        // babel (this may change, but hey...)
        string.match(/return _ref[^\.]*\.apply/)
        // insert your other dirty transpiler check

        // there are other more complex situations that maybe require you to check the return line for a *promise*
    );
}

This is a very valid question, and I'm upset that someone down voted him. The main usecase for this type of checking is for a library/framework/decorators.

These are early days, and we shouldn't downvote VALID questions.

Answer 4

In case you're using NodeJS 10.x or later

Use the native util function.

   util.types.isAsyncFunction(function foo() {});  // Returns false
   util.types.isAsyncFunction(async function foo() {});  // Returns true

Do keep all the concerns in mind from above ansers though. A function that just returns by accident a promise, will return a false negative.

And on top of that (from the docs):

Note that this only reports back what the JavaScript engine is seeing; in particular, the return value may not match the original source code if a transpilation tool was used.

But if you use async in NodeJS 10 and no transiplation. This is a nice solution.

Answer 5

TL;DR

Short answer: Use instaceof after exposing AsyncFunction - see below.

Long answer: Don't do that - see below.

How to do it

You can detect whether a function was declared with the async keyword

When you create a function, it shows that it's a type Function:

> f1 = function () {};
[Function: f1]

You can test it with the instanceof operator:

> f1 instanceof Function
true

When you create an async function, it shows that it's a type AsyncFunction:

> f2 = async function () {}
[AsyncFunction: f2]

so one might expect that it can be tested with instanceof as well:

> f2 instanceof AsyncFunction
ReferenceError: AsyncFunction is not defined

Why is that? Because the AsyncFunction is not a global object. See the docs:

• https://developer.mozilla.org/Web/JavaScript/Reference/Global_Objects/AsyncFunction

even though, as you can see, it's listed under Reference/Global_Objects...

If you need easy access to the AsyncFunction then you can use my unexposed module:

• https://www.npmjs.com/package/unexposed

to get either a local variable:

const { AsyncFunction } = require('unexposed');

or to add a global AsyncFunction alongside other global objects:

require('unexposed').addGlobals();

and now the above works as expected:

> f2 = async function () {}
[AsyncFunction: f2]
> f2 instanceof AsyncFunction
true

Why you shouldn't do it

The above code will test whether the function was created with the async keyword but keep in mind that what is really important is not how a function was created but whether or not a function returns a promise.

Everywhere where you can use this "async" function:

const f1 = async () => {
  // ...
};

you could also use this:

const f2 = () => new Promise((resolve, reject) => {
});

even though it was not created with the async keyword and thus will not be matched with instanceof or with any other method posted in other answers.

Specifically, consider this:

const f1 = async (x) => {
  // ...
};

const f2 = () => f1(123);

The f2 is just f1 with hardcoded argument and it doesn't make much sense to add async here, even though the result will be as much "async" as f1 in every respect.

Summary

So it is possible to check if a function was created with the async keyword, but use it with caution because you when you check it then most likely you're doing something wrong.

Answer 6

It seems that await can be used for normal functions too. I'm not sure if it can be considered "good practice" but here it is:

async function asyncFn() {
  // await for some async stuff
  return 'hello from asyncFn' 
}

function syncFn() {
  return 'hello from syncFn'
}

async function run() {
  console.log(await asyncFn()) // 'hello from asyncFn'
  console.log(await syncFn()) // 'hello from syncFn'
}

run()

Answer 7

Hei,

Here is an approach provided by David Walsh in his blogpost:

const isAsync = myFunction.constructor.name === "AsyncFunction";

Cheers!

Answer 8

You can assume at begin that callback is promise:

export async function runSyncOrAsync(callback: Function) {

  let promisOrValue = callback()
  if (promisOrValue instanceof Promise) {
    promisOrValue = Promise.resolve(promisOrValue)
  }
  return promisOrValue;
}

and them in your code you can do this:

await runSyncOrAsync(callback)

which will solve your problem with unknowing callback type....