is-async-function

Is function really asynchronous function? Trying to guess that based on check if common-callback-names exists as function arguments names or you can pass your custom.

Install

npm i is-async-function --save

Usage

For more use-cases see the tests

const isAsyncFunction = require('is-async-function')

isAsyncFunction

Trying to guess is fn asynchronous function or not. But not is-callback-function be aware of that diff.

Params

• fn {Function}: Is this fn a callback function.
• names {Array}: Arguments names, default are common-callback-names.
• returns {Boolean}

Example

var fs = require('fs')
var isAsyncFn = require('is-async-function')

console.log(isAsyncFunction(fs.readFile)) // => true
console.log(isAsyncFunction(fs.stat)) // => true

console.log(isAsyncFunction(fs.readFileSync)) // => false
console.log(isAsyncFunction(fs.statSync)) // => false

// or pass custom names to recognize as `async`
console.log(isAsyncFunction(fs.stat, ['cb'])) // => false
console.log(isAsyncFunction(fs.readFile, ['callback', 'next']))
// => false, because fs.readFile uses `callback_`

Related

• common-callback-names: List of common callback names - callback, cb, callback_, next, done. | homepage
• fn-args: Get the arguments of a function | homepage
• fn-name: Get the name of a named function | homepage
• function-arguments: Get arguments of a function, useful for and used in dependency injectors.… more | homepage
• get-fn-name: Get function name with strictness and correctness in mind. Also works for… more | homepage
• is-callback-function: Returns true if function is a callback. Checks its name is one… more | homepage
• parse-function: Parse a function, arrow function or string to object with name, args,… more | homepage

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
But before doing anything, please read the CONTRIBUTING.md guidelines.

Charlike Make Reagent