diff options
Diffstat (limited to '')
-rw-r--r-- | dom/chrome-webidl/StructuredCloneHolder.webidl | 32 |
1 files changed, 32 insertions, 0 deletions
diff --git a/dom/chrome-webidl/StructuredCloneHolder.webidl b/dom/chrome-webidl/StructuredCloneHolder.webidl new file mode 100644 index 0000000000..235464a059 --- /dev/null +++ b/dom/chrome-webidl/StructuredCloneHolder.webidl @@ -0,0 +1,32 @@ +/* -*- 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); +}; |