TypeTags .AsyncGenFn

Overview#

The async function* declaration (async function keyword followed by an asterisk) defines an async generator function, which returns an AsyncGenerator object.

Usage#

import { TypeTags } from 'typetags'

async function* infinite() {
  let index = 0

  while (true) {
    yield index++
  }
}

console.log(TypeTags.AsyncGenFn)
// → [object AsyncGeneratorFunction]

console.log(TypeTags.AsyncGeneratorFunction)
// → [object AsyncGeneratorFunction]

Predicate#

.isAsyncGenFn(value)#

• Checks if value is or has a default AsyncGeneratorFunction type tag.

const { TypeTags } = require('typetags')

let myFunction = async function* () {
  yield [1, 2, 3]
}

TypeTags.isAsyncGenFn(myFunction)
// → true

TypeTags.isAsyncGeneratorFunction(myFunction)
// → true

Metadata (TType)#

Signature#

declare type ITypeTags = {
  [key in Types | NestedTypes]: Tags
}

declare interface Predicate {
  predicate(value: any): boolean
}

See MDN Web Docs#