Liking cljdoc? Tell your friends :D

idb.IDBIndex

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

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

countcljs

(count this & args)

Method.

A idb.IDBRequest object on which subsequent events related this operation are fired.

var request = myIndex.count(); var request = myIndex.count(key);

See also: https://developer.mozilla.org/en-US/docs/Web/API/IDBIndex/count

Method.

A `idb.IDBRequest` object on which subsequent events related
this operation are fired.

`var request = myIndex.count();
var request = myIndex.count(key);`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/IDBIndex/count`
sourceraw docstring

getcljs

(get this key)

Method.

If a value is found, then a structured clone of it is created set as the result of the request object: this returns the record key is associated with.

var request = myIndex.get(key);

See also: https://developer.mozilla.org/en-US/docs/Web/API/IDBIndex/get

Method.

If a value is found, then a structured clone of it is created
set as the result of the request object: this returns the record
key is associated with.

`var request = myIndex.get(key);`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/IDBIndex/get`
sourceraw docstring

get-allcljs

(get-all this & args)

Method.

There is a performance cost associated with looking at the value of a cursor, because the object is created lazily. To use a feature getAll(), the browser has to create all the objects at once. you are just interested in looking at each of the keys, for instance, is more efficient to use a cursor. If you are trying to get an of all the objects in an object store, though, you should use

var getAllKeysRequest = IDBIndex.getAll(); var getAllKeysRequest = IDBIndex.getAll(query); var getAllKeysRequest = IDBIndex.getAll(query, count);

See also: https://developer.mozilla.org/en-US/docs/Web/API/IDBIndex/getAll

Method.

There is a performance cost associated with looking at the value
of a cursor, because the object is created lazily. To use a feature
getAll(), the browser has to create all the objects at once.
you are just interested in looking at each of the keys, for instance,
is more efficient to use a cursor. If you are trying to get an
of all the objects in an object store, though, you should use

`var getAllKeysRequest = IDBIndex.getAll();
var getAllKeysRequest = IDBIndex.getAll(query);
var getAllKeysRequest = IDBIndex.getAll(query, count);`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/IDBIndex/getAll`
sourceraw docstring

get-all-keyscljs

(get-all-keys this & args)

Method.

An idb.IDBRequest object on which subsequent events related this operation are fired.

var allKeysRequest = IDBIndex.getAllKeys(); var allKeysRequest = IDBIndex.getAllKeys(query); var allKeysRequest = IDBIndex.getAllKeys(query, count);

See also: https://developer.mozilla.org/en-US/docs/Web/API/IDBIndex/getAllKeys

Method.

An `idb.IDBRequest` object on which subsequent events related
this operation are fired.

`var allKeysRequest = IDBIndex.getAllKeys();
var allKeysRequest = IDBIndex.getAllKeys(query);
var allKeysRequest = IDBIndex.getAllKeys(query, count);`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/IDBIndex/getAllKeys`
sourceraw docstring

get-keycljs

(get-key this key)

Method.

If a key is found it is set as the result of the request object: returns the primary key of the record the key is associated with, the whole record as idb.IDBIndex.get does.

var request = myIndex.getKey(key);

See also: https://developer.mozilla.org/en-US/docs/Web/API/IDBIndex/getKey

Method.

If a key is found it is set as the result of the request object:
returns the primary key of the record the key is associated with,
the whole record as `idb.IDBIndex.get` does.

`var request = myIndex.getKey(key);`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/IDBIndex/getKey`
sourceraw docstring

is-auto-localecljs

(is-auto-locale this)

Property.

The isAutoLocale read-only property of the idb.IDBIndex interface a web.Boolean indicating whether the index had a locale value auto specified upon its creation (see createIndex()'s optionalParameters.)

var myIndex = objectStore.index('index'); console.log(myIndex.isAutoLocale);

See also: https://developer.mozilla.org/en-US/docs/Web/API/IDBIndex/isAutoLocale

Property.

The isAutoLocale read-only property of the `idb.IDBIndex` interface
a `web.Boolean` indicating whether the index had a locale value
auto specified upon its creation (see createIndex()'s optionalParameters.)

`var myIndex = objectStore.index('index');
console.log(myIndex.isAutoLocale);`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/IDBIndex/isAutoLocale`
sourceraw docstring

