Skip to content

Commit dbb52a7

Browse files
committed
feat: update deps, ci, readme
Signed-off-by: Charlike Mike Reagent <[email protected]>
1 parent a9f441f commit dbb52a7

File tree

5 files changed

+58
-57
lines changed

5 files changed

+58
-57
lines changed

.npmrc

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
ignore-engines = true

.travis.yml

+2-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,8 @@ sudo: false
22
language: node_js
33

44
node_js:
5-
- "6"
5+
- "10"
6+
- "12"
67

78
notifications:
89
email: false

.verb.md

+15-16
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,13 @@
1-
# {%= name %} {%= badge('npm') %} [![mit license][license-img]][license-url] {%= badge('downloads') %} [![npm total downloads][downloads-img]][downloads-url]
1+
# {%= name %} [![npm version][npmv-img]][npmv-url] [![mit license][license-img]][license-url] {%= badge('downloads') %} [![npm total downloads][downloads-img]][downloads-url]
22

33
> {%= description %}
44
5-
[![code climate][codeclimate-img]][codeclimate-url]
65
[![code style][standard-img]][standard-url]
76
[![linux build][travis-img]][travis-url]
8-
[![windows build][appveyor-img]][appveyor-url]
97
[![code coverage][coverage-img]][coverage-url]
108
[![dependency status][david-img]][david-url]
119
[![paypal donate][paypalme-img]][paypalme-url]
10+
[![Buy me a Kofi][kofi-img]][kofi-url]
1211

1312
{%= include('highlight') %}
1413

@@ -130,28 +129,28 @@ _Project scaffolded using [charlike][] cli._
130129
{%= reflinks(verb.reflinks) %}
131130

132131
[license-url]: https://www.npmjs.com/package/{%= name %}
133-
[license-img]: https://img.shields.io/npm/l/{%= name %}.svg
132+
[license-img]: https://badgen.net/npm/license/{%= name %}
134133

135134
[downloads-url]: https://www.npmjs.com/package/{%= name %}
136-
[downloads-img]: https://img.shields.io/npm/dt/{%= name %}.svg
137-
138-
[codeclimate-url]: https://codeclimate.com/github/{%= repository %}
139-
[codeclimate-img]: https://img.shields.io/codeclimate/github/{%= repository %}.svg
135+
[downloads-img]: https://badgen.net/npm/dt/{%= name %}
140136

141137
[travis-url]: https://travis-ci.org/{%= repository %}
142-
[travis-img]: https://img.shields.io/travis/{%= repository %}/master.svg?label=linux
143-
144-
[appveyor-url]: https://ci.appveyor.com/project/tunnckoCore/{%= name %}
145-
[appveyor-img]: https://img.shields.io/appveyor/ci/tunnckoCore/{%= name %}/master.svg?label=windows
138+
[travis-img]: https://badgen.net/travis/{%= repository %}/master?label=build&icon=travis
146139

147140
[coverage-url]: https://codecov.io/gh/{%= repository %}
148-
[coverage-img]: https://img.shields.io/codecov/c/github/{%= repository %}/master.svg
141+
[coverage-img]: https://badgen.net/codecov/c/github/{%= repository %}/master
149142

150143
[david-url]: https://david-dm.org/{%= repository %}
151-
[david-img]: https://img.shields.io/david/{%= repository %}.svg
144+
[david-img]: https://badgen.net/david/dep/{%= repository %}
152145

153146
[standard-url]: https://github.com/feross/standard
154-
[standard-img]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg
147+
[standard-img]: https://badgen.net/badge/code%20style/standard/green
155148

156149
[paypalme-url]: https://www.paypal.me/tunnckoCore
157-
[paypalme-img]: https://img.shields.io/badge/paypal-donate-brightgreen.svg
150+
[paypalme-img]: https://badgen.net/badge/paypal/donate/green
151+
152+
[kofi-url]: https://ko-fi.com/tunnckoCore
153+
[kofi-img]: https://badgen.net/badge/Buy%20me/a%20coffee/29abe0c2?icon=https://rawcdn.githack.com/tunnckoCore/badgen-icons/f8264c6414e0bec449dd86f2241d50a9b89a1203/icons/kofi.svg
154+
155+
[npmv-url]: https://www.npmjs.com/package/{%= name %}
156+
[npmv-img]: https://badgen.net/npm/v/{%= name %}?icon=npm

README.md

