isAsyncFunction

Checks if a value is an async function.

Returns true for any function declared with async.

Available since v2.0.0

Import

import { isAsyncFunction } from '@helpers4/guard';
// or, from the all-in-one package (same code, one install):
import { isAsyncFunction } from 'helpers4/guard';

Signature

isAsyncFunction(value: unknown): value is function

Parameters

Parameter	Type	Description
value	unknown	The value to check

Returns

value is function — True if value is an async function

Examples

isAsyncFunction

isAsyncFunction(async () => {})      // => true
isAsyncFunction(async function() {}) // => true
isAsyncFunction(() => {})            // => false
isAsyncFunction(42)                  // => false

Source

View source on GitHub