key-pathcljs

(key-path this)

Property.

Any data type that can be used as a key path.

var myKeyPath = myIndex.keyPath;

See also: https://developer.mozilla.org/en-US/docs/Web/API/IDBIndex/keyPath

Property.

Any data type that can be used as a key path.

`var myKeyPath = myIndex.keyPath;`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/IDBIndex/keyPath`
sourceraw docstring

localecljs

(locale this)

Property.

The locale read-only property of the idb.IDBIndex interface the locale of the index (for example en-US, or pl) if it had locale value specified upon its creation (see createIndex()'s Note that this property always returns the current locale being in this index, in other words, it never returns "auto".

var myIndex = objectStore.index('index'); console.log(myIndex.locale);

See also: https://developer.mozilla.org/en-US/docs/Web/API/IDBIndex/locale

Property.

The locale read-only property of the `idb.IDBIndex` interface
the locale of the index (for example en-US, or pl) if it had
locale value specified upon its creation (see createIndex()'s
Note that this property always returns the current locale being
in this index, in other words, it never returns \"auto\".

`var myIndex = objectStore.index('index');
console.log(myIndex.locale);`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/IDBIndex/locale`
sourceraw docstring

multi-entrycljs

(multi-entry this)

Property.

A web.Boolean:

var isMultiEntry = myIndex.multiEntry;

See also: https://developer.mozilla.org/en-US/docs/Web/API/IDBIndex/multiEntry

Property.

A `web.Boolean`:

`var isMultiEntry = myIndex.multiEntry;`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/IDBIndex/multiEntry`
sourceraw docstring

namecljs

(name this)

Property.

A dom.DOMString specifying a name for the index.

var indexName = IDBIndex.name; IDBIndex.name = indexName;

See also: https://developer.mozilla.org/en-US/docs/Web/API/IDBIndex/name

Property.

A `dom.DOMString` specifying a name for the index.

`var indexName = IDBIndex.name;
IDBIndex.name = indexName;`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/IDBIndex/name`
sourceraw docstring

object-storecljs

(object-store this)

Property.

An idb.IDBObjectStore.

var myIDBObjectStore = myIndex.objectStore;

See also: https://developer.mozilla.org/en-US/docs/Web/API/IDBIndex/objectStore

Property.

An `idb.IDBObjectStore`.

`var myIDBObjectStore = myIndex.objectStore;`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/IDBIndex/objectStore`
sourceraw docstring

open-cursorcljs

(open-cursor this & args)

Method.

The method sets the position of the cursor to the appropriate based on the specified direction.

var request = myIndex.openCursor(); var request = myIndex.openCursor(range); var request = myIndex.openCursor(range, direction);

See also: https://developer.mozilla.org/en-US/docs/Web/API/IDBIndex/openCursor

Method.

The method sets the position of the cursor to the appropriate
based on the specified direction.

`var request = myIndex.openCursor();
var request = myIndex.openCursor(range);
var request = myIndex.openCursor(range, direction);`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/IDBIndex/openCursor`
sourceraw docstring

open-key-cursorcljs

(open-key-cursor this & args)

Method.

The method sets the position of the cursor to the appropriate based on the specified direction.

var request = myIndex.openKeyCursor(); var request = myIndex.openKeyCursor(range); var request = myIndex.openKeyCursor(range, direction);

See also: https://developer.mozilla.org/en-US/docs/Web/API/IDBIndex/openKeyCursor

Method.

The method sets the position of the cursor to the appropriate
based on the specified direction.

