gecko/dom/webidl/Promise.webidl
Nikhil Marathe 7b139fafd1 Bug 939332 - Implement Promise.all, Promise.cast, Promise.race. r=bz
--HG--
extra : rebase_source : 72c1a87a6352005765442ea8903cfa16da8608fd
extra : amend_source : 71b6af7c8446cd501bc337d50a345f24814f20db
2013-11-19 13:53:00 -08:00

46 lines
1.9 KiB
Plaintext

/* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this file,
* You can obtain one at http://mozilla.org/MPL/2.0/.
*
* The origin of this IDL file is
* http://dom.spec.whatwg.org/#promises
*/
// TODO We use object instead Function. There is an open issue on WebIDL to
// have different types for "platform-provided function" and "user-provided
// function"; for now, we just use "object".
callback PromiseInit = void (object resolve, object reject);
callback AnyCallback = any (any value);
[Func="mozilla::dom::Promise::EnabledForScope", Constructor(PromiseInit init)]
interface Promise {
// TODO bug 875289 - static Promise fulfill(any value);
// Disable the static methods when the interface object is supposed to be
// disabled, just in case some code decides to walk over to .constructor from
// the proto of a promise object or someone screws up and manages to create a
// Promise object in this scope without having resolved the interface object
// first.
[NewObject, Throws, Func="mozilla::dom::Promise::EnabledForScope"]
static Promise resolve(optional any value);
[NewObject, Throws, Func="mozilla::dom::Promise::EnabledForScope"]
static Promise reject(optional any value);
[NewObject]
Promise then(optional AnyCallback? fulfillCallback,
optional AnyCallback? rejectCallback);
[NewObject]
Promise catch(optional AnyCallback? rejectCallback);
[NewObject, Throws, Func="mozilla::dom::Promise::EnabledForScope"]
static Promise all(sequence<any> iterable);
[NewObject, Throws, Func="mozilla::dom::Promise::EnabledForScope"]
static Promise cast(optional any value);
[NewObject, Throws, Func="mozilla::dom::Promise::EnabledForScope"]
static Promise race(sequence<any> iterable);
};