Each
in package
Table of Contents
- of() : PromiseInterface
- Given an iterator that yields promises or values, returns a promise that is fulfilled with a null value when the iterator has been consumed or the aggregate promise has been fulfilled or rejected.
- ofLimit() : PromiseInterface
- Like of, but only allows a certain number of outstanding promises at any given time.
- ofLimitAll() : PromiseInterface
- Like limit, but ensures that no promise in the given $iterable argument is rejected. If any promise is rejected, then the aggregate promise is rejected with the encountered rejection.
Methods
of()
Given an iterator that yields promises or values, returns a promise that is fulfilled with a null value when the iterator has been consumed or the aggregate promise has been fulfilled or rejected.
public
static of(mixed $iterable[, callable $onFulfilled = null ][, callable $onRejected = null ]) : PromiseInterface
$onFulfilled is a function that accepts the fulfilled value, iterator index, and the aggregate promise. The callback can invoke any necessary side effects and choose to resolve or reject the aggregate if needed.
$onRejected is a function that accepts the rejection reason, iterator index, and the aggregate promise. The callback can invoke any necessary side effects and choose to resolve or reject the aggregate if needed.
Parameters
- $iterable : mixed
-
Iterator or array to iterate over.
- $onFulfilled : callable = null
- $onRejected : callable = null
Return values
PromiseInterface —ofLimit()
Like of, but only allows a certain number of outstanding promises at any given time.
public
static ofLimit(mixed $iterable, int|callable $concurrency[, callable $onFulfilled = null ][, callable $onRejected = null ]) : PromiseInterface
$concurrency may be an integer or a function that accepts the number of pending promises and returns a numeric concurrency limit value to allow for dynamic a concurrency size.
Parameters
- $iterable : mixed
- $concurrency : int|callable
- $onFulfilled : callable = null
- $onRejected : callable = null
Return values
PromiseInterface —ofLimitAll()
Like limit, but ensures that no promise in the given $iterable argument is rejected. If any promise is rejected, then the aggregate promise is rejected with the encountered rejection.
public
static ofLimitAll(mixed $iterable, int|callable $concurrency[, callable $onFulfilled = null ]) : PromiseInterface
Parameters
- $iterable : mixed
- $concurrency : int|callable
- $onFulfilled : callable = null