1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
|
/*
* 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\IDBIndex.webidl. Do not edit!
package js.html.idb;
/**
`IDBIndex` interface of the IndexedDB API provides asynchronous access to an index in a database. An index is a kind of object store for looking up records in another object store, called the referenced object store. You use this interface to retrieve data.
Documentation [IDBIndex](https://developer.mozilla.org/en-US/docs/Web/API/IDBIndex) by [Mozilla Contributors](https://developer.mozilla.org/en-US/docs/Web/API/IDBIndex$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/IDBIndex>
**/
@:native("IDBIndex")
extern class Index {
/**
The name of this index.
**/
var name : String;
/**
The name of the object store referenced by this index.
**/
var objectStore(default,null) : ObjectStore;
/**
The key path of this index. If null, this index is not auto-populated.
**/
var keyPath(default,null) : Dynamic;
/**
Affects how the index behaves when the result of evaluating the index's key path yields an array. If `true`, there is one record in the index for each item in an array of keys. If `false`, then there is one record for each key that is an array.
**/
var multiEntry(default,null) : Bool;
/**
If `true`, this index does not allow duplicate values for a key.
**/
var unique(default,null) : Bool;
/**
Returns an `IDBRequest` object, and, in a separate thread, creates a cursor over the specified key range.
@throws DOMError
**/
function openCursor( ?range : Dynamic, direction : CursorDirection = NEXT ) : Request;
/**
Returns an `IDBRequest` object, and, in a separate thread, creates a cursor over the specified key range, as arranged by this index.
@throws DOMError
**/
function openKeyCursor( ?range : Dynamic, direction : CursorDirection = NEXT ) : Request;
/**
Returns an `IDBRequest` object, and, in a separate thread, finds either the value in the referenced object store that corresponds to the given key or the first corresponding value, if `key` is an `IDBKeyRange`.
@throws DOMError
**/
function get( key : Dynamic ) : Request;
/**
Returns an `IDBRequest` object, and, in a separate thread, finds either the given key or the primary key, if `key` is an `IDBKeyRange`.
@throws DOMError
**/
function getKey( key : Dynamic ) : Request;
/**
Returns an `IDBRequest` object, and in a separate thread, returns the number of records within a key range.
@throws DOMError
**/
function count( ?key : Dynamic ) : Request;
/**
Returns an `IDBRequest` object, in a separate thread, finds all matching values in the referenced object store that correspond to the given key or are in range, if `key` is an `IDBKeyRange`.
@throws DOMError
**/
function getAll( ?key : Dynamic, ?limit : Int ) : Request;
/**
Returns an `IDBRequest` object, in a separate thread, finds all matching keys in the referenced object store that correspond to the given key or are in range, if `key` is an `IDBKeyRange`.
@throws DOMError
**/
function getAllKeys( ?key : Dynamic, ?limit : Int ) : Request;
}
|