+34-33
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,13 @@
1-
# is-async-function [![NPM version](https://img.shields.io/npm/v/is-async-function.svg?style=flat)](https://www.npmjs.com/package/is-async-function) [![mit license][license-img]][license-url] [![NPM monthly downloads](https://img.shields.io/npm/dm/is-async-function.svg?style=flat)](https://npmjs.org/package/is-async-function) [![npm total downloads][downloads-img]][downloads-url]
1+
# is-async-function [![npm version][npmv-img]][npmv-url] [![mit license][license-img]][license-url] [![NPM monthly downloads](https://img.shields.io/npm/dm/is-async-function.svg?style=flat)](https://npmjs.org/package/is-async-function) [![npm total downloads][downloads-img]][downloads-url]
22

33
> 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.
44
5-
[![code style][standard-img]][standard-url]
6-
[![linux build][travis-img]][travis-url]
7-
[![windows build][appveyor-img]][appveyor-url]
8-
[![code coverage][coverage-img]][coverage-url]
5+
[![code style][standard-img]][standard-url]
6+
[![linux build][travis-img]][travis-url]
7+
[![code coverage][coverage-img]][coverage-url]
98
[![dependency status][david-img]][david-url]
10-
11-
[![Become a Patron][patreon-img]][patreon-url] [![ko-fi.com buy me a coffee][kofi-img]][kofi-url]
9+
[![paypal donate][paypalme-img]][paypalme-url]
10+
[![Buy me a Kofi][kofi-img]][kofi-url]
1211

