forked from dexie/Dexie.js
-
Notifications
You must be signed in to change notification settings - Fork 0
/
dexie.d.ts
454 lines (361 loc) · 19.4 KB
/
dexie.d.ts
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
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
// Type definitions for Dexie v1.4.0
// Project: https://github.com/dfahlander/Dexie.js
// Definitions by: David Fahlander <http://github.com/dfahlander>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
interface Thenable<R> {
then<U>(onFulfilled: (value: R) => Thenable<U>, onRejected: (error: any) => Thenable<U>): Thenable<U>;
then<U>(onFulfilled: (value: R) => Thenable<U>, onRejected?: (error: any) => U): Thenable<U>;
then<U>(onFulfilled: (value: R) => U, onRejected: (error: any) => Thenable<U>): Thenable<U>;
then<U>(onFulfilled?: (value: R) => U, onRejected?: (error: any) => U): Thenable<U>;
}
declare type IndexableType = string | number | Date | Array<string | number | Date>;
declare class Dexie {
constructor(databaseName: string, options?: {
addons?: Array<(db: Dexie) => void>,
autoOpen?: boolean,
indexedDB?: IDBFactory,
IDBKeyRange?: IDBKeyRange
});
name: string;
tables: Dexie.Table<any, any>[];
verno: number;
static addons: Array<(db: Dexie) => void>;
static version: number;
static semVer: string;
static currentTransaction: Dexie.Transaction;
static getDatabaseNames(): Dexie.Promise<Array<string>>;
static getDatabaseNames<U>(onFulfilled: (value: Array<string>) => Thenable<U>): Dexie.Promise<U>;
static getDatabaseNames<U>(onFulfilled: (value: Array<string>) => U): Dexie.Promise<U>;
static override<F> (origFunc:F, overridedFactory: (fn:any)=>any) : F;
static getByKeyPath(obj: Object, keyPath: string): any;
static setByKeyPath(obj: Object, keyPath: string, value: any): void;
static delByKeyPath(obj: Object, keyPath: string): void;
static shallowClone<T> (obj: T): T;
static deepClone<T>(obj: T): T;
static asap(fn: Function) : void;
static maxKey: Array<string>;
static dependencies: {
indexedDB: IDBFactory,
IDBKeyRange: IDBKeyRange,
localStorage?: Storage
};
static default: Dexie;
version(versionNumber: Number): Dexie.Version;
on: {
(eventName: string, subscriber: Function, ...args : any[]): void;
(eventName: 'ready', subscriber: () => any, bSticky: boolean): void;
(eventName: 'error', subscriber: (error: any) => any): void;
(eventName: 'populate', subscriber: () => any): void;
(eventName: 'blocked', subscriber: () => any): void;
(eventName: 'versionchange', subscriber: (event: IDBVersionChangeEvent) => any): void;
ready: Dexie.DexieOnReadyEvent;
error: Dexie.DexieErrorEvent;
populate: Dexie.DexieEvent;
blocked: Dexie.DexieEvent;
versionchange: Dexie.DexieVersionChangeEvent;
}
open(): Dexie.Promise<Dexie>;
table(tableName: string): Dexie.Table<any, any>;
table<T>(tableName: string): Dexie.Table<T, any>;
table<T, Key>(tableName: string): Dexie.Table<T, Key>;
transaction<U>(mode: string, table: Dexie.Table<any, any>, scope: () => Thenable<U>): Dexie.Promise<U>;
transaction<U>(mode: string, table: Dexie.Table<any, any>, table2: Dexie.Table<any, any>, scope: () => Thenable<U>): Dexie.Promise<U>;
transaction<U>(mode: string, table: Dexie.Table<any, any>, table2: Dexie.Table<any, any>, table3: Dexie.Table<any, any>, scope: () => Thenable<U>): Dexie.Promise<U>;
transaction<U>(mode: string, tables: Dexie.Table<any, any>[], scope: () => Thenable<U>): Dexie.Promise<U>;
transaction<U>(mode: string, table: Dexie.Table<any, any>, scope: () => U): Dexie.Promise<U>;
transaction<U>(mode: string, table: Dexie.Table<any, any>, table2: Dexie.Table<any, any>, scope: () => U): Dexie.Promise<U>;
transaction<U>(mode: string, table: Dexie.Table<any, any>, table2: Dexie.Table<any, any>, table3: Dexie.Table<any, any>, scope: () => U): Dexie.Promise<U>;
transaction<U>(mode: string, tables: Dexie.Table<any, any>[], scope: () => U): Dexie.Promise<U>;
close(): void;
delete(): Dexie.Promise<void>;
exists(name : string) : Dexie.Promise<boolean>;
isOpen(): boolean;
hasFailed(): boolean;
backendDB(): IDBDatabase;
vip<U>(scopeFunction: () => U): U;
// Make it possible to touch physical class constructors where they reside - as properties on db instance.
// For example, checking if (x instanceof db.Table). Can't do (x instanceof Dexie.Table because it's just a virtual interface)
Table : new()=>Dexie.Table<any,any>;
WhereClause: new()=>Dexie.WhereClause<any,any>;
Version: new()=>Dexie.Version;
WriteableTable: new()=>Dexie.Table<any,any>;
Transaction: new()=>Dexie.Transaction;
Collection: new()=>Dexie.Collection<any,any>;
WriteableCollection: new()=>Dexie.Collection<any,any>;
}
declare module Dexie {
class Promise<R> implements Thenable<R> {
constructor(callback: (resolve: (value?: Thenable<R>) => void, reject: (error?: any) => void) => void);
constructor(callback: (resolve: (value?: R) => void, reject: (error?: any) => void) => void);
then<U>(onFulfilled: (value: R) => Thenable<U>, onRejected: (error: any) => Thenable<U>): Promise<U>;
then<U>(onFulfilled: (value: R) => Thenable<U>, onRejected?: (error: any) => U): Promise<U>;
then<U>(onFulfilled: (value: R) => U, onRejected: (error: any) => Thenable<U>): Promise<U>;
then<U>(onFulfilled?: (value: R) => U, onRejected?: (error: any) => U): Promise<U>;
catch<U>(onRejected: (error: any) => Thenable<U>): Promise<U>;
catch<U>(onRejected: (error: any) => U): Promise<U>;
catch<U,ET>(ExceptionType: (new() => ET), onRejected: (error: ET) => Promise<U>): Promise<U>;
catch<U,ET>(ExceptionType: (new() => ET), onRejected: (error: ET) => U): Promise<U>;
catch<U>(errorName: string, onRejected: (error: {name: string}) => Promise<U>): Promise<U>;
catch<U>(errorName: string, onRejected: (error: {name: string}) => U): Promise<U>;
finally<R>(onFinally: () => any): Promise<R>;
onuncatched: () => any;
}
module Promise {
function resolve<R>(value?: Thenable<R>): Promise<R>;
function resolve<R>(value?: R): Promise<R>;
function reject(error: any): Promise<any>;
function all<R>(promises: Thenable<R>[]): Promise<R[]>;
function all<R>(...promises: Thenable<R>[]): Promise<R[]>;
function race<R>(promises: Thenable<R>[]): Promise<R>;
function newPSD<R>(scope: () => R): R;
var PSD: any;
var on: {
(eventName: string, subscriber: Function): void;
(eventName: 'error', subscriber: (error: any) => any): void;
error: DexieErrorEvent;
}
}
interface Version {
stores(schema: { [key: string]: string }): Version;
upgrade(fn: (trans: Transaction) => void): Version;
}
interface Transaction {
active: boolean;
db: Dexie;
mode: string;
idbtrans: IDBTransaction;
tables: { [type: string]: Table<any, any> };
storeNames: Array<string>;
on: {
(eventName: string, subscriber: () => any): void;
(eventName: 'complete', subscriber: () => any): void;
(eventName: 'abort', subscriber: () => any): void;
(eventName: 'error', subscriber: (error:any) => any): void;
complete: DexieEvent;
abort: DexieEvent;
error: DexieEvent;
}
abort(): void;
table(tableName: string): Table<any, any>;
table<T>(tableName: string): Table<T, any>;
table<T, Key>(tableName: string): Table<T, Key>;
}
interface DexieEvent {
subscribe(fn: () => any): void;
unsubscribe(fn: () => any): void;
fire(): any;
}
interface DexieErrorEvent {
subscribe(fn: (error: any) => any): void;
unsubscribe(fn: (error: any) => any): void;
fire(error: any): any;
}
interface DexieVersionChangeEvent {
subscribe(fn: (event: IDBVersionChangeEvent) => any): void;
unsubscribe(fn: (event: IDBVersionChangeEvent) => any): void;
fire(event: IDBVersionChangeEvent): any;
}
interface DexieOnReadyEvent {
subscribe(fn: () => any, bSticky: boolean): void;
unsubscribe(fn: () => any): void;
fire(): any;
}
interface Table<T, Key> {
name: string;
schema: TableSchema;
hook: {
(eventName: string, subscriber: () => any): void;
creating: DexieEvent;
reading: DexieEvent;
updating: DexieEvent;
deleting: DexieEvent;
}
get(key: Key): Promise<T>;
where(index: string): WhereClause<T, Key>;
filter(fn: (obj: T) => boolean): Collection<T, Key>;
count(): Promise<number>;
count<U>(onFulfilled: (value: number) => Thenable<U>): Promise<U>;
count<U>(onFulfilled: (value: number) => U): Promise<U>;
offset(n: number): Collection<T, Key>;
limit(n: number): Collection<T, Key>;
each(callback: (obj: T, cursor: {key: IndexableType, primaryKey: Key}) => any): Promise<void>;
toArray(): Promise<Array<T>>;
toArray<U>(onFulfilled: (value: Array<T>) => Thenable<U>): Promise<U>;
toArray<U>(onFulfilled: (value: Array<T>) => U): Promise<U>;
toCollection(): Collection<T, Key>;
orderBy(index: string): Collection<T, Key>;
reverse(): Collection<T, Key>;
mapToClass(constructor: Function): Function;
add(item: T, key?: Key): Promise<Key>;
update(key: Key, changes: { [keyPath: string]: any }): Promise<number>;
put(item: T, key?: Key): Promise<Key>;
delete(key: Key): Promise<void>;
clear(): Promise<void>;
bulkAdd(items: T[], keys?: IndexableType[]): Promise<Key>;
bulkPut(items: T[], keys?: IndexableType[]): Promise<Key>;
bulkDelete(keys: IndexableType[]) : Promise<void>;
}
interface WhereClause<T, Key> {
above(key: IndexableType): Collection<T, Key>;
aboveOrEqual(key: IndexableType): Collection<T, Key>;
anyOf(keys: IndexableType[]): Collection<T, Key>;
anyOf(...keys: IndexableType[]): Collection<T, Key>;
anyOfIgnoreCase(keys: string[]): Collection<T, Key>;
anyOfIgnoreCase(...keys: string[]): Collection<T, Key>;
below(key: IndexableType): Collection<T, Key>;
belowOrEqual(key: IndexableType): Collection<T, Key>;
between(lower: IndexableType, upper: IndexableType, includeLower?: boolean, includeUpper?: boolean): Collection<T, Key>;
equals(key: IndexableType): Collection<T, Key>;
equalsIgnoreCase(key: string): Collection<T, Key>;
inAnyRange(ranges: Array<IndexableType[]>): Collection<T, Key>;
startsWith(key: string): Collection<T, Key>;
startsWithAnyOf(prefixes: string[]): Collection<T, Key>;
startsWithAnyOf(...prefixes: string[]): Collection<T, Key>;
startsWithIgnoreCase(key: string): Collection<T, Key>;
startsWithAnyOfIgnoreCase(prefixes: string[]): Collection<T, Key>;
startsWithAnyOfIgnoreCase(...prefixes: string[]): Collection<T, Key>;
noneOf(keys: Array<IndexableType>): Collection<T, Key>;
notEqual(key: IndexableType): Collection<T, Key>;
}
interface Collection<T, Key> {
and(filter: (x: T) => boolean): Collection<T, Key>;
clone(props?: Object): Collection<T, Key>;
count(): Promise<number>;
count<U>(onFulfilled: (value: number) => Thenable<U>): Promise<U>;
count<U>(onFulfilled: (value: number) => U): Promise<U>;
distinct(): Collection<T, Key>;
each(callback: (obj: T, cursor: {key: IndexableType, primaryKey: Key}) => any): Promise<void>;
eachKey(callback: (key: IndexableType, cursor: {key: IndexableType, primaryKey: Key}) => any): Promise<void>;
eachPrimaryKey(callback: (key: Key, cursor: {key: IndexableType, primaryKey: Key}) => any): Promise<void>;
eachUniqueKey(callback: (key: IndexableType, cursor: {key: IndexableType, primaryKey: Key}) => any): Promise<void>;
filter(filter: (x: T) => boolean): Collection<T, Key>;
first(): Promise<T>;
first<U>(onFulfilled: (value: T) => Thenable<U>): Promise<U>;
first<U>(onFulfilled: (value: T) => U): Promise<U>;
keys(): Promise<IndexableType[]>;
keys<U>(onFulfilled: (value: IndexableType[]) => Thenable<U>): Promise<U>;
keys<U>(onFulfilled: (value: IndexableType[]) => U): Promise<U>;
primaryKeys(): Promise<Key[]>;
primaryKeys<U>(onFulfilled: (value: Key[]) => Thenable<U>): Promise<U>;
primaryKeys<U>(onFulfilled: (value: Key[]) => U): Promise<U>;
last(): Promise<T>;
last<U>(onFulfilled: (value: T) => Thenable<U>): Promise<U>;
last<U>(onFulfilled: (value: T) => U): Promise<U>;
limit(n: number): Collection<T, Key>;
offset(n: number): Collection<T, Key>;
or(indexOrPrimayKey: string): WhereClause<T, Key>;
raw(): Collection<T, Key>;
reverse(): Collection<T, Key>;
sortBy(keyPath: string): Promise<T[]>;
sortBy<U>(keyPath: string, onFulfilled: (value: T[]) => Thenable<U>): Promise<U>;
sortBy<U>(keyPath: string, onFulfilled: (value: T[]) => U): Promise<U>;
toArray(): Promise<Array<T>>;
toArray<U>(onFulfilled: (value: Array<T>) => Thenable<U>): Promise<U>;
toArray<U>(onFulfilled: (value: Array<T>) => U): Promise<U>;
uniqueKeys(): Promise<IndexableType[]>;
uniqueKeys<U>(onFulfilled: (value: IndexableType[]) => Thenable<U>): Promise<U>;
uniqueKeys<U>(onFulfilled: (value: IndexableType[]) => U): Promise<U>;
until(filter: (value: T) => boolean, includeStopEntry?: boolean): Collection<T, Key>;
// WriteableCollection:
delete(): Promise<number>;
modify(changeCallback: (obj: T, ctx:{value: T}) => void): Promise<number>;
modify(changes: { [keyPath: string]: any } ): Promise<number>;
}
interface TableSchema {
name: string;
primKey: IndexSpec;
indexes: IndexSpec[];
mappedClass: Function;
}
interface IndexSpec {
name: string;
keyPath: string | Array<string>;
unique: boolean;
multi: boolean;
auto: boolean;
compound: boolean;
src: string;
}
// Make it possible to touch physical classes as they are
var TableSchema: new()=>TableSchema,
IndexSpec: new()=>IndexSpec,
Events: any; // Too complex to define correctly right now.
// errnames - handy spellcheck in switch (error.name) {} cases.
var errnames: {
// Error names generated by indexedDB:
Unknown: 'UnknownError';
Constraint: 'ConstraintError';
Data: 'DataError';
TransactionInactive: 'TransactionInactiveError';
ReadOnly: 'ReadOnlyError';
Version: 'VersionError';
NotFound: 'NotFoundError';
InvalidState: 'InvalidStateError';
InvalidAccess: 'InvalidAccessError';
Abort: 'AbortError';
Timeout: 'TimeoutError';
QuotaExceeded: 'QuotaExceededError';
Syntax: 'SyntaxError';
DataClone: 'DataCloneError';
// Dexie-specific error names:
Modify: 'ModifyError';
OpenFailed: 'OpenFailedError';
VersionChange: 'VersionChangeError';
Schema: 'SchemaError';
Upgrade: 'UpgradeError';
InvalidTable: 'InvalidTableError';
MissingAPI: 'MissingAPIError';
NoSuchDatabase: 'NoSuchDatabaseError';
InvalidArgument: 'InvalidArgumentError';
SubTransaction: 'Error';
Unsupported: 'UnsupportedError';
Internal: 'InternalError';
DatabaseClosed: 'DatabaseClosedError';
};
class DexieError extends Error {
name: string;
message: string;
stack: string;
inner: any;
constructor (name?:string, message?:string);
toString(): string;
}
class ModifyError extends DexieError{
constructor (msg?:string, failures?: any[], successCount?: number, failedKeys?: IndexableType[]);
failures: Array<any>;
failedKeys: Array<IndexableType>;
successCount: number;
}
class BulkError extends DexieError{
constructor (msg?:string, failures?: any[]);
failures: Array<any>;
}
class OpenFailedError extends DexieError {constructor (msg?: string, inner?: Object);constructor (inner: Object);}
class VersionChangeError extends DexieError {constructor (msg?: string, inner?: Object); constructor (inner: Object);}
class SchemaError extends DexieError {constructor (msg?: string, inner?: Object); constructor (inner: Object);}
class UpgradeError extends DexieError {constructor (msg?: string, inner?: Object); constructor (inner: Object);}
class InvalidTableError extends DexieError {constructor (msg?: string, inner?: Object); constructor (inner: Object);}
class MissingAPIError extends DexieError {constructor (msg?: string, inner?: Object); constructor (inner: Object);}
class NoSuchDatabaseError extends DexieError {constructor (msg?: string, inner?: Object); constructor (inner: Object);}
class InvalidArgumentError extends DexieError {constructor (msg?: string, inner?: Object); constructor (inner: Object);}
class SubTransactionError extends DexieError {constructor (msg?: string, inner?: Object); constructor (inner: Object);}
class UnsupportedError extends DexieError {constructor (msg?: string, inner?: Object); constructor (inner: Object);}
class InternalError extends DexieError {constructor (msg?: string, inner?: Object); constructor (inner: Object);}
class DatabaseClosedError extends DexieError {constructor (msg?: string, inner?: Object); constructor (inner: Object);}
class IncompatiblePromiseError extends DexieError {constructor (msg?: string, inner?: Object); constructor (inner: Object);}
class UnknownError extends DexieError {constructor (msg?: string, inner?: Object); constructor (inner: Object);}
class ConstraintError extends DexieError {constructor (msg?: string, inner?: Object); constructor (inner: Object);}
class DataError extends DexieError {constructor (msg?: string, inner?: Object); constructor (inner: Object);}
class TransactionInactiveError extends DexieError {constructor (msg?: string, inner?: Object); constructor (inner: Object);}
class ReadOnlyError extends DexieError {constructor (msg?: string, inner?: Object); constructor (inner: Object);}
class VersionError extends DexieError {constructor (msg?: string, inner?: Object); constructor (inner: Object);}
class NotFoundError extends DexieError {constructor (msg?: string, inner?: Object); constructor (inner: Object);}
class InvalidStateError extends DexieError {constructor (msg?: string, inner?: Object); constructor (inner: Object);}
class InvalidAccessError extends DexieError {constructor (msg?: string, inner?: Object); constructor (inner: Object);}
class AbortError extends DexieError {constructor (msg?: string, inner?: Object); constructor (inner: Object);}
class TimeoutError extends DexieError {constructor (msg?: string, inner?: Object); constructor (inner: Object);}
class QuotaExceededError extends DexieError {constructor (msg?: string, inner?: Object); constructor (inner: Object);}
class SyntaxError extends DexieError {constructor (msg?: string, inner?: Object); constructor (inner: Object);}
class DataCloneError extends DexieError {constructor (msg?: string, inner?: Object); constructor (inner: Object);}
}
export default Dexie;