RejectedPromise.md

---

RejectedPromise

A promise that has been rejected.

Thenning off of this promise will invoke the onRejected callback immediately and ignore other callbacks.

• Full name: \GuzzleHttp\Promise\RejectedPromise
• This class implements: \GuzzleHttp\Promise\PromiseInterface

Properties

reason

private $reason

---

Methods

__construct

public __construct(mixed $reason): mixed

Parameters:

Parameter	Type	Description
$reason	mixed

---

then

Appends fulfillment and rejection handlers to the promise, and returns a new promise resolving to the return value of the called handler.

public then(callable $onFulfilled = null, callable $onRejected = null): \GuzzleHttp\Promise\PromiseInterface

Parameters:

Parameter	Type	Description
$onFulfilled	callable	Invoked when the promise fulfills.
$onRejected	callable	Invoked when the promise is rejected.

---

otherwise

Appends a rejection handler callback to the promise, and returns a new promise resolving to the return value of the callback if it is called, or to its original fulfillment value if the promise is instead fulfilled.

public otherwise(callable $onRejected): \GuzzleHttp\Promise\PromiseInterface

Parameters:

Parameter	Type	Description
$onRejected	callable	Invoked when the promise is rejected.

---

wait

Waits until the promise completes if possible.

public wait(mixed $unwrap = true, mixed $defaultDelivery = null): mixed

Pass $unwrap as true to unwrap the result of the promise, either returning the resolved value or throwing the rejected exception.

If the promise cannot be waited on, then the promise will be rejected.

Parameters:

Parameter	Type	Description
$unwrap	mixed
$defaultDelivery	mixed

---

getState

Get the state of the promise ("pending", "rejected", or "fulfilled").

public getState(): string

The three states can be checked against the constants defined on PromiseInterface: PENDING, FULFILLED, and REJECTED.

---

resolve

Resolve the promise with the given value.

public resolve(mixed $value): mixed

Parameters:

Parameter	Type	Description
$value	mixed

---

reject

Reject the promise with the given reason.

public reject(mixed $reason): mixed

Parameters:

Parameter	Type	Description
$reason	mixed

---

cancel

Cancels the promise if possible.

public cancel(): mixed

---

---