dom/webidl/IDBIndex.webidl

   1 /* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* This Source Code Form is subject to the terms of the Mozilla Public
   3  * License, v. 2.0. If a copy of the MPL was not distributed with this file,
   4  * You can obtain one at http://mozilla.org/MPL/2.0/.
   5  *
   6  * The origin of this IDL file is
   7  * https://dvcs.w3.org/hg/IndexedDB/raw-file/tip/Overview.html#idl-def-IDBIndexParameters
   8  */
   9
  10 dictionary IDBIndexParameters {
  11     boolean unique = false;
  12     boolean multiEntry = false;
  13 };
  14
  15 interface IDBIndex {
  16     readonly    attribute DOMString      name;
  17     readonly    attribute IDBObjectStore objectStore;
  18
  19     [Throws]
  20     readonly    attribute any            keyPath;
  21
  22     readonly    attribute boolean        multiEntry;
  23     readonly    attribute boolean        unique;
  24
  25     [Throws]
  26     IDBRequest openCursor (optional any range, optional IDBCursorDirection direction = "next");
  27
  28     [Throws]
  29     IDBRequest openKeyCursor (optional any range, optional IDBCursorDirection direction = "next");
  30
  31     [Throws]
  32     IDBRequest get (any key);
  33
  34     [Throws]
  35     IDBRequest getKey (any key);
  36
  37     [Throws]
  38     IDBRequest count (optional any key);
  39 };
  40
  41 partial interface IDBIndex {
  42     readonly attribute DOMString storeName;
  43
  44     [Throws]
  45     IDBRequest mozGetAll (optional any key, optional unsigned long limit);
  46
  47     [Throws]
  48     IDBRequest mozGetAllKeys (optional any key, optional unsigned long limit);
  49 };