is-async-fn
Version:
Check if something is an ES7 async function
46 lines (27 loc) • 1.04 kB
Markdown
is-async-fn
===========
[](http://travis-ci.org/jprichardson/is-async-fn)
Check if something is an [ES7/ES2016 async/await](http://pouchdb.com/2015/03/05/taming-the-async-beast-with-es7.html) function.
i.e. It checks if the function was defined with the `async` keyword. It **does NOT** attempt to detect if the function is a traditional asynchronous function, one with a callback.
Compatible with code transformed with Babel 5 and Babel 6.
Install
-------
npm i --save is-async-fn
Usage
-----
### isAsyncFn
**Signature:** `isAsyncFn(function)`
**Parameters:**
- `function`: The function to check.
**Returns:** Type `boolean`. Returns `true` if the `function` was defined with the
`async` keyword.
**Example:**
```js
import isAsyncFn from 'is-async-fn'
console.log(isAsyncFn(function () {})) // => false
console.log(isAsyncFn(async function () {})) // => true
```
License
-------
MIT
Copyright (c) [JP Richardson](https://github.com/jprichardson)