aboutsummaryrefslogtreecommitdiffstats
path: root/packages/test-utils/src/fake.ts
diff options
context:
space:
mode:
Diffstat (limited to 'packages/test-utils/src/fake.ts')
-rw-r--r--packages/test-utils/src/fake.ts34
1 files changed, 34 insertions, 0 deletions
diff --git a/packages/test-utils/src/fake.ts b/packages/test-utils/src/fake.ts
new file mode 100644
index 0000000..57cfa88
--- /dev/null
+++ b/packages/test-utils/src/fake.ts
@@ -0,0 +1,34 @@
1/*
2 * Copyright (C) 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 { PartialDeep } from 'type-fest';
22
23/**
24 * Creates a fake object with some properties possibly missing.
25 *
26 * Interacting with missing properties will cause a test failure due to
27 * trying to access members of `undefined.`
28 *
29 * @param partialImplementation The partial fake implementation.
30 * @returns The same value as `partialImplementation` but with a casted type.
31 */
32export default function fake<T>(partialImplementation: PartialDeep<T>): T {
33 return partialImplementation as T;
34}