gecko-dev/dom/webidl/ExtensionMockAPI.webidl

56 lines
1.9 KiB
Plaintext

/* 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/.
*
* You are granted a license to use, reproduce and create derivative works of
* this document.
*
* This IDL file is related to the WebExtensions API object only used in
* unit tests.
*
* More info about generating webidl API bindings for WebExtensions API at:
*
* https://firefox-source-docs.mozilla.org/toolkit/components/extensions/webextensions/webidl_bindings.html
*
* A short summary of the special setup used by these WebIDL files (meant to aid
* webidl peers reviews and sign-offs) is available in the following section:
*
* https://firefox-source-docs.mozilla.org/toolkit/components/extensions/webextensions/webidl_bindings.html#review-process-on-changes-to-webidl-definitions
*/
// WebIDL definition for the "mockExtensionAPI" WebExtensions API,
// only available in tests and locked behind an about:config preference
// ("extensions.webidl-api.expose_mock_interface").
[Exposed=(ServiceWorker), LegacyNoInterfaceObject]
interface ExtensionMockAPI {
// Test API methods scenarios.
[Throws, WebExtensionStub]
any methodSyncWithReturn(any... args);
[Throws, WebExtensionStub="NoReturn"]
undefined methodNoReturn(any... args);
[Throws, WebExtensionStub="Async"]
any methodAsync(any arg0, optional Function cb);
[Throws, WebExtensionStub="AsyncAmbiguous"]
any methodAmbiguousArgsAsync(any... args);
[Throws, WebExtensionStub="ReturnsPort"]
ExtensionPort methodReturnsPort(DOMString testName);
// Test API properties.
[Replaceable]
readonly attribute any propertyAsErrorObject;
[Replaceable]
readonly attribute DOMString propertyAsString;
// Test API events.
[Replaceable, SameObject]
readonly attribute ExtensionEventManager onTestEvent;
};