Skip to content
niso

IDBIndex

Generated from idl/indexeddb.webidl when the site was built at 7aa23e2.

IDBIndex is an interface in idl/indexeddb.webidl, exposed in Window, Worker. What it does is on MDN; this page says what niso has of it.

Status

Section titled “Status”

The web features its members belong to, each with its Baseline status on the web and how much of the feature’s WPT suite passes in niso (see Web platform support).

Feature On the web In niso Members
IndexedDB Widely available Partial 95% 2929 of 3061 subtests pass 13
IndexedDB getAllRecords() Limited availability Full 108 of 108 subtests pass 1

Members

Section titled “Members”

name

Section titled “name”
attribute 
attribute DOMString name;
int32_t niso_idb_index_get_name(niso_dom* dom, niso_handle self, niso_str* out);
int32_t niso_idb_index_set_name(niso_dom* dom, niso_handle self, const char* value, size_t value_len);

objectStore

Section titled “objectStore”
attribute 
[SameObject] readonly attribute IDBObjectStore objectStore;
int32_t niso_idb_index_get_object_store(niso_dom* dom, niso_handle self, niso_handle* out);

keyPath

Section titled “keyPath”
attribute 
[SameObject] readonly attribute any keyPath;
int32_t niso_idb_index_get_key_path(niso_dom* dom, niso_handle self, niso_bytes* out);

[SameObject]: the standard returns the same Array each time.

multiEntry

Section titled “multiEntry”
attribute 
readonly attribute boolean multiEntry;
int32_t niso_idb_index_get_multi_entry(niso_dom* dom, niso_handle self, bool* out);

unique

Section titled “unique”
attribute 
readonly attribute boolean unique;
int32_t niso_idb_index_get_unique(niso_dom* dom, niso_handle self, bool* out);

get()

Section titled “get()”
operation 
[NisoGlue, NewObject] IDBRequest get(any query);

getKey()

Section titled “getKey()”
operation 
[NisoGlue, NewObject] IDBRequest getKey(any query);

getAll()

Section titled “getAll()”
operation 
[NisoGlue, NewObject] IDBRequest getAll(optional any queryOrOptions, optional [EnforceRange] unsigned long count);

getAllKeys()

Section titled “getAllKeys()”
operation 
[NisoGlue, NewObject] IDBRequest getAllKeys(optional any queryOrOptions, optional [EnforceRange] unsigned long count);

getAllRecords()

Section titled “getAllRecords()”
operation IndexedDB getAllRecords(): Full 
[NisoGlue, NewObject] IDBRequest getAllRecords(optional IDBGetAllOptions options = {});

count()

Section titled “count()”
operation 
[NisoGlue, NewObject] IDBRequest count(optional any query);

openCursor()

Section titled “openCursor()”
operation 
[NisoGlue, NewObject] IDBRequest openCursor(optional any query, optional IDBCursorDirection direction = "next");

openKeyCursor()

Section titled “openKeyCursor()”
operation 
[NisoGlue, NewObject] IDBRequest openKeyCursor(optional any query, optional IDBCursorDirection direction = "next");

check()

Section titled “check()”
operation not in JS 
[NisoInternal] undefined check();
int32_t niso_idb_index_check(niso_dom* dom, niso_handle self);

As IDBObjectStore’s: the index and its object store are not deleted and the transaction is active.

query()

Section titled “query()”
operation not in JS 
[NisoInternal] IDBRequest query(unsigned short operation, any range, unsigned long count, unsigned short direction);
int32_t niso_idb_index_query(niso_dom* dom, niso_handle self, uint16_t operation, const uint8_t* range, size_t range_len, uint32_t count, uint16_t direction, niso_handle* out);

As IDBObjectStore’s, without delete (6).

Not in niso yet

Section titled “Not in niso yet”

Members the web has, by the BCD keys web-features 3.45.0 lists, that idl/ doesn’t declare. The list is partial: web-features lists only the keys it maps to a feature.

  • worker_support (IndexedDB)