UNPKG

4.1 kBTypeScriptView Raw
1import type { Capabilities } from '@wdio/types';
2import type * as WebDriverTypes from 'webdriver';
3import SevereServiceErrorImport from './utils/SevereServiceError.js';
4import type { AttachOptions } from './types.js';
5export * from './types.js';
6export declare const Key: {
7 readonly Ctrl: "WDIO_CONTROL";
8 readonly NULL: "";
9 readonly Cancel: "";
10 readonly Help: "";
11 readonly Backspace: "";
12 readonly Tab: "";
13 readonly Clear: "";
14 readonly Return: "";
15 readonly Enter: "";
16 readonly Shift: "";
17 readonly Control: "";
18 readonly Alt: "";
19 readonly Pause: "";
20 readonly Escape: "";
21 readonly Space: "";
22 readonly PageUp: "";
23 readonly PageDown: "";
24 readonly End: "";
25 readonly Home: "";
26 readonly ArrowLeft: "";
27 readonly ArrowUp: "";
28 readonly ArrowRight: "";
29 readonly ArrowDown: "";
30 readonly Insert: "";
31 readonly Delete: "";
32 readonly Semicolon: "";
33 readonly Equals: "";
34 readonly Numpad0: "";
35 readonly Numpad1: "";
36 readonly Numpad2: "";
37 readonly Numpad3: "";
38 readonly Numpad4: "";
39 readonly Numpad5: "";
40 readonly Numpad6: "";
41 readonly Numpad7: "";
42 readonly Numpad8: "";
43 readonly Numpad9: "";
44 readonly Multiply: "";
45 readonly Add: "";
46 readonly Separator: "";
47 readonly Subtract: "";
48 readonly Decimal: "";
49 readonly Divide: "";
50 readonly F1: "";
51 readonly F2: "";
52 readonly F3: "";
53 readonly F4: "";
54 readonly F5: "";
55 readonly F6: "";
56 readonly F7: "";
57 readonly F8: "";
58 readonly F9: "";
59 readonly F10: "";
60 readonly F11: "";
61 readonly F12: "";
62 readonly Command: "";
63 readonly ZenkakuHankaku: "";
64};
65export declare const SevereServiceError: typeof SevereServiceErrorImport;
66/**
67 * A method to create a new session with WebdriverIO.
68 *
69 * <b>
70 * NOTE: If you hit "error TS2694: Namespace 'global.WebdriverIO' has no exported member 'Browser'" when using typescript,
71 * add "@wdio/globals/types" into tsconfig.json's "types" array will solve it: <code> { "compilerOptions": { "types": ["@wdio/globals/types"] } } </code>
72 * </b>
73 *
74 * @param params Options to create the session with
75 * @param remoteModifier Modifier function to change the monad object
76 * @return browser object with sessionId
77 * @see <a href="https://webdriver.io/docs/typescript">Typescript setup</a>
78 */
79export declare const remote: (params: Capabilities.WebdriverIOConfig, remoteModifier?: (client: WebDriverTypes.Client, options: Capabilities.WebdriverIOConfig) => WebDriverTypes.Client) => Promise<WebdriverIO.Browser>;
80export declare const attach: (attachOptions: AttachOptions) => Promise<WebdriverIO.Browser>;
81/**
82 * WebdriverIO allows you to run multiple automated sessions in a single test.
83 * This is handy when you're testing features that require multiple users (for example, chat or WebRTC applications).
84 *
85 * Instead of creating a couple of remote instances where you need to execute common commands like newSession() or url() on each instance,
86 * you can simply create a multiremote instance and control all browsers at the same time.
87 *
88 * <b>
89 * NOTE: Multiremote is not meant to execute all your tests in parallel.
90 * It is intended to help coordinate multiple browsers and/or mobile devices for special integration tests (e.g. chat applications).
91 * </b>
92 *
93 * @param params capabilities to choose desired devices.
94 * @param automationProtocol
95 * @return All remote instances, the first result represents the capability defined first in the capability object,
96 * the second result the second capability and so on.
97 *
98 * @see <a href="https://webdriver.io/docs/multiremote">External document and example usage</a>.
99 */
100export declare const multiremote: (params: Capabilities.RequestedMultiremoteCapabilities, { automationProtocol }?: {
101 automationProtocol?: string;
102}) => Promise<WebdriverIO.MultiRemoteBrowser>;
103//# sourceMappingURL=index.d.ts.map
\No newline at end of file