interfaces.Deferrable

A class that is should have a #ready Promise that resolves to a truthy/falsey value.
Implements:
See:

Classes

Deferrable
interfaces.Deferrable.Deferrable

Members

ready :Deferrable~_ExternallyResolvablePromise.<(bool|interfaces.Deferrable|*)>

A promise that resolves to a value that can be interpreted to specify the ready state of this Deferrable object. Convention is true/false or this.

Methods

static delay() → {Promise.<(bool|interfaces.Deferrable|*)>}

Resets the interfaces.Deferrable#ready Promise, regardless of the previous value. This promise will have a resolve and reject function so that the promise resolution can be delayed outside of the callback function.
Returns:
Promise.<(bool|interfaces.Deferrable|*)> - A promise that resolves to anything. Convention is true/false or this.

static time_logged_retry() → {Promise.<(bool|interfaces.Deferrable|*)>}

A decorator which retries a function on failure up to a set maximum, but times each retry attempt. This timing leads to slight compute overhead.
Returns:
Promise.<(bool|interfaces.Deferrable|*)> - A promise that resolves to anything. Convention is true/false or this.

defer() → {Deferrable~_ExternallyResolvablePromise.<(bool|interfaces.Deferrable|*)>}

Resets the interfaces.Deferrable#ready Promise, regardless of the previous value. This promise will have a resolve and reject function so that the promise resolution can be delayed outside of the callback function.
Returns:
Deferrable~_ExternallyResolvablePromise.<(bool|interfaces.Deferrable|*)> - A promise that resolves to anything. Convention is true/false or this.