aboutsummaryrefslogtreecommitdiffstats
path: root/packages/main/src/services/ConfigPersistence.ts
diff options
context:
space:
mode:
Diffstat (limited to 'packages/main/src/services/ConfigPersistence.ts')
-rw-r--r--packages/main/src/services/ConfigPersistence.ts36
1 files changed, 36 insertions, 0 deletions
diff --git a/packages/main/src/services/ConfigPersistence.ts b/packages/main/src/services/ConfigPersistence.ts
new file mode 100644
index 0000000..f9a82de
--- /dev/null
+++ b/packages/main/src/services/ConfigPersistence.ts
@@ -0,0 +1,36 @@
1/*
2 * Copyright (C) 2021-2022 Kristóf Marussy <kristof@marussy.com>
3 *
4 * This file is part of Sophie.
5 *
6 * Sophie is free software: you can redistribute it and/or modify
7 * it under the terms of the GNU Affero General Public License as
8 * published by the Free Software Foundation, version 3.
9 *
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU Affero General Public License for more details.
14 *
15 * You should have received a copy of the GNU Affero General Public License
16 * along with this program. If not, see <https://www.gnu.org/licenses/>.
17 *
18 * SPDX-License-Identifier: AGPL-3.0-only
19 */
20
21import { IDisposer } from 'mobx-state-tree';
22import ms from 'ms';
23
24import type { ConfigSnapshotOut } from '../stores/Config';
25
26export const CONFIG_DEBOUNCE_TIME: number = ms('1s');
27
28export type ReadConfigResult = { found: true; data: unknown; } | { found: false; };
29
30export interface ConfigPersistence {
31 readConfig(): Promise<ReadConfigResult>;
32
33 writeConfig(configSnapshot: ConfigSnapshotOut): Promise<Date>;
34
35 watchConfig(callback: (mtime: Date) => Promise<void>): IDisposer;
36}