key

Summary

The key value for the record currently displayed by the cursor.

Property of apis/indexeddb/IDBCursorapis/indexeddb/IDBCursor

Syntax

Note: This property is read-only.

var result = cursor.key;

Return Value

Returns an object of type anyany

The value depends on the source of the value. For more info, see the following Notes section.

Notes

Remarks

The value of the key property depends on the source of the cursor.

If the cursor is opened using an index, the return value represents the value of the attribute associated with the index. If the cursor is opened using an obejct store, the return value represents the record’s primary key. If the cursor record is iterating to a new record or is outside the range of the cursor, the return value is "undefined".

Syntax

Standards information

• Indexed Database API

Attributions

• Microsoft Developer Network: [Windows Internet Explorer API reference Article]