events-helpers.ts 1.6 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455
  1. /**
  2. * @fileoverview A set of helper functions to make it easier to work
  3. * with events in async/await manner.
  4. */
  5. /**
  6. * @param {!EventTarget} target
  7. * @param {string} eventName
  8. * @return {!Promise<!Event>}
  9. */
  10. export const waitForEvent = (target: EventTarget, eventName: string) => {
  11. return new Promise(resolve => {
  12. target.addEventListener(eventName, resolve, { once: true });
  13. });
  14. };
  15. /**
  16. * @param {!EventEmitter} emitter
  17. * @param {string} eventName
  18. * @return {!Promise<!Array>} With Event as the first item.
  19. */
  20. export const emittedOnce = (emitter: NodeJS.EventEmitter, eventName: string, trigger?: () => void) => {
  21. return emittedNTimes(emitter, eventName, 1, trigger).then(([result]) => result);
  22. };
  23. export const emittedNTimes = async (emitter: NodeJS.EventEmitter, eventName: string, times: number, trigger?: () => void) => {
  24. const events: any[][] = [];
  25. const p = new Promise<any[][]>(resolve => {
  26. const handler = (...args: any[]) => {
  27. events.push(args);
  28. if (events.length === times) {
  29. emitter.removeListener(eventName, handler);
  30. resolve(events);
  31. }
  32. };
  33. emitter.on(eventName, handler);
  34. });
  35. if (trigger) {
  36. await Promise.resolve(trigger());
  37. }
  38. return p;
  39. };
  40. export const emittedUntil = async (emitter: NodeJS.EventEmitter, eventName: string, untilFn: Function) => {
  41. const p = new Promise<any[]>(resolve => {
  42. const handler = (...args: any[]) => {
  43. if (untilFn(...args)) {
  44. emitter.removeListener(eventName, handler);
  45. resolve(args);
  46. }
  47. };
  48. emitter.on(eventName, handler);
  49. });
  50. return p;
  51. };