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

Interface: IDBIndex

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

IDBIndex interface of the IndexedDB API provides asynchronous access to an index in a database. An index is a kind of object store for looking up records in another object store, called the referenced object store. You use this interface to retrieve data.

MDN Reference

Table of contents

Properties

• keyPath
• multiEntry
• name
• objectStore
• unique

Methods

• count
• get
• getAll
• getAllKeys
• getKey
• openCursor
• openKeyCursor

Properties

keyPath

• Readonly keyPath: string | string[]

MDN Reference

Defined in

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

---

multiEntry

• Readonly multiEntry: boolean

MDN Reference

Defined in

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

---

name

• name: string

Returns the name of the index.

MDN Reference

Defined in

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

---

objectStore

• Readonly objectStore: IDBObjectStore

Returns the IDBObjectStore the index belongs to.

MDN Reference

Defined in

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

---

unique

• Readonly unique: boolean

MDN Reference

Defined in

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

Methods

count

▸ count(query?): IDBRequest<number>

Retrieves the number of records matching the given key or key range in query.

If successful, request's result will be the count.

MDN Reference

Parameters

Name	Type
query?	IDBValidKey | IDBKeyRange

Returns

IDBRequest<number>

Defined in

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

---

get

▸ get(query): IDBRequest<any>

Retrieves the value of the first record matching the given key or key range in query.

If successful, request's result will be the value, or undefined if there was no matching record.

MDN Reference

Parameters

Name	Type
query	IDBValidKey | IDBKeyRange

Returns

IDBRequest<any>

Defined in

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

---

getAll

▸ getAll(query?, count?): IDBRequest<any[]>

Retrieves the values of the records matching the given key or key range in query (up to count if given).

If successful, request's result will be an Array of the values.

MDN Reference

Parameters

Name	Type
query?	null | IDBValidKey | IDBKeyRange
count?	number

Returns

IDBRequest<any[]>

Defined in

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

---

getAllKeys

▸ getAllKeys(query?, count?): IDBRequest<IDBValidKey[]>

Retrieves the keys of records matching the given key or key range in query (up to count if given).

If successful, request's result will be an Array of the keys.

MDN Reference

Parameters

Name	Type
query?	null | IDBValidKey | IDBKeyRange
count?	number

Returns

IDBRequest<IDBValidKey[]>

Defined in

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

---

getKey

▸ getKey(query): IDBRequest<undefined | IDBValidKey>

Retrieves the key of the first record matching the given key or key range in query.

If successful, request's result will be the key, or undefined if there was no matching record.

MDN Reference

Parameters

Name	Type
query	IDBValidKey | IDBKeyRange

Returns

IDBRequest<undefined | IDBValidKey>

Defined in

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

---

openCursor

▸ openCursor(query?, direction?): IDBRequest<null | IDBCursorWithValue>

Opens a cursor over the records matching query, ordered by direction. If query is null, all records in index are matched.

If successful, request's result will be an IDBCursorWithValue, or null if there were no matching records.

MDN Reference

Parameters

Name	Type
query?	null | IDBValidKey | IDBKeyRange
direction?	IDBCursorDirection

Returns

IDBRequest<null | IDBCursorWithValue>

Defined in

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

---

openKeyCursor

▸ openKeyCursor(query?, direction?): IDBRequest<null | IDBCursor>

Opens a cursor with key only flag set over the records matching query, ordered by direction. If query is null, all records in index are matched.

If successful, request's result will be an IDBCursor, or null if there were no matching records.

MDN Reference

Parameters

Name	Type
query?	null | IDBValidKey | IDBKeyRange
direction?	IDBCursorDirection

Returns

IDBRequest<null | IDBCursor>

Defined in

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