W3cubDocs

/Web APIs

IDBFactory: cmp() method

The cmp() method of the IDBFactory interface compares two values as keys to determine equality and ordering for IndexedDB operations, such as storing and iterating.

Note: This feature is available in Web Workers

Note: Do not use this method for comparing arbitrary JavaScript values, because many JavaScript values are either not valid IndexedDB keys (booleans and objects, for example) or are treated as equivalent IndexedDB keys (for example, since IndexedDB ignores arrays with non-numeric properties and treats them as empty arrays, so any non-numeric arrays are treated as equivalent). This throws an exception if either of the values is not a valid key.

Syntax

js

cmp(first, second)

Parameters

first

The first key to compare.

second

The second key to compare.

Return value

An integer that indicates the result of the comparison; the table below lists the possible values and their meanings:

Returned value Description
-1 1st key is less than the 2nd key
0 1st key is equal to the 2nd key
1 1st key is greater than the 2nd key

Exceptions

DataError DOMException

Thrown if one of the supplied keys was not a valid key.

Examples

js

const a = 1;
const b = 2;
const result = window.indexedDB.cmp(a, b);
console.log(`Comparison results: ${result}`);

Specifications

Browser compatibility

Desktop Mobile
Chrome Edge Firefox Internet Explorer Opera Safari WebView Android Chrome Android Firefox for Android Opera Android Safari on IOS Samsung Internet
cmp 23 12 10 10 15 8 4.4 25 22 14 8 1.5

See also

© 2005–2023 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/IDBFactory/cmp