Class WaitGroup

A WaitGroup waits for a collection of async functions to finish.

This module simulates the working of the WaitGroup type of the sync package of the Go programming language.

The module implements a WaitGroup class, that waits for a collection of asynchronous function to finish.

The main function, that uses the WaitGroup initializes its counter or, calls the add() method to set the number of async functions to wait for. Then each of the async functions runs and calls done() when finished. The done() function must be called as many times the counter was set to. At the same time, wait() can be used to block until all async functions have finished. The done() calls may have a result: any parameter. In this case the parameter of the last done() call will be the return value of the wait() function.

If there is a problem, the fail() call will break the execution, so the wait() will return immediately with the optional result: any parameter that was given to the fail() call.

Hierarchy

  • WaitGroup

Constructors

constructor

Properties

count promise reject resolve

Methods

add done fail wait

Constructors

constructor

  • The constructor

    Parameters

    • Optional count: number

      The initial value of the counter. The default value is 1.

    Returns WaitGroup

Properties

Private count

count: number

The number of items in the group to wait for

Private promise

promise: Promise<any>

The internal promise of the wait group

Private reject

reject: any

The reject function of the internal promise of the wait group

Private resolve

resolve: any

The resolve function of the internal promise of the wait group

Methods

add

  • Add adds delta, which may be negative, to the WaitGroup counter. If the counter becomes zero or negative, all the wait() will be released. For such cases a result value will be used similar to the done() function call.

    Parameters

    • count: number

      The delta value to increase, or decrease the counter of the WaitGroup

    • Optional result: any

      The result the wait() may return in case the count become 0 or less than zero

    Returns void

done

  • Done one item that the group is waiting for

    Parameters

    • Optional result: any

      The result the wait() may return in case the count become 0 or less than zero

    Returns void

fail

  • Fail the waiting process

    Parameters

    • Optional result: any

      The result the wait() will return with.

    Returns void

wait

  • Wait for the results and return with it

    Returns Promise<any>

Settings

Member Visibility

Theme

Generated using TypeDoc