aboutsummaryrefslogtreecommitdiff
path: root/types/ext/database.d.ts
blob: 641ced94259c09215a1dbe28b3b8a575b015e769 (plain)
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
/*
 * Copyright (C) 2023-2024  Yomitan Authors
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */

export type StructureDefinition<TObjectStoreName extends string> = {
    version: number;
    stores: {[name in TObjectStoreName]: StoreDefinition};
};

export type StoreDefinition = {
    primaryKey: IDBObjectStoreParameters;
    indices: string[];
};

export type UpdateFunction = (
    db: IDBDatabase,
    transaction: IDBTransaction,
    oldVersion: number,
    newVersion: number | null,
) => void;

export type CountTarget = [
    objectStoreOrIndex: IDBObjectStore | IDBIndex,
    query: IDBValidKey | IDBKeyRange | undefined,
];