summaryrefslogtreecommitdiff
path: root/src/node_modules/is-generator-function/README.md
diff options
context:
space:
mode:
authorMinteck <contact@minteck.org>2021-12-21 16:52:28 +0100
committerMinteck <contact@minteck.org>2021-12-21 16:52:28 +0100
commit46e43f4bde4a35785b4997b81e86cd19f046b69b (patch)
treec53c2f826f777f9d6b2d249dab556feb72a6c3a6 /src/node_modules/is-generator-function/README.md
downloadlangdetect-46e43f4bde4a35785b4997b81e86cd19f046b69b.tar.gz
langdetect-46e43f4bde4a35785b4997b81e86cd19f046b69b.tar.bz2
langdetect-46e43f4bde4a35785b4997b81e86cd19f046b69b.zip
Commit
Diffstat (limited to 'src/node_modules/is-generator-function/README.md')
-rw-r--r--src/node_modules/is-generator-function/README.md42
1 files changed, 42 insertions, 0 deletions
diff --git a/src/node_modules/is-generator-function/README.md b/src/node_modules/is-generator-function/README.md
new file mode 100644
index 0000000..027facf
--- /dev/null
+++ b/src/node_modules/is-generator-function/README.md
@@ -0,0 +1,42 @@
+# is-generator-function <sup>[![Version Badge][2]][1]</sup>
+
+[![Build Status][3]][4]
+[![dependency status][5]][6]
+[![dev dependency status][7]][8]
+[![License][license-image]][license-url]
+[![Downloads][downloads-image]][downloads-url]
+
+[![npm badge][11]][1]
+
+[![browser support][9]][10]
+
+Is this a native generator function?
+
+## Example
+
+```js
+var isGeneratorFunction = require('is-generator-function');
+assert(!isGeneratorFunction(function () {}));
+assert(!isGeneratorFunction(null));
+assert(isGeneratorFunction(function* () { yield 42; return Infinity; }));
+```
+
+## Tests
+Simply clone the repo, `npm install`, and run `npm test`
+
+[1]: https://npmjs.org/package/is-generator-function
+[2]: http://versionbadg.es/ljharb/is-generator-function.svg
+[3]: https://travis-ci.org/ljharb/is-generator-function.svg
+[4]: https://travis-ci.org/ljharb/is-generator-function
+[5]: https://david-dm.org/ljharb/is-generator-function.svg
+[6]: https://david-dm.org/ljharb/is-generator-function
+[7]: https://david-dm.org/ljharb/is-generator-function/dev-status.svg
+[8]: https://david-dm.org/ljharb/is-generator-function#info=devDependencies
+[9]: https://ci.testling.com/ljharb/is-generator-function.png
+[10]: https://ci.testling.com/ljharb/is-generator-function
+[11]: https://nodei.co/npm/is-generator-function.png?downloads=true&stars=true
+[license-image]: http://img.shields.io/npm/l/is-generator-function.svg
+[license-url]: LICENSE
+[downloads-image]: http://img.shields.io/npm/dm/is-generator-function.svg
+[downloads-url]: http://npm-stat.com/charts.html?package=is-generator-function
+