diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-19 01:47:29 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-19 01:47:29 +0000 |
commit | 0ebf5bdf043a27fd3dfb7f92e0cb63d88954c44d (patch) | |
tree | a31f07c9bcca9d56ce61e9a1ffd30ef350d513aa /dom/webidl/IDBIndex.webidl | |
parent | Initial commit. (diff) | |
download | firefox-esr-0ebf5bdf043a27fd3dfb7f92e0cb63d88954c44d.tar.xz firefox-esr-0ebf5bdf043a27fd3dfb7f92e0cb63d88954c44d.zip |
Adding upstream version 115.8.0esr.upstream/115.8.0esr
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'dom/webidl/IDBIndex.webidl')
-rw-r--r-- | dom/webidl/IDBIndex.webidl | 63 |
1 files changed, 63 insertions, 0 deletions
diff --git a/dom/webidl/IDBIndex.webidl b/dom/webidl/IDBIndex.webidl new file mode 100644 index 0000000000..92b9842c20 --- /dev/null +++ b/dom/webidl/IDBIndex.webidl @@ -0,0 +1,63 @@ +/* -*- 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/. + * + * The origin of this IDL file is + * https://w3c.github.io/IndexedDB/#index-interface + */ + +dictionary IDBIndexParameters { + boolean unique = false; + boolean multiEntry = false; + // <null>: Not locale-aware, uses normal JS sorting. + // <string>: Always sorted based on the rules of the specified + // locale (e.g. "en-US", etc.). + // "auto": Sorted by the platform default, may change based on + // user agent options. + DOMString? locale = null; +}; + +[Exposed=(Window,Worker)] +interface IDBIndex { + [SetterThrows] attribute DOMString name; + [SameObject] readonly attribute IDBObjectStore objectStore; + + [Throws] + readonly attribute any keyPath; + + readonly attribute boolean multiEntry; + readonly attribute boolean unique; + + // <null>: Not locale-aware, uses normal JS sorting. + // <string>: Sorted based on the rules of the specified locale. + // Note: never returns "auto", only the current locale. + [Pref="dom.indexedDB.experimental"] + readonly attribute DOMString? locale; + + [Pref="dom.indexedDB.experimental"] + readonly attribute boolean isAutoLocale; + + [NewObject, Throws] IDBRequest get(any query); + [NewObject, Throws] IDBRequest getKey(any query); + + // If we decide to add use counters for the mozGetAll/mozGetAllKeys + // functions, we'll need to pull them out into sepatate operations + // with a BinaryName mapping to the same underlying implementation. + // See also bug 1577227. + [NewObject, Throws, Alias="mozGetAll"] + IDBRequest getAll(optional any query, + optional [EnforceRange] unsigned long count); + [NewObject, Throws, Alias="mozGetAllKeys"] + IDBRequest getAllKeys(optional any query, + optional [EnforceRange] unsigned long count); + + [NewObject, Throws] IDBRequest count(optional any query); + + [NewObject, Throws] + IDBRequest openCursor(optional any query, + optional IDBCursorDirection direction = "next"); + [NewObject, Throws] + IDBRequest openKeyCursor(optional any query, + optional IDBCursorDirection direction = "next"); +}; |