org.stjs.bridge.rsvp

Class RSVP

java.lang.Object

org.stjs.bridge.rsvp.RSVP

public class RSVP
extends Object

Constructor Summary

Constructors

Constructor and Description
RSVP()

Method Summary

Methods

Modifier and Type	Method and Description
static <Result,FailResponse> Promise<org.stjs.javascript.Array<Result>,FailResponse>	all(org.stjs.javascript.Array<Promise<Result,FailResponse>> promises) Sometimes you might want to work with many promises at once.
static <Result,FailResponse> Promise<org.stjs.javascript.Array<SettleResult<Result,FailResponse>>,Void>	allSettled(org.stjs.javascript.Array<Promise<Result,FailResponse>> promises) Creates a new Promise that is fulfilled when all of the specified promises are either fulfilled or rejected.
static Object	configure(String optionName) Reads the value of an option of RSVP
static void	configure(String optionName, Object value) Configures an option of RSVP.
static <Result,FailResponse> Deferred<Result,FailResponse>	defer() Sometimes one needs to create a deferred object, without immediately specifying how it will be resolved.
static <FailResponse> Promise<org.stjs.javascript.Map<String,Object>,FailResponse>	hash(org.stjs.javascript.Map<String,Promise<Object,FailResponse>> promises) If you need to reference many promises at once (like all()), but would like to avoid encoding the actual promise order you can use hash().
static <Result,FailResponse> Promise<org.stjs.javascript.Map<String,SettleResult<Result,FailResponse>>,Void>	hashSettled(org.stjs.javascript.Map<String,Promise<Result,FailResponse>> promises) Creates a new Promise that is fulfilled when all of the specified promises are either fulfilled or rejected.
static void	on(String eventType, org.stjs.javascript.functions.Callback1<PromiseEvent> callback1) Add a global listener for all promises on a specific type of event.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RSVP

public RSVP()

Method Detail

defer

public static <Result,FailResponse> Deferred<Result,FailResponse> defer()

Sometimes one needs to create a deferred object, without immediately specifying how it will be resolved. These deferred objects are essentially a wrapper around a promise, whilst providing late access to the resolve() and reject() methods.

 Deferred<String, Error> deferred = RSVP.defer();
 // ...
 deferred.promise // access the promise
 // ...
 deferred.resolve("Hello");
 

The RSVP.Promise constructor is generally a better, less error-prone choice than RSVP.defer(). Promises are recommended unless the specific properties of deferred are needed.

all

public static <Result,FailResponse> Promise<org.stjs.javascript.Array<Result>,FailResponse> all(org.stjs.javascript.Array<Promise<Result,FailResponse>> promises)

Sometimes you might want to work with many promises at once. If you pass an array of promises to the all() method it will return a new promise that will be fulfilled when all of the promises in the array have been fulfilled; or rejected immediately if any promise in the array is rejected.

 Array> promises = $array(2, 3, 5, 7, 11, 13).map(id -> {
   return getJSON("/post/" + id + ".json");
 });

 RSVP.all(promises).then(posts -> {
     // posts contains an array of results for the given promises
   },
   error -> {
     // if any of the promises fails.
   }
 );
 

hash

public static <FailResponse> Promise<org.stjs.javascript.Map<String,Object>,FailResponse> hash(org.stjs.javascript.Map<String,Promise<Object,FailResponse>> promises)

If you need to reference many promises at once (like all()), but would like to avoid encoding the actual promise order you can use hash(). The hash() method will return a new promise that will be fulfilled when all of the promises have been fulfilled; or rejected immediately if any promise is rejected.

The key difference to the all() function is that both the fulfillment value and the argument to the hash() function are object literals (ie: org.stjs.Map). This allows you to simply reference the results directly off the returned object without having to remember the initial order like you would with all().

 Map> promises = $map (
   "posts", getJSON("/posts.json"),
   "users", getJSON("/users.json")
 );

 RSVP.hash(promises).then(results -> {
   console.log(results.$get("users")); // print the users.json results
   console.log(results.$get("posts")); // print the posts.json results
 });
 

allSettled

public static <Result,FailResponse> Promise<org.stjs.javascript.Array<SettleResult<Result,FailResponse>>,Void> allSettled(org.stjs.javascript.Array<Promise<Result,FailResponse>> promises)

Creates a new Promise that is fulfilled when all of the specified promises are either fulfilled or rejected. The returned promise is never rejected. The returned promise fulfills with an Array of the constituent promises' result states. Each state object (ie: SettleResult) will either indicate fulfillment or rejection, and provide the corresponding value or reason.

hashSettled

public static <Result,FailResponse> Promise<org.stjs.javascript.Map<String,SettleResult<Result,FailResponse>>,Void> hashSettled(org.stjs.javascript.Map<String,Promise<Result,FailResponse>> promises)

Creates a new Promise that is fulfilled when all of the specified promises are either fulfilled or rejected. The returned promise is never rejected. The returned promise fulfills with a Map of the constituent promises' result states. Each state object (ie: SettleResult) will either indicate fulfillment or rejection, and provide the corresponding value or reason.

on

public static void on(String eventType,
      org.stjs.javascript.functions.Callback1<PromiseEvent> callback1)

Add a global listener for all promises on a specific type of event. The valid event types are ['created', 'chained', 'fulfilled', 'rejected']

Events are only triggered when RSVP.configure('instrument') is true, although listeners can be registered at any time.

Parameters:

eventType - one of ['created', 'chained', 'fulfilled', 'rejected']

callback1 - a callback that is called whenever the specified event is triggered on any promise

configure

public static void configure(String optionName,
             Object value)

Configures an option of RSVP.

 RSVP.configure('instrument', true | false);
 // capturing the stacks is slow, so you also have to opt in
 RSVP.configure('instrument-with-stack', true | false);
 

Parameters:

optionName - the name of the option to configure

value - the value of the option

configure

public static Object configure(String optionName)

Reads the value of an option of RSVP

Parameters:

optionName - the option to read

Returns:

the value of the option