TypeTags .AsyncGenerator

Overview#

The AsyncGenerator object is returned by an async generator function and it conforms to both the iterable protocol and the iterator protocol.

Usage#

import { TypeTags } from 'typetags'

async function* infinite() {
  let index = 0

  while (true) {
    yield index++
  }
}

const asyncGenerator = infinite()

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

Predicate#

.isAsyncGenerator(value)#

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

const { TypeTags } = require('typetags')

let asyncGen = (async function* () {})()

TypeTags.isAsyncGenerator(asyncGen)
// → true

let maybeTag = asyncGen.toString()

TypeTags.isAsyncGenerator(maybeTag)
// → true

Metadata (TType)#

Signature#

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

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

See MDN Web Docs#