amp/docs/promises/miscellaneous.md

---
layout: docs
title: Promise Helpers
permalink: /promises/miscellaneous
---
Amp offers some small promise helpers, namely
 * `Amp\Promise\rethrow()`
 * `Amp\Promise\timeout()`
 * `Amp\Promise\wait()`

## `rethrow()`

`rethrow(Amp\Promise|React\Promise\PromiseInterface): void` subscribes to the passed `Promise` and forwards all errors to the event loop. That handler can log these failures or the event loop will stop if no such handler exists.

`rethrow()` is useful whenever you want to fire and forget, but still care about any errors that happen.

## `timeout()`

`timeout(Amp\Promise|React\Promise\PromiseInterface, int $timeout): Amp\Promise` applies a timeout to the passed promise, either resolving with the original value or error reason in case the promise resolves within the timeout period, or otherwise fails the returned promise with an `Amp\TimeoutException`.

Note that `timeout()` does not cancel any operation or frees any resources. If available, use dedicated API options instead, e.g. for socket connect timeouts.

## `wait()`

`wait(Amp\Promise|React\Promise\PromiseInterface): mixed` can be used to synchronously wait for a promise to resolve. It returns the result value or throws an exception in case of an error. `wait()` blocks and calls `Loop::run()` internally. It SHOULD NOT be used in fully asynchronous applications, but only when integrating async APIs into an otherwise synchronous application.
Allow ./docs to be published as Jekyll page 2017-05-26 19:56:02 +02:00			`---`
			`layout: docs`
Fix page titles to allow a menu 2017-05-26 21:13:34 +02:00			`title: Promise Helpers`
Allow ./docs to be published as Jekyll page 2017-05-26 19:56:02 +02:00			`permalink: /promises/miscellaneous`
			`---`
:memo: Add wait, rethrow and timeout docs, fixes #104 2017-05-02 17:54:10 +02:00			`Amp offers some small promise helpers, namely`
			* `Amp\Promise\rethrow()`
			* `Amp\Promise\timeout()`
			* `Amp\Promise\wait()`

			## `rethrow()`

Improve promise helper docs 2017-12-20 12:47:47 +01:00			`rethrow(Amp\Promise\|React\Promise\PromiseInterface): void` subscribes to the passed `Promise` and forwards all errors to the event loop. That handler can log these failures or the event loop will stop if no such handler exists.
:memo: Add wait, rethrow and timeout docs, fixes #104 2017-05-02 17:54:10 +02:00
			`rethrow()` is useful whenever you want to fire and forget, but still care about any errors that happen.

			## `timeout()`

Improve promise helper docs 2017-12-20 12:47:47 +01:00			`timeout(Amp\Promise\|React\Promise\PromiseInterface, int $timeout): Amp\Promise` applies a timeout to the passed promise, either resolving with the original value or error reason in case the promise resolves within the timeout period, or otherwise fails the returned promise with an `Amp\TimeoutException`.
:memo: Add wait, rethrow and timeout docs, fixes #104 2017-05-02 17:54:10 +02:00
			Note that `timeout()` does not cancel any operation or frees any resources. If available, use dedicated API options instead, e.g. for socket connect timeouts.

			## `wait()`

Improve promise helper docs 2017-12-20 12:47:47 +01:00			`wait(Amp\Promise\|React\Promise\PromiseInterface): mixed` can be used to synchronously wait for a promise to resolve. It returns the result value or throws an exception in case of an error. `wait()` blocks and calls `Loop::run()` internally. It SHOULD NOT be used in fully asynchronous applications, but only when integrating async APIs into an otherwise synchronous application.