This page is In Progress

Notice: The WebPlatform project, supported by various stewards between 2012 and 2015, has been discontinued. This site is now available on github.

direction

Summary

Indicates the direction of travel within a cursor.

Property of apis/indexeddb/IDBCursorapis/indexeddb/IDBCursor

Syntax

Note: This property is read-only.

var result = cursor.direction;

Return Value

Returns an object of type StringString

The return value describes the direction of travel and the uniqueness of data within the cursor. It corresponds to one of the following:

next
The cursor is travelling in ascending order and contains all matching records, including duplicate values.
nextunique
The cursor is travelling in ascending order and contains just one instance of matching key values.
prev
The cursor is travelling in descending order and all matching records, including duplicate values.
prevunique
The cursor is travelling in descending order and contains just one instance of matching key values.

Related specifications

Indexed Database API
Working Draft

Attributions