node-core-library.iasyncparallelismoptions.md

hide_title	true
custom_edit_url
pagination_prev
pagination_next

Home > @rushstack/node-core-library > IAsyncParallelismOptions

IAsyncParallelismOptions interface

Options for controlling the parallelism of asynchronous operations.

Signature:

export interface IAsyncParallelismOptions 

Remarks

Used with Async.mapAsync()<></>, Async.mapAsync() and Async.forEachAsync()<></>, and Async.forEachAsync()<></>.

Properties

Property	Modifiers	Type	Description
allowOversubscription?		boolean	(Optional) This option affects the handling of task weights, applying a softer policy that favors maximizing parallelism instead of avoiding overload.
concurrency?		number	(Optional) Optionally used with the Async.mapAsync()<></>, Async.mapAsync() and Async.forEachAsync()<></>, and Async.forEachAsync() to limit the maximum number of concurrent promises to the specified number.
weighted?		boolean	(Optional) Optionally used with the Async.forEachAsync() to enable weighted operations where an operation can take up more or less than one concurrency unit.