aboutsummaryrefslogtreecommitdiff
path: root/node_modules/is-generator-fn/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'node_modules/is-generator-fn/readme.md')
-rw-r--r--node_modules/is-generator-fn/readme.md33
1 files changed, 33 insertions, 0 deletions
diff --git a/node_modules/is-generator-fn/readme.md b/node_modules/is-generator-fn/readme.md
new file mode 100644
index 0000000..654c2af
--- /dev/null
+++ b/node_modules/is-generator-fn/readme.md
@@ -0,0 +1,33 @@
+# is-generator-fn [![Build Status](https://travis-ci.org/sindresorhus/is-generator-fn.svg?branch=master)](https://travis-ci.org/sindresorhus/is-generator-fn)
+
+> Check if something is a [generator function](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/function*)
+
+
+## Install
+
+```
+$ npm install is-generator-fn
+```
+
+
+## Usage
+
+```js
+const isGeneratorFn = require('is-generator-fn');
+
+isGeneratorFn(function * () {});
+//=> true
+
+isGeneratorFn(function () {});
+//=> false
+```
+
+
+## Related
+
+- [is](https://github.com/sindresorhus/is) - Type check values
+
+
+## License
+
+MIT © [Sindre Sorhus](https://sindresorhus.com)