Checks if the given value is an AsyncFunction.

Syntax

TypeScript
import { isAsyncFunction } from '@opentf/std';

isAsyncFunction(
  val: unknown
): val is (...args: unknown[]) => Promise<unknown>

Examples

TypeScript
isAsyncFunction(function() {}) //=> false

isAsyncFunction({}) //=> false

function* generator(i) {
  yield i;
  yield i + 10;
}

isAsyncFunction(generator); //=> false

const afn = async () => {}
isAsyncFunction(afn) //=> true

async function getUsers() {}
isAsyncFunction(getUsers) //=> true

async function* aGen(i) {
  yield i;
  yield i + 10;
}

isAsyncFunction(aGen); //=> false
Last updated on
Edit this page