dom/chrome-webidl/StructuredCloneHolder.webidl
author Kris Maglione <maglione.k@gmail.com>
Tue, 22 Jan 2019 13:01:22 -0800
changeset 512496 005a8fce14e71875a1e784d7adf3ec73fe5e694b
parent 499115 fbfcfc27ab30434eaac667cbbf9d33ded0abb571
child 554252 a45f6822bd1f0a67eef0ea6aa40be71468bd1f7a
permissions -rw-r--r--
Bug 1476032: Neuter StructuredCloneHolder objects after deserializing. r=aswan Differential Revision: https://phabricator.services.mozilla.com/D17287

/* -*- 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/.
 */

/**
 * A holder for structured-clonable data which can itself be cloned with
 * little overhead, and deserialized into an arbitrary global.
 */
[ChromeOnly, Exposed=(Window,Worker),
 /**
  * Serializes the given value to an opaque structured clone blob, and
  * returns the result.
  *
  * The serialization happens in the compartment of the given global or, if no
  * global is provided, the compartment of the data value.
  */
 Constructor(any data, optional object? global = null)]
interface StructuredCloneHolder {
  /**
   * Deserializes the structured clone data in the scope of the given global,
   * and returns the result.
   *
   * If `keepData` is true, the structured clone data is preserved, and can be
   * deserialized repeatedly. Otherwise, it is immediately discarded.
   */
  [Throws]
  any deserialize(object global, optional boolean keepData = false);
};