Function flushPromises

Parameters

• setImmediate: {
      <TArgs>(callback: ((...args: TArgs) => void), ...args: TArgs): NodeJS.Immediate;
      (callback: ((_: void) => void)): NodeJS.Immediate;
  } = global.setImmediate

  • • <TArgs>(callback: ((...args: TArgs) => void), ...args: TArgs): NodeJS.Immediate

    • Schedules the "immediate" execution of the callback after I/O events' callbacks.

      When multiple calls to setImmediate() are made, the callback functions are queued for execution in the order in which they are created. The entire callback queue is processed every event loop iteration. If an immediate timer is queued from inside an executing callback, that timer will not be triggered until the next event loop iteration.

      If callback is not a function, a TypeError will be thrown.

      This method has a custom variant for promises that is available using timersPromises.setImmediate().

      Since

      v0.9.1

      Returns

      for use with clearImmediate()

      Type Parameters

      • TArgs extends any[]

      Parameters

      • callback: ((...args: TArgs) => void)

        The function to call at the end of this turn of the Node.js Event Loop

        • • (...args: TArgs): void

          • Parameters

            • Rest ...args: TArgs

            Returns void

      • Rest ...args: TArgs

        Optional arguments to pass when the callback is called.

      Returns NodeJS.Immediate

    • (callback: ((_: void) => void)): NodeJS.Immediate

    • Parameters

      • callback: ((_: void) => void)

        • • (_: void): void

          • Parameters

            • _: void

            Returns void

      Returns NodeJS.Immediate