summaryrefslogtreecommitdiffstats
path: root/dom/webidl/StreamFilterDataEvent.webidl
blob: 63ee1bcdbed22906a2496e3b98b3caca217c7b2b (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
/* -*- 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/. */

/**
 * This is a Mozilla-specific WebExtension API, which is not available to web
 * content. It allows monitoring and filtering of HTTP response stream data.
 *
 * This API should currently be considered experimental, and is not defined by
 * any standard.
 */

[Func="mozilla::extensions::StreamFilter::IsAllowedInContext",
 Exposed=Window]
interface StreamFilterDataEvent : Event {
  constructor(DOMString type,
              optional StreamFilterDataEventInit eventInitDict = {});

  /**
   * Contains a chunk of data read from the input stream.
   */
  [Pure]
  readonly attribute ArrayBuffer data;
};

dictionary StreamFilterDataEventInit : EventInit {
  required ArrayBuffer data;
};