Class EventGenerator<S, E>

constructor

• new EventGenerator<
      S extends Record<string, any>,
      E extends string | number | symbol | RegExp = keyof S,
  >(
      observer: ObserverEngine<S>,
      event: RegExp | E,
      options?: EventGeneratorOptions,
  ): EventGenerator<S, E>

  Type Parameters

  • S extends Record<string, any>
  • E extends string | number | symbol | RegExp = keyof S

  Parameters

  • observer: ObserverEngine<S>
  • event: RegExp | E
  • Optionaloptions: EventGeneratorOptions

  Returns EventGenerator<S, E>

cleanup

next

done

• get done(): boolean

  Returns boolean

lastValue

• get lastValue(): E extends keyof S
      ? S[E]
      : E extends RegExp ? RgxEmitData<S> : S[keyof S]

  Returns E extends keyof S ? S[E] : E extends RegExp ? RgxEmitData<S> : S[keyof S]

[asyncIterator]

• "[asyncIterator]"(): AsyncGenerator<
      Awaited<EventData<S, E>>,
      undefined,
      unknown,
  >

  Returns AsyncGenerator<Awaited<EventData<S, E>>, undefined, unknown>

emit

• emit(data?: E extends keyof S ? S[E] : S[keyof S]): void

  Parameters

  • Optionaldata: E extends keyof S ? S[E] : S[keyof S]

  Returns void