Skip to main content
isGeneratorFunction - util/types - Node documentation
function isGeneratorFunction

Usage in Deno

import { isGeneratorFunction } from "node:util/types";
isGeneratorFunction(object: unknown): object is GeneratorFunction

Returns true if the value is a generator function. This only reports back what the JavaScript engine is seeing; in particular, the return value may not match the original source code if a transpilation tool was used.

util.types.isGeneratorFunction(function foo() {});  // Returns false
util.types.isGeneratorFunction(function* foo() {});  // Returns true

Parameters

object: unknown

Return Type

object is GeneratorFunction