Skip to content

IDBCursor

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

IDBCursor 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.

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 11
attribute
readonly attribute object source;
int32_t niso_idb_cursor_get_source(niso_dom* dom, niso_handle self, niso_handle* out);

The standard’s type is (IDBObjectStore or IDBIndex).

attribute
readonly attribute IDBCursorDirection direction;
int32_t niso_idb_cursor_get_direction(niso_dom* dom, niso_handle self, niso_str* out);
attribute
[NisoGlue] readonly attribute any key;
attribute
[NisoGlue] readonly attribute any primaryKey;
attribute
[SameObject] readonly attribute IDBRequest request;
int32_t niso_idb_cursor_get_request(niso_dom* dom, niso_handle self, niso_handle* out);
operation
undefined advance([EnforceRange] unsigned long count);
int32_t niso_idb_cursor_advance(niso_dom* dom, niso_handle self, uint32_t count);
operation
[NisoGlue] undefined continue(optional any key);
operation
[NisoGlue] undefined continuePrimaryKey(any key, any primaryKey);
operation
[NisoGlue, NewObject] IDBRequest update(any value);
operation
[NewObject] IDBRequest delete();
int32_t niso_idb_cursor_delete(niso_dom* dom, niso_handle self, niso_handle* out);
operation not in JS
[NisoInternal] unsigned long generation();
int32_t niso_idb_cursor_generation(niso_dom* dom, niso_handle self, uint32_t* out);

How many times the cursor’s key and value changed, and them.

operation not in JS
[NisoInternal] any currentKey();
int32_t niso_idb_cursor_current_key(niso_dom* dom, niso_handle self, niso_bytes* out);
operation not in JS
[NisoInternal] any currentPrimaryKey();
int32_t niso_idb_cursor_current_primary_key(niso_dom* dom, niso_handle self, niso_bytes* out);
operation not in JS
[NisoInternal] any currentValue();
int32_t niso_idb_cursor_current_value(niso_dom* dom, niso_handle self, niso_bytes* out);
operation not in JS
[NisoInternal] undefined checkContinue(boolean primary);
int32_t niso_idb_cursor_check_continue(niso_dom* dom, niso_handle self, bool primary);

continue’s (primary false) or continuePrimaryKey’s (true) checks before the keys are converted.

operation not in JS
[NisoInternal] undefined continueTo(any key, any primaryKey);
int32_t niso_idb_cursor_continue_to(niso_dom* dom, niso_handle self, const uint8_t* key, size_t key_len, const uint8_t* primary_key, size_t primary_key_len);

Their steps after; primaryKey is undefined for continue, and key too when not given.

operation not in JS
[NisoInternal] undefined checkUpdate();
int32_t niso_idb_cursor_check_update(niso_dom* dom, niso_handle self);

update’s checks before the value is cloned, and its steps after.

operation not in JS
[NisoInternal] IDBRequest updateRecord(any value);
int32_t niso_idb_cursor_update_record(niso_dom* dom, niso_handle self, const uint8_t* value, size_t value_len, niso_handle* out);

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)