`var request = myIndex.openKeyCursor();
var request = myIndex.openKeyCursor(range);
var request = myIndex.openKeyCursor(range, direction);`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/IDBIndex/openKeyCursor`
sourceraw docstring

set-is-auto-locale!cljs

(set-is-auto-locale! this val)

Property.

The isAutoLocale read-only property of the idb.IDBIndex interface a web.Boolean indicating whether the index had a locale value auto specified upon its creation (see createIndex()'s optionalParameters.)

var myIndex = objectStore.index('index'); console.log(myIndex.isAutoLocale);

See also: https://developer.mozilla.org/en-US/docs/Web/API/IDBIndex/isAutoLocale

Property.

The isAutoLocale read-only property of the `idb.IDBIndex` interface
a `web.Boolean` indicating whether the index had a locale value
auto specified upon its creation (see createIndex()'s optionalParameters.)

`var myIndex = objectStore.index('index');
console.log(myIndex.isAutoLocale);`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/IDBIndex/isAutoLocale`
sourceraw docstring

set-key-path!cljs

(set-key-path! this val)

Property.

Any data type that can be used as a key path.

var myKeyPath = myIndex.keyPath;

See also: https://developer.mozilla.org/en-US/docs/Web/API/IDBIndex/keyPath

Property.

Any data type that can be used as a key path.

`var myKeyPath = myIndex.keyPath;`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/IDBIndex/keyPath`
sourceraw docstring

set-locale!cljs

(set-locale! this val)

Property.

The locale read-only property of the idb.IDBIndex interface the locale of the index (for example en-US, or pl) if it had locale value specified upon its creation (see createIndex()'s Note that this property always returns the current locale being in this index, in other words, it never returns "auto".

var myIndex = objectStore.index('index'); console.log(myIndex.locale);

See also: https://developer.mozilla.org/en-US/docs/Web/API/IDBIndex/locale

Property.

The locale read-only property of the `idb.IDBIndex` interface
the locale of the index (for example en-US, or pl) if it had
locale value specified upon its creation (see createIndex()'s
Note that this property always returns the current locale being
in this index, in other words, it never returns \"auto\".

`var myIndex = objectStore.index('index');
console.log(myIndex.locale);`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/IDBIndex/locale`
sourceraw docstring

set-multi-entry!cljs

(set-multi-entry! this val)

Property.

A web.Boolean:

var isMultiEntry = myIndex.multiEntry;

See also: https://developer.mozilla.org/en-US/docs/Web/API/IDBIndex/multiEntry

Property.

A `web.Boolean`:

`var isMultiEntry = myIndex.multiEntry;`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/IDBIndex/multiEntry`
sourceraw docstring

set-name!cljs

(set-name! this val)

Property.

A dom.DOMString specifying a name for the index.

var indexName = IDBIndex.name; IDBIndex.name = indexName;

See also: https://developer.mozilla.org/en-US/docs/Web/API/IDBIndex/name

Property.

A `dom.DOMString` specifying a name for the index.

`var indexName = IDBIndex.name;
IDBIndex.name = indexName;`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/IDBIndex/name`
sourceraw docstring

set-object-store!cljs

(set-object-store! this val)

Property.

An idb.IDBObjectStore.

var myIDBObjectStore = myIndex.objectStore;

See also: https://developer.mozilla.org/en-US/docs/Web/API/IDBIndex/objectStore

Property.

An `idb.IDBObjectStore`.

`var myIDBObjectStore = myIndex.objectStore;`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/IDBIndex/objectStore`
sourceraw docstring

set-unique!cljs

(set-unique! this val)

Property.

A web.Boolean:

var isUnique = IDBIndex.unique;

See also: https://developer.mozilla.org/en-US/docs/Web/API/IDBIndex/unique

Property.

A `web.Boolean`:

`var isUnique = IDBIndex.unique;`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/IDBIndex/unique`
sourceraw docstring

uniquecljs

(unique this)

Property.

A web.Boolean:

var isUnique = IDBIndex.unique;

See also: https://developer.mozilla.org/en-US/docs/Web/API/IDBIndex/unique

Property.

A `web.Boolean`:

`var isUnique = IDBIndex.unique;`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/IDBIndex/unique`
sourceraw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close