summaryrefslogtreecommitdiffstats
path: root/cypress.d.ts
blob: 7dc9a3bde23ef344ad3f92c61090e0c29e9632bd (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
39
40
41
42
43
44
45
46
47
48
49
/**
 * @copyright Copyright (c) 2023 John Molakvoæ <skjnldsv@protonmail.com>
 *
 * @author John Molakvoæ <skjnldsv@protonmail.com>
 *
 * @license AGPL-3.0-or-later
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero 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 Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 *
 */
/* eslint-disable */
import { mount } from '@cypress/vue2'

type MountParams = Parameters<typeof mount>;
type OptionsParam = MountParams[1];

declare global {
	namespace Cypress {
		interface Chainable {
			mount: typeof mount;
			/**
			 * Mock an initial state for component testing
			 *
			 * @param app App name of the initial state
			 * @param key Key of the initial state
			 * @param value The mocked value of the initial state
			 */
			mockInitialState: (app: string, key: string, value: any) => void
			/**
			 * Unmock all initial states or one defined by app and key
			 *
			 * @param app app name of the inital state
			 * @param key the key of the the initial state
			 */
			unmockInitialState: (app?: string, key?: string) => void
		}
	}
}