aboutsummaryrefslogtreecommitdiffstats
path: root/packages/renderer/src/stores/RendererEnv.ts
diff options
context:
space:
mode:
Diffstat (limited to 'packages/renderer/src/stores/RendererEnv.ts')
-rw-r--r--packages/renderer/src/stores/RendererEnv.ts37
1 files changed, 37 insertions, 0 deletions
diff --git a/packages/renderer/src/stores/RendererEnv.ts b/packages/renderer/src/stores/RendererEnv.ts
new file mode 100644
index 0000000..496ede6
--- /dev/null
+++ b/packages/renderer/src/stores/RendererEnv.ts
@@ -0,0 +1,37 @@
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 type { Action } from '@sophie/shared';
22import { getEnv as getAnyEnv, IAnyStateTreeNode } from 'mobx-state-tree';
23
24/**
25 * Gets a well-typed environment from `model`.
26 *
27 * Only useable inside state trees created by `createAndConnectRootStore`.
28 *
29 * @param model The state tree node.
30 */
31export function getEnv(model: IAnyStateTreeNode): RendererEnv {
32 return getAnyEnv<RendererEnv>(model);
33}
34
35export default interface RendererEnv {
36 dispatchMainAction(action: Action): void;
37}