third_party/blink/renderer/modules/indexeddb/idb_cursor.idl

/*
 * Copyright (C) 2010 Google Inc. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1.  Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 * 2.  Redistributions in binary form must reproduce the above copyright
 *     notice, this list of conditions and the following disclaimer in the
 *     documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

// https://w3c.github.io/IndexedDB/#idl-def-IDBCursorDirection

enum IDBCursorDirection {
  "next",
  "nextunique",
  "prev",
  "prevunique"
};

// https://w3c.github.io/IndexedDB/#idl-def-IDBCursor

[
  Exposed=(Window,Worker)
] interface IDBCursor {
  readonly attribute (IDBObjectStore or IDBIndex) source;
  readonly attribute IDBCursorDirection direction;
  [CachedAttribute=isKeyDirty, CallWith=ScriptState] readonly attribute any key;
  [CachedAttribute=isPrimaryKeyDirty, CallWith=ScriptState]
  readonly attribute any primaryKey;
  [SameObject] readonly attribute IDBRequest request;

  [RaisesException] void advance([EnforceRange] unsigned long count);

  [CallWith=ScriptState, ImplementedAs=Continue, RaisesException]
  void continue([DefaultValue=Undefined] optional any key);

  [CallWith=ScriptState, RaisesException]
  void continuePrimaryKey(any key, any primaryKey);

  [CallWith=ScriptState, MeasureAs=IndexedDBWrite, NewObject, RaisesException]
  IDBRequest update(any value);

  [
    CallWith=ScriptState,
    ImplementedAs=Delete,
    MeasureAs=IndexedDBWrite,
    NewObject,
    RaisesException
  ] IDBRequest delete();
};