Skip to content

@ralphschuler.webgl shader factory.<internal>.IDBCursorWithValue

github-actions edited this page Nov 26, 2023 · 1 revision

Interface: IDBCursorWithValue

@ralphschuler/webgl-shader-factory.<internal>.IDBCursorWithValue

This IndexedDB API interface represents a cursor for traversing or iterating over multiple records in a database. It is the same as the IDBCursor, except that it includes the value property.

MDN Reference

Hierarchy

Table of contents

Properties

Methods

Properties

direction

Readonly direction: IDBCursorDirection

Returns the direction ("next", "nextunique", "prev" or "prevunique") of the cursor.

MDN Reference

Inherited from

IDBCursor.direction

Defined in

node_modules/typescript/lib/lib.dom.d.ts:13502


key

Readonly key: IDBValidKey

Returns the key of the cursor. Throws a "InvalidStateError" DOMException if the cursor is advancing or is finished.

MDN Reference

Inherited from

IDBCursor.key

Defined in

node_modules/typescript/lib/lib.dom.d.ts:13508


primaryKey

Readonly primaryKey: IDBValidKey

Returns the effective key of the cursor. Throws a "InvalidStateError" DOMException if the cursor is advancing or is finished.

MDN Reference

Inherited from

IDBCursor.primaryKey

Defined in

node_modules/typescript/lib/lib.dom.d.ts:13514


request

Readonly request: IDBRequest<any>

MDN Reference

Inherited from

IDBCursor.request

Defined in

node_modules/typescript/lib/lib.dom.d.ts:13516


source

Readonly source: IDBObjectStore | IDBIndex

Returns the IDBObjectStore or IDBIndex the cursor was opened from.

MDN Reference

Inherited from

IDBCursor.source

Defined in

node_modules/typescript/lib/lib.dom.d.ts:13522


value

Readonly value: any

Returns the cursor's current value.

MDN Reference

Defined in

node_modules/typescript/lib/lib.dom.d.ts:13577

Methods

advance

advance(count): void

Advances the cursor through the next count records in range.

MDN Reference

Parameters

Name Type
count number

Returns

void

Inherited from

IDBCursor.advance

Defined in

node_modules/typescript/lib/lib.dom.d.ts:13528


continue

continue(key?): void

Advances the cursor to the next record in range.

MDN Reference

Parameters

Name Type
key? IDBValidKey

Returns

void

Inherited from

IDBCursor.continue

Defined in

node_modules/typescript/lib/lib.dom.d.ts:13534


continuePrimaryKey

continuePrimaryKey(key, primaryKey): void

Advances the cursor to the next record in range matching or after key and primaryKey. Throws an "InvalidAccessError" DOMException if the source is not an index.

MDN Reference

Parameters

Name Type
key IDBValidKey
primaryKey IDBValidKey

Returns

void

Inherited from

IDBCursor.continuePrimaryKey

Defined in

node_modules/typescript/lib/lib.dom.d.ts:13540


delete

delete(): IDBRequest<undefined>

Delete the record pointed at by the cursor with a new value.

If successful, request's result will be undefined.

MDN Reference

Returns

IDBRequest<undefined>

Inherited from

IDBCursor.delete

Defined in

node_modules/typescript/lib/lib.dom.d.ts:13548


update

update(value): IDBRequest<IDBValidKey>

Updated the record pointed at by the cursor with a new value.

Throws a "DataError" DOMException if the effective object store uses in-line keys and the key would have changed.

If successful, request's result will be the record's key.

MDN Reference

Parameters

Name Type
value any

Returns

IDBRequest<IDBValidKey>

Inherited from

IDBCursor.update

Defined in

node_modules/typescript/lib/lib.dom.d.ts:13558

Typescript Libraries

Modules

Namespaces

Clone this wiki locally