summaryrefslogtreecommitdiff
path: root/dom/webidl/Promise.webidl
blob: 4dcb7d43e7eba3cf78bf45642255734df63c34e9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
/* -*- 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