is-generator-function
Advanced tools
Package description
The is-generator-function package is a utility that allows you to check if a given function is a generator function. This can be particularly useful when working with code that dynamically generates functions or when integrating with libraries that may use generator functions for asynchronous control flow.
Check if a function is a generator function
This feature allows you to distinguish between regular JavaScript functions and generator functions. By passing a function to `isGeneratorFunction`, it returns `true` if the function is a generator function and `false` otherwise. This can be useful for dynamic function handling or when working with APIs that may provide generator functions.
const isGeneratorFunction = require('is-generator-function');
function* myGenerator() {}
const regularFunction = function() {};
console.log(isGeneratorFunction(myGenerator)); // true
console.log(isGeneratorFunction(regularFunction)); // falseSimilar to is-generator-function, is-generator checks if a given value is a generator object, which is different from checking if a function is a generator function. It's useful for identifying generator objects, but not for identifying generator functions directly.
While is-function is more general and checks if a given value is a function, it does not specifically differentiate between regular functions and generator functions. It's broader in scope compared to is-generator-function, which is specifically designed to identify generator functions.
Changelog
v1.0.4 - 2015-03-03
#2node/iojs versions now ship with an npm that understands ^. 6562e80travis-ci tests on iojs and node v0.12; speed up builds; allow 0.8 failures. 592f768io.js edca329replace in 209fac444b4bd90eaa8df279457c4a15e6bba6d2 3ebfb38semver c21baa5jscs 71a68f4tape 32c03cfReadme
#is-generator-function 
Is this an ES6 generator function?
var isGeneratorFunction = require('is-generator-function');
assert(!isGeneratorFunction(function () {}));
assert(!isGeneratorFunction(null));
assert(isGeneratorFunction(function* () { yield 42; return Infinity; });
Simply clone the repo, npm install, and run npm test
FAQs
Determine if a function is a native generator function.
The npm package is-generator-function receives a total of 15,436,401 weekly downloads. As such, is-generator-function popularity was classified as popular.
We found that is-generator-function demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
NIST's new AI Risk Management Framework aims to enhance the security and reliability of generative AI systems and address the unique challenges of malicious AI exploits.
Security News
This episode of the Risky Biz podcast discusses how the rise of small open source packages and the shift towards individual maintainers makes the ecosystem more vulnerable to supply chain attacks.
Product
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.