dom/chrome-webidl/StructuredCloneHolder.webidl
author Mozilla Releng Treescript <release+treescript@mozilla.org>
Fri, 18 Oct 2019 14:30:13 +0000
changeset 559297 57902726ad176eae5894ab1093207faf0ef7d41f
parent 554252 a45f6822bd1f0a67eef0ea6aa40be71468bd1f7a
permissions -rw-r--r--
Automatic version bump CLOSED TREE NO BUG a=release DONTBUILD

/* -*- 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)]
interface StructuredCloneHolder {
  /**
   * 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.
   */
  [Throws]
  constructor(any data, optional object? global = null);

  /**
   * 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);
};