Types
isGeneratorFunction

Checks if the given value is a Generator Function (opens in a new tab).

Syntax

import { isGeneratorFunction } from '@opentf/std';
 
isGeneratorFunction(
  val: unknown
): boolean

Examples

isGeneratorFunction(function() {}) //=> false
 
isGeneratorFunction({}) //=> false
 
function* generator(i) {
  yield i;
  yield i + 10;
}
 
isGeneratorFunction(generator); //=> true
 
async function* aGen(i) {
  yield i;
  yield i + 10;
}
 
isGeneratorFunction(aGen); //=> true
 
const someObj = {
  *generator() {
    yield "a";
    yield "b";
  },
};
 
isGeneratorFunction(someObj.generator); //=> true

Related

Try