michael@0: /* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
michael@0: /* This Source Code Form is subject to the terms of the Mozilla Public
michael@0:  * License, v. 2.0. If a copy of the MPL was not distributed with this file,
michael@0:  * You can obtain one at http://mozilla.org/MPL/2.0/.
michael@0:  *
michael@0:  * The origin of this IDL file is
michael@0:  * https://dvcs.w3.org/hg/IndexedDB/raw-file/tip/Overview.html#idl-def-IDBIndexParameters
michael@0:  */
michael@0: 
michael@0: dictionary IDBIndexParameters {
michael@0:     boolean unique = false;
michael@0:     boolean multiEntry = false;
michael@0: };
michael@0: 
michael@0: interface IDBIndex {
michael@0:     readonly    attribute DOMString      name;
michael@0:     readonly    attribute IDBObjectStore objectStore;
michael@0: 
michael@0:     [Throws]
michael@0:     readonly    attribute any            keyPath;
michael@0: 
michael@0:     readonly    attribute boolean        multiEntry;
michael@0:     readonly    attribute boolean        unique;
michael@0: 
michael@0:     [Throws]
michael@0:     IDBRequest openCursor (optional any range, optional IDBCursorDirection direction = "next");
michael@0: 
michael@0:     [Throws]
michael@0:     IDBRequest openKeyCursor (optional any range, optional IDBCursorDirection direction = "next");
michael@0: 
michael@0:     [Throws]
michael@0:     IDBRequest get (any key);
michael@0: 
michael@0:     [Throws]
michael@0:     IDBRequest getKey (any key);
michael@0: 
michael@0:     [Throws]
michael@0:     IDBRequest count (optional any key);
michael@0: };
michael@0: 
michael@0: partial interface IDBIndex {
michael@0:     readonly attribute DOMString storeName;
michael@0: 
michael@0:     [Throws]
michael@0:     IDBRequest mozGetAll (optional any key, optional unsigned long limit);
michael@0: 
michael@0:     [Throws]
michael@0:     IDBRequest mozGetAllKeys (optional any key, optional unsigned long limit);
michael@0: };