summaryrefslogtreecommitdiffstats
path: root/dom/webidl/IDBObjectStore.webidl
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-19 00:47:55 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-19 00:47:55 +0000
commit26a029d407be480d791972afb5975cf62c9360a6 (patch)
treef435a8308119effd964b339f76abb83a57c29483 /dom/webidl/IDBObjectStore.webidl
parentInitial commit. (diff)
downloadfirefox-26a029d407be480d791972afb5975cf62c9360a6.tar.xz
firefox-26a029d407be480d791972afb5975cf62c9360a6.zip
Adding upstream version 124.0.1.upstream/124.0.1
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'dom/webidl/IDBObjectStore.webidl')
-rw-r--r--dom/webidl/IDBObjectStore.webidl67
1 files changed, 67 insertions, 0 deletions
diff --git a/dom/webidl/IDBObjectStore.webidl b/dom/webidl/IDBObjectStore.webidl
new file mode 100644
index 0000000000..fc19ab99e6
--- /dev/null
+++ b/dom/webidl/IDBObjectStore.webidl
@@ -0,0 +1,67 @@
+/* -*- 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/#object-store-interface
+ */
+
+dictionary IDBObjectStoreParameters {
+ (DOMString or sequence<DOMString>)? keyPath = null;
+ boolean autoIncrement = false;
+};
+
+[Exposed=(Window,Worker)]
+interface IDBObjectStore {
+ [SetterThrows]
+ attribute DOMString name;
+
+ [Throws]
+ readonly attribute any keyPath;
+
+ readonly attribute DOMStringList indexNames;
+ [SameObject] readonly attribute IDBTransaction transaction;
+ readonly attribute boolean autoIncrement;
+
+ [NewObject, Throws]
+ IDBRequest put (any value, optional any key);
+ [NewObject, Throws]
+ IDBRequest add (any value, optional any key);
+ [NewObject, Throws]
+ IDBRequest delete (any key);
+ [NewObject, Throws]
+ IDBRequest clear ();
+ [NewObject, Throws]
+ IDBRequest get (any key);
+ [NewObject, Throws]
+ IDBRequest getKey (any key);
+
+ // Success fires IDBTransactionEvent, result == array of values for given keys
+ // If we decide to add use a counter for the mozGetAll function, we'll need
+ // to pull it out into a sepatate operation with a BinaryName mapping to the
+ // same underlying implementation.
+ [NewObject, Throws, Alias="mozGetAll"]
+ IDBRequest getAll(optional any query,
+ optional [EnforceRange] unsigned long count);
+ [NewObject, Throws]
+ IDBRequest getAllKeys(optional any query,
+ optional [EnforceRange] unsigned long count);
+
+ [NewObject, Throws]
+ IDBRequest count(optional any key);
+
+ [NewObject, Throws]
+ IDBRequest openCursor (optional any range, optional IDBCursorDirection direction = "next");
+ [NewObject, Throws]
+ IDBRequest openKeyCursor(optional any query,
+ optional IDBCursorDirection direction = "next");
+ [NewObject, Throws]
+ IDBIndex createIndex (DOMString name, (DOMString or sequence<DOMString>) keyPath, optional IDBIndexParameters optionalParameters = {});
+
+ [Throws]
+ IDBIndex index (DOMString name);
+
+ [Throws]
+ undefined deleteIndex (DOMString indexName);
+};