dom/webidl/Promise.webidl
author Gregory Szorc <gps@mozilla.com>
Fri, 22 Apr 2016 12:51:23 -0700
changeset 294591 d6ea7c8e2449d9b34882650490383ee86b8bb164
parent 291004 69a7e03cf1f8ee309ab4bf38d1761693a30191d2
child 325892 918e37b44bddf0ab04f59887a1bb753aa586b3d9
permissions -rw-r--r--
Bug 1259782 - Build with Visual Studio 2015 Update 2; r=ted Should be a drop-in replacement for VS2015u1. MozReview-Commit-ID: HSmdikYPR0j

/* -*- 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 PromiseJobCallback = void();

[TreatNonCallableAsNull]
callback AnyCallback = any (any value);

// When using SpiderMonkey promises, we don't want to define all this stuff;
// just define a tiny interface to make codegen of Promise arguments and return
// values work.
#ifndef SPIDERMONKEY_PROMISE
[Constructor(PromiseInit init),
 Exposed=(Window,Worker,WorkerDebugger,System)]
// Need to escape "Promise" so it's treated as an identifier.
interface _Promise {
  // Have to use "any" (or "object", but "any" is simpler) as the type to
  // support the subclassing behavior, since nothing actually requires the
  // return value of PromiseSubclass.resolve/reject to be a Promise object.
  [NewObject, Throws]
  static any resolve(optional any value);
  [NewObject, Throws]
  static any reject(optional any value);

  // The [TreatNonCallableAsNull] annotation is required since then() should do
  // nothing instead of throwing errors when non-callable arguments are passed.
  // Have to use "any" (or "object", but "any" is simpler) as the type to
  // support the subclassing behavior, since nothing actually requires the
  // return value of PromiseSubclass.then/catch to be a Promise object.
  [NewObject, Throws]
  any then([TreatNonCallableAsNull] optional AnyCallback? fulfillCallback = null,
           [TreatNonCallableAsNull] optional AnyCallback? rejectCallback = null);

  [NewObject, Throws]
  any catch([TreatNonCallableAsNull] optional AnyCallback? rejectCallback = null);

  // Have to use "any" (or "object", but "any" is simpler) as the type to
  // support the subclassing behavior, since nothing actually requires the
  // return value of PromiseSubclass.all to be a Promise object.  As a result,
  // we also have to do our argument conversion manually, because we want to
  // convert its exceptions into rejections.
  [NewObject, Throws]
  static any all(optional any iterable);

  // Have to use "any" (or "object", but "any" is simpler) as the type to
  // support the subclassing behavior, since nothing actually requires the
  // return value of PromiseSubclass.race to be a Promise object.  As a result,
  // we also have to do our argument conversion manually, because we want to
  // convert its exceptions into rejections.
  [NewObject, Throws]
  static any race(optional any iterable);
};
#else // SPIDERMONKEY_PROMISE
[NoInterfaceObject,
 Exposed=(Window,Worker,WorkerDebugger,System)]
// Need to escape "Promise" so it's treated as an identifier.
interface _Promise {
};

// Hack to allow us to have JS owning and properly tracing/CCing/etc a
// PromiseNativeHandler.
[NoInterfaceObject,
 Exposed=(Window,Worker,System)]
interface PromiseNativeHandler {
};
#endif // SPIDERMONKEY_PROMISE