gecko/dom/webidl/Promise.webidl

/* -*- 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 (optional 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.
  [Creator, Throws, Func="mozilla::dom::Promise::EnabledForScope"]
  static Promise resolve(any value); // same as any(value)
  [Creator, Throws, Func="mozilla::dom::Promise::EnabledForScope"]
  static Promise reject(any value);

  [Creator]
  Promise then([TreatUndefinedAs=Missing] optional AnyCallback fulfillCallback,
               [TreatUndefinedAs=Missing] optional AnyCallback rejectCallback);

  [Creator]
  Promise catch([TreatUndefinedAs=Missing] optional AnyCallback rejectCallback);
};