1312
You might also be interested in [always-done](https://github.com/hybridables/always-done#readme).
1413

@@ -46,9 +45,12 @@ $ yarn add is-async-function
4645
const isAsyncFunction = require('is-async-function')
4746
```
4847

48+
_**Important Note:** It may fail, if the given function is using "default params" like `options = { foo: 1 }`.
49+
That limitation comes currently from the `function-arguments` package. It may or may not be fixed there in future._
50+
4951
## API
5052

51-
### [isAsyncFunction](index.js#L50)
53+
### [isAsyncFunction](index.js#L53)
5254
> Trying to guess is `fn` asynchronous function or not. But not [is-callback-function][] be aware of that diff.
5355
5456
**Params**
@@ -119,17 +121,17 @@ console.log(isAsyncFn(myAsyncFn, ['callback', 'qux'], false)) // => 1
119121
- [always-done](https://www.npmjs.com/package/always-done): Handle completion and errors with elegance! Support for streams, callbacks, promises, child processes, async/await and sync functions. A drop-in replacement… [more](https://github.com/hybridables/always-done#readme) | [homepage](https://github.com/hybridables/always-done#readme "Handle completion and errors with elegance! Support for streams, callbacks, promises, child processes, async/await and sync functions. A drop-in replacement for [async-done][] - pass 100% of its tests plus more")
120122
- [common-callback-names](https://www.npmjs.com/package/common-callback-names): List of common callback names - callback, cb, callback_, next, done. | [homepage](https://github.com/tunnckocore/common-callback-names#readme "List of common callback names - callback, cb, callback_, next, done.")
121123
- [fn-args](https://www.npmjs.com/package/fn-args): Get the arguments of a function, arrow function, generator function, async function | [homepage](https://github.com/sindresorhus/fn-args#readme "Get the arguments of a function, arrow function, generator function, async function")
122-
- [fn-name](https://www.npmjs.com/package/fn-name): Get the name of a named function | [homepage](https://github.com/sindresorhus/fn-name "Get the name of a named function")
124+
- [fn-name](https://www.npmjs.com/package/fn-name): Get the name of a named function | [homepage](https://github.com/sindresorhus/fn-name#readme "Get the name of a named function")
123125
- [function-arguments](https://www.npmjs.com/package/function-arguments): Get arguments of a function, useful for and used in dependency injectors. Works for regular functions, generator functions and arrow… [more](https://github.com/tunnckocore/function-arguments#readme) | [homepage](https://github.com/tunnckocore/function-arguments#readme "Get arguments of a function, useful for and used in dependency injectors. Works for regular functions, generator functions and arrow functions.")
124126
- [get-fn-name](https://www.npmjs.com/package/get-fn-name): Get function name with strictness and correctness in mind. Also works for arrow functions and getting correct name of bounded… [more](https://github.com/tunnckocore/get-fn-name#readme) | [homepage](https://github.com/tunnckocore/get-fn-name#readme "Get function name with strictness and correctness in mind. Also works for arrow functions and getting correct name of bounded functions. Powered by [fn-name][].")
125127
- [is-callback-function](https://www.npmjs.com/package/is-callback-function): Returns true if function is a callback. Checks its name is one of [common-callback-names][] - callback, cb, cb_, callback_, next… [more](https://github.com/tunnckocore/is-callback-function#readme) | [homepage](https://github.com/tunnckocore/is-callback-function#readme "Returns true if function is a callback. Checks its name is one of [common-callback-names][] - callback, cb, cb_, callback_, next, done, they can be customized, these are default.")
126128
- [minibase](https://www.npmjs.com/package/minibase): Minimalist alternative for Base. Build complex APIs with small units called plugins. Works well with most of the already existing… [more](https://github.com/node-minibase/minibase#readme) | [homepage](https://github.com/node-minibase/minibase#readme "Minimalist alternative for Base. Build complex APIs with small units called plugins. Works well with most of the already existing [base][] plugins.")
127-
- [parse-function](https://www.npmjs.com/package/parse-function): Parse a function into an object that has its name, body, args and a few more useful properties. | [homepage](https://github.com/tunnckocore/parse-function#readme "Parse a function into an object that has its name, body, args and a few more useful properties.")
129+
- [parse-function](https://www.npmjs.com/package/parse-function): Parse a function into an object using espree, acorn or babylon parsers. Extensible through Smart Plugins | [homepage](https://tunnckocore.com/opensource "Parse a function into an object using espree, acorn or babylon parsers. Extensible through Smart Plugins")
128130
- [try-catch-core](https://www.npmjs.com/package/try-catch-core): Low-level package to handle completion and errors of sync or asynchronous functions, using [once][] and [dezalgo][] libs. Useful for and… [more](https://github.com/hybridables/try-catch-core#readme) | [homepage](https://github.com/hybridables/try-catch-core#readme "Low-level package to handle completion and errors of sync or asynchronous functions, using [once][] and [dezalgo][] libs. Useful for and used in higher-level libs such as [always-done][] to handle completion of anything.")
129131

130132
## Contributing
131-
Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](https://github.com/tunnckoCore/is-async-function/issues/new).
132-
Please read the [contributing guidelines](CONTRIBUTING.md) for advice on opening issues, pull requests, and coding standards.
133+
Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](https://github.com/tunnckoCore/is-async-function/issues/new).
134+
Please read the [contributing guidelines](CONTRIBUTING.md) for advice on opening issues, pull requests, and coding standards.
133135
If you need some help and can spent some cash, feel free to [contact me at CodeMentor.io](https://www.codementor.io/tunnckocore?utm_source=github&utm_medium=button&utm_term=tunnckocore&utm_campaign=github) too.
134136

135137
**In short:** If you want to contribute to that project, please follow these things
@@ -159,23 +161,24 @@ $ npm install && npm test
159161

160162
## Author
161163
**Charlike Mike Reagent**
164+
+ [GitHub Profile](https://github.com/Charlike Mike Reagent)
165+
+ [Twitter Profile](https://twitter.com/Charlike Mike Reagent)
166+
+ [LinkedIn Profile](https://linkedin.com/in/jonschlinkert)
162167

163-
+ [github/tunnckoCore](https://github.com/tunnckoCore)
164-
+ [twitter/tunnckoCore](https://twitter.com/tunnckoCore)
165168
+ [codementor/tunnckoCore](https://codementor.io/tunnckoCore)
166169

167170
## License
168-
Copyright © 2015-2018, [Charlike Mike Reagent](https://i.am.charlike.online). Released under the [MIT License](LICENSE).
171+
Copyright © 2015, 2020, [Charlike Mike Reagent](https://i.am.charlike.online). Released under the [MIT License](LICENSE).
169172

170173
***
171174

172-
_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.4.3, on March 11, 2017._
175+
_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.8.0, on January 15, 2020._
173176
_Project scaffolded using [charlike][] cli._
174177

175178
[always-done]: https://github.com/hybridables/always-done
176179
[async-done]: https://github.com/gulpjs/async-done
177180
[base]: https://github.com/node-base/base
178-
[charlike]: https://github.com/tunnckocore/charlike
181+
[charlike]: https://github.com/tunnckoCoreLabs/charlike
179182
[commitizen]: https://github.com/commitizen/cz-cli
180183
[common-callback-names]: https://github.com/tunnckocore/common-callback-names
181184
[dezalgo]: https://github.com/npm/dezalgo
@@ -187,31 +190,29 @@ _Project scaffolded using [charlike][] cli._
187190
[verb]: https://github.com/verbose/verb
188191

189192
[license-url]: https://www.npmjs.com/package/is-async-function
190-
[license-img]: https://img.shields.io/npm/l/is-async-function.svg
193+
[license-img]: https://badgen.net/npm/license/is-async-function
191194

192195
[downloads-url]: https://www.npmjs.com/package/is-async-function
193-
[downloads-img]: https://img.shields.io/npm/dt/is-async-function.svg
194-
195-
[codeclimate-url]: https://codeclimate.com/github/tunnckoCore/is-async-function
196-
[codeclimate-img]: https://img.shields.io/codeclimate/github/tunnckoCore/is-async-function.svg
196+
[downloads-img]: https://badgen.net/npm/dt/is-async-function
197197

198198
[travis-url]: https://travis-ci.org/tunnckoCore/is-async-function
199-
[travis-img]: https://img.shields.io/travis/tunnckoCore/is-async-function/master.svg?label=linux
200-
201-
[appveyor-url]: https://ci.appveyor.com/project/tunnckoCore/is-async-function
202-
[appveyor-img]: https://img.shields.io/appveyor/ci/tunnckoCore/is-async-function/master.svg?label=windows
199+
[travis-img]: https://badgen.net/travis/tunnckoCore/is-async-function/master?label=build&icon=travis
203200

204201
[coverage-url]: https://codecov.io/gh/tunnckoCore/is-async-function
205-
[coverage-img]: https://img.shields.io/codecov/c/github/tunnckoCore/is-async-function/master.svg
202+
[coverage-img]: https://badgen.net/codecov/c/github/tunnckoCore/is-async-function/master
206203

207204
[david-url]: https://david-dm.org/tunnckoCore/is-async-function
208-
[david-img]: https://img.shields.io/david/tunnckoCore/is-async-function.svg
205+
[david-img]: https://badgen.net/david/dep/tunnckoCore/is-async-function
209206

210207
[standard-url]: https://github.com/feross/standard
211-
[standard-img]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg
208+
[standard-img]: https://badgen.net/badge/code%20style/standard/green
209+
210+
[paypalme-url]: https://www.paypal.me/tunnckoCore
211+
[paypalme-img]: https://badgen.net/badge/paypal/donate/green
212+
213+
[kofi-url]: https://ko-fi.com/tunnckoCore
214+
[kofi-img]: https://badgen.net/badge/Buy%20me/a%20coffee/29abe0c2?icon=https://rawcdn.githack.com/tunnckoCore/badgen-icons/f8264c6414e0bec449dd86f2241d50a9b89a1203/icons/kofi.svg
212215

216+
[npmv-url]: https://www.npmjs.com/package/is-async-function
217+
[npmv-img]: https://badgen.net/npm/v/is-async-function?icon=npm
213218

214-
[patreon-url]: https://www.patreon.com/bePatron?u=5579781
215-
[patreon-img]: https://badgen.net/badge/become/a%20patron/F96854?icon=patreon
216-
[kofi-url]: https://ko-fi.com/tunnckocore?a=A220YCY
217-
[kofi-img]: https://badgen.net/badge/buy%20me/a%20coffee/29ABE0?icon=kofi

package.json

+6-7
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "is-async-function",
3-
"version": "1.2.3",
3+
"version": "1.2.4",
44
"description": "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.",
55
"repository": "tunnckoCore/is-async-function",
66
"author": "Charlike Mike Reagent <@tunnckoCore> (https://i.am.charlike.online)",
@@ -23,15 +23,14 @@
2323
"arr-includes": "^2.2.0",
2424
"arrify": "^2.0.1",
2525
"common-callback-names": "^2.0.1",
26-
"function-arguments": "^1.0.8",
27-
"micromatch": "^4.0.2"
26+
"function-arguments": "^1.0.8"
2827
},
2928
"devDependencies": {
30-
"commitizen": "~4.0.3",
31-
"cz-conventional-changelog": "3.0.2",
32-
"is-match": "^1.0.0",
29+
"commitizen": "^4.0.3",
30+
"cz-conventional-changelog": "^3.0.2",
31+
"micromatch": "^4.0.2",
3332
"mukla": "^0.4.9",
34-
"npm-run-all": "~4.1.5",
33+
"npm-run-all": "^4.1.5",
3534
"nyc": "^15.0.0",
3635
"pre-commit": "^1.2.2",
3736
"standard": "^14.3.1",

0 commit comments

Comments
 (0)