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

Usage in Deno

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

Returns true if the value is a generator object as returned from a built-in 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.

function* foo() {}
const generator = foo();
util.types.isGeneratorObject(generator);  // Returns true

Parameters

object: unknown

Return Type

object is Generator