123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147 |
- /*
- * Copyright (C)2005-2019 Haxe Foundation
- *
- * Permission is hereby granted, free of charge, to any person obtaining a
- * copy of this software and associated documentation files (the "Software"),
- * to deal in the Software without restriction, including without limitation
- * the rights to use, copy, modify, merge, publish, distribute, sublicense,
- * and/or sell copies of the Software, and to permit persons to whom the
- * Software is furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in
- * all copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
- * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
- * DEALINGS IN THE SOFTWARE.
- */
- // This file is generated from mozilla\IDBObjectStore.webidl. Do not edit!
- package js.html.idb;
- /**
- This example shows a variety of different uses of object stores, from updating the data structure with `IDBObjectStore.createIndex` inside an `onupgradeneeded` function, to adding a new item to our object store with `IDBObjectStore.add`. For a full working example, see our To-do Notifications app (view example live.)
- Documentation [IDBObjectStore](https://developer.mozilla.org/en-US/docs/Web/API/IDBObjectStore) by [Mozilla Contributors](https://developer.mozilla.org/en-US/docs/Web/API/IDBObjectStore$history), licensed under [CC-BY-SA 2.5](https://creativecommons.org/licenses/by-sa/2.5/).
- @see <https://developer.mozilla.org/en-US/docs/Web/API/IDBObjectStore>
- **/
- @:native("IDBObjectStore")
- extern class ObjectStore {
-
- /**
- The name of this object store.
- **/
- var name : String;
-
- /**
- The key path of this object store. If this attribute is `null`, the application must provide a key for each modification operation.
- **/
- var keyPath(default,null) : Dynamic;
-
- /**
- A list of the names of indexes on objects in this object store.
- **/
- var indexNames(default,null) : js.html.DOMStringList;
-
- /**
- The `IDBTransaction` object to which this object store belongs.
- **/
- var transaction(default,null) : Transaction;
-
- /**
- The value of the auto increment flag for this object store.
- **/
- var autoIncrement(default,null) : Bool;
-
-
- /**
- Returns an `IDBRequest` object, and, in a separate thread, creates a structured clone of the `value`, and stores the cloned value in the object store. This is for updating existing records in an object store when the transaction's mode is `readwrite`.
- @throws DOMError
- **/
- function put( value : Dynamic, ?key : Dynamic ) : Request;
-
- /**
- Returns an `IDBRequest` object, and, in a separate thread, creates a structured clone of the `value`, and stores the cloned value in the object store. This is for adding new records to an object store.
- @throws DOMError
- **/
- function add( value : Dynamic, ?key : Dynamic ) : Request;
-
- /**
- returns an `IDBRequest` object, and, in a separate thread, deletes the store object selected by the specified key. This is for deleting individual records out of an object store.
- @throws DOMError
- **/
- function delete( key : Dynamic ) : Request;
-
- /**
- Returns an `IDBRequest` object, and, in a separate thread, returns the store object store selected by the specified key. This is for retrieving specific records from an object store.
- @throws DOMError
- **/
- function get( key : Dynamic ) : Request;
-
- /**
- Returns an `IDBRequest` object, and, in a separate thread retrieves and returns the record key for the object in the object stored matching the specified parameter.
- @throws DOMError
- **/
- function getKey( key : Dynamic ) : Request;
-
- /**
- Creates and immediately returns an `IDBRequest` object, and clears this object store in a separate thread. This is for deleting all current records out of an object store.
- @throws DOMError
- **/
- function clear() : Request;
-
- /**
- Returns an `IDBRequest` object, and, in a separate thread, returns a new `IDBCursorWithValue` object. Used for iterating through an object store by primary key with a cursor.
- @throws DOMError
- **/
- function openCursor( ?range : Dynamic, direction : CursorDirection = NEXT ) : Request;
-
- /**
- Creates a new index during a version upgrade, returning a new `IDBIndex` object in the connected database.
- @throws DOMError
- **/
- @:overload( function( name : String, keyPath : Array<String>, ?optionalParameters : IndexParameters) : Index {} )
- function createIndex( name : String, keyPath : String, ?optionalParameters : IndexParameters ) : Index;
-
- /**
- Opens an index from this object store after which it can, for example, be used to return a sequence of records sorted by that index using a cursor.
- @throws DOMError
- **/
- function index( name : String ) : Index;
-
- /**
- Destroys the specified index in the connected database, used during a version upgrade.
- @throws DOMError
- **/
- function deleteIndex( indexName : String ) : Void;
-
- /**
- Returns an `IDBRequest` object, and, in a separate thread, returns the total number of records that match the provided key or `IDBKeyRange`. If no arguments are provided, it returns the total number of records in the store.
- @throws DOMError
- **/
- function count( ?key : Dynamic ) : Request;
-
- /**
- Returns an `IDBRequest` object retrieves all objects in the object store matching the specified parameter or all objects in the store if no parameters are given.
- @throws DOMError
- **/
- function getAll( ?key : Dynamic, ?limit : Int ) : Request;
-
- /**
- Returns an `IDBRequest` object retrieves record keys for all objects in the object store matching the specified parameter or all objects in the store if no parameters are given.
- @throws DOMError
- **/
- function getAllKeys( ?key : Dynamic, ?limit : Int ) : Request;
-
- /**
- Returns an `IDBRequest` object, and, in a separate thread, returns a new `IDBCursor`. Used for iterating through an object store with a key.
- @throws DOMError
- **/
- function openKeyCursor( ?range : Dynamic, direction : CursorDirection = NEXT ) : Request;
- }
|