dom/webidl/TextDecoder.webidl

   1 /* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* This Source Code Form is subject to the terms of the Mozilla Public
   3  * License, v. 2.0. If a copy of the MPL was not distributed with this file,
   4  * You can obtain one at http://mozilla.org/MPL/2.0/.
   5  *
   6  * The origin of this IDL file is
   7  * http://encoding.spec.whatwg.org/#interface-textdecoder
   8  */
   9
  10 interface mixin TextDecoderCommon {
  11   [Constant]
  12   readonly attribute DOMString encoding;
  13   [Constant]
  14   readonly attribute boolean fatal;
  15   [Constant]
  16   readonly attribute boolean ignoreBOM;
  17 };
  18
  19 [Exposed=(Window,Worker)]
  20 interface TextDecoder {
  21   [Throws]
  22   constructor(optional DOMString label = "utf-8",
  23               optional TextDecoderOptions options = {});
  24
  25   [Throws]
  26   USVString decode(optional BufferSource input, optional TextDecodeOptions options = {});
  27 };
  28 TextDecoder includes TextDecoderCommon;
  29
  30 dictionary TextDecoderOptions {
  31   boolean fatal = false;
  32   boolean ignoreBOM = false;
  33 };
  34
  35 dictionary TextDecodeOptions {
  36   boolean stream = false;
  37 };