Class EachPromise
- GuzzleHttp\Promise\EachPromise implements GuzzleHttp\Promise\PromisorInterface
- Namespace: GuzzleHttp\Promise
- Located at EachPromise.php
Represents a promise that iterates over many promises and invokes side-effect functions in the process.
Methods Summary
-
__construct ( mixed $iterable, array $config = [] )
Configuration hash can include the following key value pairs:
- promise ( )
Methods Details
__construct ( mixed $iterable, array $config = [] )
Configuration hash can include the following key value pairs:
- fulfilled: (callable) Invoked when a promise fulfills. The function is invoked with three arguments: the fulfillment value, the index position from the iterable list of the promise, and the aggregate promise that manages all of the promises. The aggregate promise may be resolved from within the callback to short-circuit the promise.
- rejected: (callable) Invoked when a promise is rejected. The function is invoked with three arguments: the rejection reason, the index position from the iterable list of the promise, and the aggregate promise that manages all of the promises. The aggregate promise may be resolved from within the callback to short-circuit the promise.
- concurrency: (integer) Pass this configuration option to limit the allowed number of outstanding concurrently executing promises, creating a capped pool of promises. There is no limit by default.
Parameters
mixed | $iterable | Promises or values to iterate. |
array | $config = [] | Configuration options |
GuzzleHttp\Promise\PromiseInterface
promise (
)
Returns
GuzzleHttp\Promise\PromiseInterface |
Psalm-suppress
InvalidNullableReturnType