diff --git a/.gitignore b/.gitignore index 436246d..5ec4d1a 100644 --- a/.gitignore +++ b/.gitignore @@ -22,3 +22,5 @@ npm-debug.log* *storybook.log storybook-static tmp +.testplane +!exports diff --git a/clone-testplane.js b/clone-testplane.js new file mode 100644 index 0000000..795b33f --- /dev/null +++ b/clone-testplane.js @@ -0,0 +1,30 @@ +const { execSync } = require('child_process'); +const fs = require('fs'); +const path = require('path'); + +const LOCAL = process.env.LOCAL ?? false; +const LOCAL_REPO_DIR = process.env.LOCAL_REPO_DIR; +const REPO_PATH = process.env.REPO_PATH ?? "https://github.com/gemini-testing/testplane"; + +const tempDir = path.join(__dirname, '.testplane'); + +if (fs.existsSync(tempDir)) { + fs.rmSync(tempDir, { recursive: true }); +} + +if (LOCAL) { + // Create a symlink to the local repo + fs.symlinkSync(LOCAL_REPO_DIR, tempDir, 'dir'); + console.log(`Linked local testplane repo from ${LOCAL_REPO_DIR} to ${tempDir}`); +} else { + fs.mkdirSync(tempDir); + + // Clone repo to temp + execSync(`git clone ${REPO_PATH} ${tempDir}`); + process.chdir(tempDir); + + // Run npm ci to install dependencies + execSync('npm ci', { stdio: 'inherit' }); + + console.log(`Cloned remote testplane repo to ${tempDir}`); +} \ No newline at end of file diff --git a/docs/api-reference/README.mdx b/docs/api-reference/README.mdx new file mode 100644 index 0000000..bbdb385 --- /dev/null +++ b/docs/api-reference/README.mdx @@ -0,0 +1,81 @@ +# testplane + +## Classes + +| Class | Description | +| ------ | ------ | +| [AbortOnReconnectError](classes/AbortOnReconnectError.mdx) | - | +| [AssertViewError](classes/AssertViewError.mdx) | - | +| [CancelledError](classes/CancelledError.mdx) | - | +| [ClientBridgeError](classes/ClientBridgeError.mdx) | - | +| [Config](classes/Config.mdx) | - | +| [CoreError](classes/CoreError.mdx) | - | +| [HeightViewportError](classes/HeightViewportError.mdx) | Height of the element is larger than viewport | +| [ImageDiffError](classes/ImageDiffError.mdx) | - | +| [NoRefImageError](classes/NoRefImageError.mdx) | - | +| [OffsetViewportError](classes/OffsetViewportError.mdx) | Position of an element is outside of a viewport left, top or right bounds | +| [Suite](classes/Suite.mdx) | - | +| [Test](classes/Test.mdx) | - | +| [TestCollection](classes/TestCollection.mdx) | - | +| [Testplane](classes/Testplane.mdx) | - | +| [TestplaneInternalError](classes/TestplaneInternalError.mdx) | - | + +## Interfaces + +| Interface | Description | +| ------ | ------ | +| [AfterFileReadData](interfaces/AfterFileReadData.mdx) | - | +| [AssertViewOpts](interfaces/AssertViewOpts.mdx) | - | +| [AssertViewOptsConfig](interfaces/AssertViewOptsConfig.mdx) | - | +| [AssertViewResultDiff](interfaces/AssertViewResultDiff.mdx) | - | +| [AssertViewResultNoRefImage](interfaces/AssertViewResultNoRefImage.mdx) | - | +| [AssertViewResultSuccess](interfaces/AssertViewResultSuccess.mdx) | - | +| [BeforeFileReadData](interfaces/BeforeFileReadData.mdx) | - | +| [BrowserHistory](interfaces/BrowserHistory.mdx) | - | +| [BrowserInfo](interfaces/BrowserInfo.mdx) | - | +| [BuildDiffOptsConfig](interfaces/BuildDiffOptsConfig.mdx) | - | +| [CommandHistory](interfaces/CommandHistory.mdx) | - | +| [CommonConfig](interfaces/CommonConfig.mdx) | - | +| [CompareOptsConfig](interfaces/CompareOptsConfig.mdx) | - | +| [DiffOptions](interfaces/DiffOptions.mdx) | - | +| [ErrorDetails](interfaces/ErrorDetails.mdx) | - | +| [ExecutionThreadToolCtx](interfaces/ExecutionThreadToolCtx.mdx) | - | +| [ExpectOptsConfig](interfaces/ExpectOptsConfig.mdx) | - | +| [GlobalHelper](interfaces/GlobalHelper.mdx) | - | +| [HermioneCtx](interfaces/HermioneCtx.mdx) | - | +| [ImageBase64](interfaces/ImageBase64.mdx) | - | +| [ImageInfo](interfaces/ImageInfo.mdx) | - | +| [ImageSize](interfaces/ImageSize.mdx) | - | +| [InterceptData](interfaces/InterceptData.mdx) | - | +| [MochaOpts](interfaces/MochaOpts.mdx) | - | +| [ReadTestsOpts](interfaces/ReadTestsOpts.mdx) | - | +| [RefImageInfo](interfaces/RefImageInfo.mdx) | - | +| [RootSuite](interfaces/RootSuite.mdx) | - | +| [RunOpts](interfaces/RunOpts.mdx) | - | +| [SetsConfig](interfaces/SetsConfig.mdx) | - | +| [SystemConfig](interfaces/SystemConfig.mdx) | - | +| [TestError](interfaces/TestError.mdx) | - | +| [TestFunctionCtx](interfaces/TestFunctionCtx.mdx) | - | +| [TestResult](interfaces/TestResult.mdx) | - | +| [TestResultWithRetries](interfaces/TestResultWithRetries.mdx) | - | +| [TestplaneCtx](interfaces/TestplaneCtx.mdx) | - | +| [WdioBrowser](interfaces/WdioBrowser.mdx) | - | + +## Type Aliases + +| Type alias | Description | +| ------ | ------ | +| [AssertViewResult](type-aliases/AssertViewResult.mdx) | - | +| [AsyncSessionEventCallback](type-aliases/AsyncSessionEventCallback.mdx) | - | +| [ConfigInput](type-aliases/ConfigInput.mdx) | - | +| [InterceptHandler](type-aliases/InterceptHandler.mdx) | - | +| [InterceptedEvent](type-aliases/InterceptedEvent.mdx) | - | +| [MasterEventHandler](type-aliases/MasterEventHandler.mdx) | - | +| [SyncSessionEventCallback](type-aliases/SyncSessionEventCallback.mdx) | - | +| [WorkerEventHandler](type-aliases/WorkerEventHandler.mdx) | - | + +## Variables + +| Variable | Description | +| ------ | ------ | +| [Key](variables/Key.mdx) | - | diff --git a/docs/api-reference/classes/AbortOnReconnectError.mdx b/docs/api-reference/classes/AbortOnReconnectError.mdx new file mode 100644 index 0000000..401b43d --- /dev/null +++ b/docs/api-reference/classes/AbortOnReconnectError.mdx @@ -0,0 +1,66 @@ +[testplane](../README.mdx) / AbortOnReconnectError + +# Class: AbortOnReconnectError + +## Extends + +- `Error` + +## Constructors + +### new AbortOnReconnectError() + +```ts +new AbortOnReconnectError(): AbortOnReconnectError +``` + +#### Returns + +[`AbortOnReconnectError`](AbortOnReconnectError.mdx) + +#### Overrides + +`Error.constructor` + +#### Defined in + +testplane-docs/.testplane/src/errors/abort-on-reconnect-error.ts:2 + +## Properties + +| Property | Modifier | Type | Description | Inherited from | Defined in | +| ------ | ------ | ------ | ------ | ------ | ------ | +| `message` | `public` | `string` | - | `Error.message` | testplane-docs/node\_modules/typescript/lib/lib.es5.d.ts:1077 | +| `name` | `public` | `string` | - | `Error.name` | testplane-docs/node\_modules/typescript/lib/lib.es5.d.ts:1076 | +| `stack?` | `public` | `string` | - | `Error.stack` | testplane-docs/node\_modules/typescript/lib/lib.es5.d.ts:1078 | +| `prepareStackTrace?` | `static` | (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` | Optional override for formatting stack traces **See** https://v8.dev/docs/stack-trace-api#customizing-stack-traces | `Error.prepareStackTrace` | testplane/node\_modules/@types/node/globals.d.ts:27 | +| `stackTraceLimit` | `static` | `number` | - | `Error.stackTraceLimit` | testplane/node\_modules/@types/node/globals.d.ts:29 | + +## Methods + +### captureStackTrace() + +```ts +static captureStackTrace(targetObject, constructorOpt?): void +``` + +Create .stack property on a target object + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `targetObject` | `object` | +| `constructorOpt`? | `Function` | + +#### Returns + +`void` + +#### Inherited from + +`Error.captureStackTrace` + +#### Defined in + +testplane/node\_modules/@types/node/globals.d.ts:20 diff --git a/docs/api-reference/classes/AssertViewError.mdx b/docs/api-reference/classes/AssertViewError.mdx new file mode 100644 index 0000000..61953ce --- /dev/null +++ b/docs/api-reference/classes/AssertViewError.mdx @@ -0,0 +1,72 @@ +[testplane](../README.mdx) / AssertViewError + +# Class: AssertViewError + +## Extends + +- `Error` + +## Constructors + +### new AssertViewError() + +```ts +new AssertViewError(message): AssertViewError +``` + +#### Parameters + +| Parameter | Type | Default value | +| ------ | ------ | ------ | +| `message` | `string` | `"image comparison failed"` | + +#### Returns + +[`AssertViewError`](AssertViewError.mdx) + +#### Overrides + +`Error.constructor` + +#### Defined in + +testplane-docs/.testplane/src/browser/commands/assert-view/errors/assert-view-error.ts:2 + +## Properties + +| Property | Modifier | Type | Default value | Description | Inherited from | Defined in | +| ------ | ------ | ------ | ------ | ------ | ------ | ------ | +| `message` | `public` | `string` | `"image comparison failed"` | - | `Error.message` | testplane-docs/.testplane/src/browser/commands/assert-view/errors/assert-view-error.ts:2 | +| `name` | `public` | `string` | `undefined` | - | `Error.name` | testplane-docs/node\_modules/typescript/lib/lib.es5.d.ts:1076 | +| `stack?` | `public` | `string` | `undefined` | - | `Error.stack` | testplane-docs/node\_modules/typescript/lib/lib.es5.d.ts:1078 | +| `prepareStackTrace?` | `static` | (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` | `undefined` | Optional override for formatting stack traces **See** https://v8.dev/docs/stack-trace-api#customizing-stack-traces | `Error.prepareStackTrace` | testplane/node\_modules/@types/node/globals.d.ts:27 | +| `stackTraceLimit` | `static` | `number` | `undefined` | - | `Error.stackTraceLimit` | testplane/node\_modules/@types/node/globals.d.ts:29 | + +## Methods + +### captureStackTrace() + +```ts +static captureStackTrace(targetObject, constructorOpt?): void +``` + +Create .stack property on a target object + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `targetObject` | `object` | +| `constructorOpt`? | `Function` | + +#### Returns + +`void` + +#### Inherited from + +`Error.captureStackTrace` + +#### Defined in + +testplane/node\_modules/@types/node/globals.d.ts:20 diff --git a/docs/api-reference/classes/CancelledError.mdx b/docs/api-reference/classes/CancelledError.mdx new file mode 100644 index 0000000..63af97f --- /dev/null +++ b/docs/api-reference/classes/CancelledError.mdx @@ -0,0 +1,66 @@ +[testplane](../README.mdx) / CancelledError + +# Class: CancelledError + +## Extends + +- `Error` + +## Constructors + +### new CancelledError() + +```ts +new CancelledError(): CancelledError +``` + +#### Returns + +[`CancelledError`](CancelledError.mdx) + +#### Overrides + +`Error.constructor` + +#### Defined in + +testplane-docs/.testplane/src/browser-pool/cancelled-error.ts:5 + +## Properties + +| Property | Modifier | Type | Default value | Description | Overrides | Inherited from | Defined in | +| ------ | ------ | ------ | ------ | ------ | ------ | ------ | ------ | +| `message` | `public` | `string` | `"Browser request was cancelled"` | - | `Error.message` | - | testplane-docs/.testplane/src/browser-pool/cancelled-error.ts:3 | +| `name` | `public` | `string` | `"CancelledError"` | - | `Error.name` | - | testplane-docs/.testplane/src/browser-pool/cancelled-error.ts:2 | +| `stack?` | `public` | `string` | `undefined` | - | - | `Error.stack` | testplane-docs/node\_modules/typescript/lib/lib.es5.d.ts:1078 | +| `prepareStackTrace?` | `static` | (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` | `undefined` | Optional override for formatting stack traces **See** https://v8.dev/docs/stack-trace-api#customizing-stack-traces | - | `Error.prepareStackTrace` | testplane/node\_modules/@types/node/globals.d.ts:27 | +| `stackTraceLimit` | `static` | `number` | `undefined` | - | - | `Error.stackTraceLimit` | testplane/node\_modules/@types/node/globals.d.ts:29 | + +## Methods + +### captureStackTrace() + +```ts +static captureStackTrace(targetObject, constructorOpt?): void +``` + +Create .stack property on a target object + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `targetObject` | `object` | +| `constructorOpt`? | `Function` | + +#### Returns + +`void` + +#### Inherited from + +`Error.captureStackTrace` + +#### Defined in + +testplane/node\_modules/@types/node/globals.d.ts:20 diff --git a/docs/api-reference/classes/ClientBridgeError.mdx b/docs/api-reference/classes/ClientBridgeError.mdx new file mode 100644 index 0000000..847e218 --- /dev/null +++ b/docs/api-reference/classes/ClientBridgeError.mdx @@ -0,0 +1,72 @@ +[testplane](../README.mdx) / ClientBridgeError + +# Class: ClientBridgeError + +## Extends + +- `Error` + +## Constructors + +### new ClientBridgeError() + +```ts +new ClientBridgeError(message): ClientBridgeError +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +#### Returns + +[`ClientBridgeError`](ClientBridgeError.mdx) + +#### Overrides + +`Error.constructor` + +#### Defined in + +testplane-docs/.testplane/src/browser/client-bridge/error.ts:2 + +## Properties + +| Property | Modifier | Type | Description | Inherited from | Defined in | +| ------ | ------ | ------ | ------ | ------ | ------ | +| `message` | `public` | `string` | - | `Error.message` | testplane-docs/node\_modules/typescript/lib/lib.es5.d.ts:1077 | +| `name` | `public` | `string` | - | `Error.name` | testplane-docs/node\_modules/typescript/lib/lib.es5.d.ts:1076 | +| `stack?` | `public` | `string` | - | `Error.stack` | testplane-docs/node\_modules/typescript/lib/lib.es5.d.ts:1078 | +| `prepareStackTrace?` | `static` | (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` | Optional override for formatting stack traces **See** https://v8.dev/docs/stack-trace-api#customizing-stack-traces | `Error.prepareStackTrace` | testplane/node\_modules/@types/node/globals.d.ts:27 | +| `stackTraceLimit` | `static` | `number` | - | `Error.stackTraceLimit` | testplane/node\_modules/@types/node/globals.d.ts:29 | + +## Methods + +### captureStackTrace() + +```ts +static captureStackTrace(targetObject, constructorOpt?): void +``` + +Create .stack property on a target object + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `targetObject` | `object` | +| `constructorOpt`? | `Function` | + +#### Returns + +`void` + +#### Inherited from + +`Error.captureStackTrace` + +#### Defined in + +testplane/node\_modules/@types/node/globals.d.ts:20 diff --git a/docs/api-reference/classes/Config.mdx b/docs/api-reference/classes/Config.mdx new file mode 100644 index 0000000..1f84ebd --- /dev/null +++ b/docs/api-reference/classes/Config.mdx @@ -0,0 +1,307 @@ +[testplane](../README.mdx) / Config + +# Class: Config + +## Extends + +- [`CommonConfig`](../interfaces/CommonConfig.mdx) + +## Constructors + +### new Config() + +```ts +new Config(config?): Config +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `config`? | `string` \| [`ConfigInput`](../type-aliases/ConfigInput.mdx) | + +#### Returns + +[`Config`](Config.mdx) + +#### Defined in + +testplane-docs/.testplane/src/config/index.ts:28 + +## Properties + +| Property | Type | Inherited from | Defined in | +| ------ | ------ | ------ | ------ | +| `antialiasingTolerance` | `number` | [`CommonConfig`](../interfaces/CommonConfig.mdx).`antialiasingTolerance` | testplane-docs/.testplane/src/config/types.ts:133 | +| `assertViewOpts` | [`AssertViewOptsConfig`](../interfaces/AssertViewOptsConfig.mdx) | [`CommonConfig`](../interfaces/CommonConfig.mdx).`assertViewOpts` | testplane-docs/.testplane/src/config/types.ts:136 | +| `automationProtocol` | `"webdriver"` \| `"devtools"` | [`CommonConfig`](../interfaces/CommonConfig.mdx).`automationProtocol` | testplane-docs/.testplane/src/config/types.ts:97 | +| `baseUrl` | `string` | [`CommonConfig`](../interfaces/CommonConfig.mdx).`baseUrl` | testplane-docs/.testplane/src/config/types.ts:104 | +| `browsers` | `Record`\<`string`, `BrowserConfig`\> | - | testplane-docs/.testplane/src/config/types.ts:213 | +| `buildDiffOpts` | [`BuildDiffOptsConfig`](../interfaces/BuildDiffOptsConfig.mdx) | [`CommonConfig`](../interfaces/CommonConfig.mdx).`buildDiffOpts` | testplane-docs/.testplane/src/config/types.ts:135 | +| `calibrate` | `boolean` | [`CommonConfig`](../interfaces/CommonConfig.mdx).`calibrate` | testplane-docs/.testplane/src/config/types.ts:127 | +| `compareOpts` | [`CompareOptsConfig`](../interfaces/CompareOptsConfig.mdx) | [`CommonConfig`](../interfaces/CommonConfig.mdx).`compareOpts` | testplane-docs/.testplane/src/config/types.ts:134 | +| `compositeImage` | `boolean` | [`CommonConfig`](../interfaces/CommonConfig.mdx).`compositeImage` | testplane-docs/.testplane/src/config/types.ts:128 | +| `configPath` | `string` | [`CommonConfig`](../interfaces/CommonConfig.mdx).`configPath` | testplane-docs/.testplane/src/config/index.ts:10 | +| `desiredCapabilities` | `null` \| `Capabilities` | [`CommonConfig`](../interfaces/CommonConfig.mdx).`desiredCapabilities` | testplane-docs/.testplane/src/config/types.ts:98 | +| `devServer` | \{ `args`: `string`[]; `command`: `null` \| `string`; `cwd`: `null` \| `string`; `env`: `Record`\<`string`, `string`\>; `logs`: `boolean`; `readinessProbe`: `ReadinessProbe`; \} | [`CommonConfig`](../interfaces/CommonConfig.mdx).`devServer` | testplane-docs/.testplane/src/config/types.ts:170 | +| `devServer.args` | `string`[] | - | testplane-docs/.testplane/src/config/types.ts:174 | +| `devServer.command` | `null` \| `string` | - | testplane-docs/.testplane/src/config/types.ts:171 | +| `devServer.cwd` | `null` \| `string` | - | testplane-docs/.testplane/src/config/types.ts:172 | +| `devServer.env` | `Record`\<`string`, `string`\> | - | testplane-docs/.testplane/src/config/types.ts:173 | +| `devServer.logs` | `boolean` | - | testplane-docs/.testplane/src/config/types.ts:175 | +| `devServer.readinessProbe` | `ReadinessProbe` | - | testplane-docs/.testplane/src/config/types.ts:176 | +| `expectOpts` | [`ExpectOptsConfig`](../interfaces/ExpectOptsConfig.mdx) | [`CommonConfig`](../interfaces/CommonConfig.mdx).`expectOpts` | testplane-docs/.testplane/src/config/types.ts:137 | +| `gridUrl` | `string` | [`CommonConfig`](../interfaces/CommonConfig.mdx).`gridUrl` | testplane-docs/.testplane/src/config/types.ts:103 | +| `headers` | `null` \| `Record`\<`string`, `string`\> | [`CommonConfig`](../interfaces/CommonConfig.mdx).`headers` | testplane-docs/.testplane/src/config/types.ts:142 | +| `headless` | `null` \| `boolean` \| `"old"` \| `"new"` | [`CommonConfig`](../interfaces/CommonConfig.mdx).`headless` | testplane-docs/.testplane/src/config/types.ts:153 | +| `httpTimeout` | `number` | [`CommonConfig`](../interfaces/CommonConfig.mdx).`httpTimeout` | testplane-docs/.testplane/src/config/types.ts:109 | +| `isolation` | `boolean` | [`CommonConfig`](../interfaces/CommonConfig.mdx).`isolation` | testplane-docs/.testplane/src/config/types.ts:154 | +| `key` | `null` \| `string` | [`CommonConfig`](../interfaces/CommonConfig.mdx).`key` | testplane-docs/.testplane/src/config/types.ts:149 | +| `lastFailed` | \{ `input`: `string` \| `string`[]; `only`: `boolean`; `output`: `string`; \} | [`CommonConfig`](../interfaces/CommonConfig.mdx).`lastFailed` | testplane-docs/.testplane/src/config/types.ts:156 | +| `lastFailed.input` | `string` \| `string`[] | - | testplane-docs/.testplane/src/config/types.ts:158 | +| `lastFailed.only` | `boolean` | - | testplane-docs/.testplane/src/config/types.ts:157 | +| `lastFailed.output` | `string` | - | testplane-docs/.testplane/src/config/types.ts:159 | +| `meta` | \{\} | [`CommonConfig`](../interfaces/CommonConfig.mdx).`meta` | testplane-docs/.testplane/src/config/types.ts:138 | +| `openAndWaitOpts` | \{ `failOnNetworkError`: `boolean`; `ignoreNetworkErrorsPatterns`: (`string` \| `RegExp`)[]; `timeout`: `number`; `waitNetworkIdle`: `boolean`; `waitNetworkIdleTimeout`: `number`; \} | [`CommonConfig`](../interfaces/CommonConfig.mdx).`openAndWaitOpts` | testplane-docs/.testplane/src/config/types.ts:162 | +| `openAndWaitOpts.failOnNetworkError` | `boolean` | - | testplane-docs/.testplane/src/config/types.ts:166 | +| `openAndWaitOpts.ignoreNetworkErrorsPatterns` | (`string` \| `RegExp`)[] | - | testplane-docs/.testplane/src/config/types.ts:167 | +| `openAndWaitOpts.timeout?` | `number` | - | testplane-docs/.testplane/src/config/types.ts:163 | +| `openAndWaitOpts.waitNetworkIdle` | `boolean` | - | testplane-docs/.testplane/src/config/types.ts:164 | +| `openAndWaitOpts.waitNetworkIdleTimeout` | `number` | - | testplane-docs/.testplane/src/config/types.ts:165 | +| `orientation` | `null` \| `"landscape"` \| `"portrait"` | [`CommonConfig`](../interfaces/CommonConfig.mdx).`orientation` | testplane-docs/.testplane/src/config/types.ts:140 | +| `pageLoadTimeout` | `null` \| `number` | [`CommonConfig`](../interfaces/CommonConfig.mdx).`pageLoadTimeout` | testplane-docs/.testplane/src/config/types.ts:111 | +| `plugins` | `Record`\<`string`, `Record`\<`string`, `unknown`\>\> | - | testplane-docs/.testplane/src/config/types.ts:214 | +| `prepareEnvironment?` | () => `null` \| `void` | - | testplane-docs/.testplane/src/config/types.ts:216 | +| `region` | `null` \| `string` | [`CommonConfig`](../interfaces/CommonConfig.mdx).`region` | testplane-docs/.testplane/src/config/types.ts:150 | +| `resetCursor` | `boolean` | [`CommonConfig`](../interfaces/CommonConfig.mdx).`resetCursor` | testplane-docs/.testplane/src/config/types.ts:141 | +| `retry` | `number` | [`CommonConfig`](../interfaces/CommonConfig.mdx).`retry` | testplane-docs/.testplane/src/config/types.ts:107 | +| `saveHistoryMode` | `"all"` \| `"none"` \| `"onlyFailed"` | [`CommonConfig`](../interfaces/CommonConfig.mdx).`saveHistoryMode` | testplane-docs/.testplane/src/config/types.ts:117 | +| `screenshotDelay` | `number` | [`CommonConfig`](../interfaces/CommonConfig.mdx).`screenshotDelay` | testplane-docs/.testplane/src/config/types.ts:131 | +| `screenshotMode` | `"auto"` \| `"fullpage"` \| `"viewport"` | [`CommonConfig`](../interfaces/CommonConfig.mdx).`screenshotMode` | testplane-docs/.testplane/src/config/types.ts:130 | +| `screenshotPath` | `null` \| `string` | [`CommonConfig`](../interfaces/CommonConfig.mdx).`screenshotPath` | testplane-docs/.testplane/src/config/types.ts:125 | +| `sessionEnvFlags` | `Record`\< \| `"isW3C"` \| `"isAndroid"` \| `"isMobile"` \| `"isIOS"` \| `"isSauce"` \| `"isSeleniumStandalone"` \| `"isChrome"`, `boolean`\> | [`CommonConfig`](../interfaces/CommonConfig.mdx).`sessionEnvFlags` | testplane-docs/.testplane/src/config/types.ts:99 | +| `sessionQuitTimeout` | `null` \| `number` | [`CommonConfig`](../interfaces/CommonConfig.mdx).`sessionQuitTimeout` | testplane-docs/.testplane/src/config/types.ts:113 | +| `sessionRequestTimeout` | `null` \| `number` | [`CommonConfig`](../interfaces/CommonConfig.mdx).`sessionRequestTimeout` | testplane-docs/.testplane/src/config/types.ts:112 | +| `sessionsPerBrowser` | `number` | [`CommonConfig`](../interfaces/CommonConfig.mdx).`sessionsPerBrowser` | testplane-docs/.testplane/src/config/types.ts:105 | +| `sets` | `Record`\<`string`, `SetsConfigParsed`\> | - | testplane-docs/.testplane/src/config/types.ts:215 | +| `strictSSL` | `null` \| `boolean` | [`CommonConfig`](../interfaces/CommonConfig.mdx).`strictSSL` | testplane-docs/.testplane/src/config/types.ts:147 | +| `strictTestsOrder` | `boolean` | [`CommonConfig`](../interfaces/CommonConfig.mdx).`strictTestsOrder` | testplane-docs/.testplane/src/config/types.ts:129 | +| `system` | [`SystemConfig`](../interfaces/SystemConfig.mdx) | [`CommonConfig`](../interfaces/CommonConfig.mdx).`system` | testplane-docs/.testplane/src/config/types.ts:152 | +| `takeScreenshotOnFails` | \{ `assertViewFail`: `boolean`; `testFail`: `boolean`; \} | [`CommonConfig`](../interfaces/CommonConfig.mdx).`takeScreenshotOnFails` | testplane-docs/.testplane/src/config/types.ts:118 | +| `takeScreenshotOnFails.assertViewFail` | `boolean` | - | testplane-docs/.testplane/src/config/types.ts:120 | +| `takeScreenshotOnFails.testFail` | `boolean` | - | testplane-docs/.testplane/src/config/types.ts:119 | +| `takeScreenshotOnFailsMode` | `"fullpage"` \| `"viewport"` | [`CommonConfig`](../interfaces/CommonConfig.mdx).`takeScreenshotOnFailsMode` | testplane-docs/.testplane/src/config/types.ts:123 | +| `takeScreenshotOnFailsTimeout` | `null` \| `number` | [`CommonConfig`](../interfaces/CommonConfig.mdx).`takeScreenshotOnFailsTimeout` | testplane-docs/.testplane/src/config/types.ts:122 | +| `testTimeout` | `null` \| `number` | [`CommonConfig`](../interfaces/CommonConfig.mdx).`testTimeout` | testplane-docs/.testplane/src/config/types.ts:114 | +| `testsPerSession` | `number` | [`CommonConfig`](../interfaces/CommonConfig.mdx).`testsPerSession` | testplane-docs/.testplane/src/config/types.ts:106 | +| `tolerance` | `number` | [`CommonConfig`](../interfaces/CommonConfig.mdx).`tolerance` | testplane-docs/.testplane/src/config/types.ts:132 | +| `transformRequest` | (`req`: `RequestOptions`) => `RequestOptions` | [`CommonConfig`](../interfaces/CommonConfig.mdx).`transformRequest` | testplane-docs/.testplane/src/config/types.ts:144 | +| `transformResponse` | (`res`: `Response`, `req`: `RequestOptions`) => `Response` | [`CommonConfig`](../interfaces/CommonConfig.mdx).`transformResponse` | testplane-docs/.testplane/src/config/types.ts:145 | +| `urlHttpTimeout` | `null` \| `number` | [`CommonConfig`](../interfaces/CommonConfig.mdx).`urlHttpTimeout` | testplane-docs/.testplane/src/config/types.ts:110 | +| `user` | `null` \| `string` | [`CommonConfig`](../interfaces/CommonConfig.mdx).`user` | testplane-docs/.testplane/src/config/types.ts:148 | +| `waitInterval` | `number` | [`CommonConfig`](../interfaces/CommonConfig.mdx).`waitInterval` | testplane-docs/.testplane/src/config/types.ts:116 | +| `waitTimeout` | `number` | [`CommonConfig`](../interfaces/CommonConfig.mdx).`waitTimeout` | testplane-docs/.testplane/src/config/types.ts:115 | +| `windowSize` | `null` \| `string` \| \{ `height`: `number`; `width`: `number`; \} | [`CommonConfig`](../interfaces/CommonConfig.mdx).`windowSize` | testplane-docs/.testplane/src/config/types.ts:139 | + +## Methods + +### forBrowser() + +```ts +forBrowser(id): BrowserConfig +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `id` | `string` | + +#### Returns + +`BrowserConfig` + +#### Defined in + +testplane-docs/.testplane/src/config/index.ts:82 + +*** + +### getBrowserIds() + +```ts +getBrowserIds(): string[] +``` + +#### Returns + +`string`[] + +#### Defined in + +testplane-docs/.testplane/src/config/index.ts:86 + +*** + +### mergeWith() + +```ts +mergeWith(config): void +``` + +This method is used in subrocesses to merge a created config +in a subrocess with a config from the main process + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `config` | [`Config`](Config.mdx) | + +#### Returns + +`void` + +#### Defined in + +testplane-docs/.testplane/src/config/index.ts:100 + +*** + +### prepareBrowser() + +```ts +prepareBrowser(browser): null | void +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `browser` | `Browser` | + +#### Returns + +`null` \| `void` + +#### Inherited from + +[`CommonConfig`](../interfaces/CommonConfig.mdx).[`prepareBrowser`](../interfaces/CommonConfig.mdx#preparebrowser) + +#### Defined in + +testplane-docs/.testplane/src/config/types.ts:124 + +*** + +### screenshotsDir() + +```ts +screenshotsDir(test): string +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `test` | [`Test`](Test.mdx) | + +#### Returns + +`string` + +#### Inherited from + +[`CommonConfig`](../interfaces/CommonConfig.mdx).[`screenshotsDir`](../interfaces/CommonConfig.mdx#screenshotsdir) + +#### Defined in + +testplane-docs/.testplane/src/config/types.ts:126 + +*** + +### serialize() + +```ts +serialize(): Omit +``` + +#### Returns + +`Omit`\<[`Config`](Config.mdx), `"system"`\> + +#### Defined in + +testplane-docs/.testplane/src/config/index.ts:90 + +*** + +### shouldRetry() + +```ts +shouldRetry(testInfo): null | boolean +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `testInfo` | `object` | +| `testInfo.ctx` | [`Test`](Test.mdx) | +| `testInfo.retriesLeft` | `number` | + +#### Returns + +`null` \| `boolean` + +#### Inherited from + +[`CommonConfig`](../interfaces/CommonConfig.mdx).[`shouldRetry`](../interfaces/CommonConfig.mdx#shouldretry) + +#### Defined in + +testplane-docs/.testplane/src/config/types.ts:108 + +*** + +### create() + +```ts +static create(config?): Config +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `config`? | `string` \| [`ConfigInput`](../type-aliases/ConfigInput.mdx) | + +#### Returns + +[`Config`](Config.mdx) + +#### Defined in + +testplane-docs/.testplane/src/config/index.ts:12 + +*** + +### read() + +```ts +static read(configPath): unknown +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `configPath` | `string` | + +#### Returns + +`unknown` + +#### Defined in + +testplane-docs/.testplane/src/config/index.ts:16 diff --git a/docs/api-reference/classes/CoreError.mdx b/docs/api-reference/classes/CoreError.mdx new file mode 100644 index 0000000..44c3855 --- /dev/null +++ b/docs/api-reference/classes/CoreError.mdx @@ -0,0 +1,72 @@ +[testplane](../README.mdx) / CoreError + +# Class: CoreError + +## Extends + +- `Error` + +## Constructors + +### new CoreError() + +```ts +new CoreError(message): CoreError +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +#### Returns + +[`CoreError`](CoreError.mdx) + +#### Overrides + +`Error.constructor` + +#### Defined in + +testplane-docs/.testplane/src/browser/core-error.ts:4 + +## Properties + +| Property | Modifier | Type | Default value | Description | Overrides | Inherited from | Defined in | +| ------ | ------ | ------ | ------ | ------ | ------ | ------ | ------ | +| `message` | `public` | `string` | `undefined` | - | - | `Error.message` | testplane-docs/node\_modules/typescript/lib/lib.es5.d.ts:1077 | +| `name` | `public` | `string` | `"CoreError"` | - | `Error.name` | - | testplane-docs/.testplane/src/browser/core-error.ts:2 | +| `stack?` | `public` | `string` | `undefined` | - | - | `Error.stack` | testplane-docs/node\_modules/typescript/lib/lib.es5.d.ts:1078 | +| `prepareStackTrace?` | `static` | (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` | `undefined` | Optional override for formatting stack traces **See** https://v8.dev/docs/stack-trace-api#customizing-stack-traces | - | `Error.prepareStackTrace` | testplane/node\_modules/@types/node/globals.d.ts:27 | +| `stackTraceLimit` | `static` | `number` | `undefined` | - | - | `Error.stackTraceLimit` | testplane/node\_modules/@types/node/globals.d.ts:29 | + +## Methods + +### captureStackTrace() + +```ts +static captureStackTrace(targetObject, constructorOpt?): void +``` + +Create .stack property on a target object + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `targetObject` | `object` | +| `constructorOpt`? | `Function` | + +#### Returns + +`void` + +#### Inherited from + +`Error.captureStackTrace` + +#### Defined in + +testplane/node\_modules/@types/node/globals.d.ts:20 diff --git a/docs/api-reference/classes/HeightViewportError.mdx b/docs/api-reference/classes/HeightViewportError.mdx new file mode 100644 index 0000000..b88842b --- /dev/null +++ b/docs/api-reference/classes/HeightViewportError.mdx @@ -0,0 +1,74 @@ +[testplane](../README.mdx) / HeightViewportError + +# Class: HeightViewportError + +Height of the element is larger than viewport + +## Extends + +- `Error` + +## Constructors + +### new HeightViewportError() + +```ts +new HeightViewportError(message): HeightViewportError +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +#### Returns + +[`HeightViewportError`](HeightViewportError.mdx) + +#### Overrides + +`Error.constructor` + +#### Defined in + +testplane-docs/.testplane/src/browser/screen-shooter/viewport/coord-validator/errors/height-viewport-error.ts:5 + +## Properties + +| Property | Modifier | Type | Description | Inherited from | Defined in | +| ------ | ------ | ------ | ------ | ------ | ------ | +| `message` | `public` | `string` | - | `Error.message` | testplane-docs/node\_modules/typescript/lib/lib.es5.d.ts:1077 | +| `name` | `public` | `string` | - | `Error.name` | testplane-docs/node\_modules/typescript/lib/lib.es5.d.ts:1076 | +| `stack?` | `public` | `string` | - | `Error.stack` | testplane-docs/node\_modules/typescript/lib/lib.es5.d.ts:1078 | +| `prepareStackTrace?` | `static` | (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` | Optional override for formatting stack traces **See** https://v8.dev/docs/stack-trace-api#customizing-stack-traces | `Error.prepareStackTrace` | testplane/node\_modules/@types/node/globals.d.ts:27 | +| `stackTraceLimit` | `static` | `number` | - | `Error.stackTraceLimit` | testplane/node\_modules/@types/node/globals.d.ts:29 | + +## Methods + +### captureStackTrace() + +```ts +static captureStackTrace(targetObject, constructorOpt?): void +``` + +Create .stack property on a target object + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `targetObject` | `object` | +| `constructorOpt`? | `Function` | + +#### Returns + +`void` + +#### Inherited from + +`Error.captureStackTrace` + +#### Defined in + +testplane/node\_modules/@types/node/globals.d.ts:20 diff --git a/docs/api-reference/classes/ImageDiffError.mdx b/docs/api-reference/classes/ImageDiffError.mdx new file mode 100644 index 0000000..c495631 --- /dev/null +++ b/docs/api-reference/classes/ImageDiffError.mdx @@ -0,0 +1,177 @@ +[testplane](../README.mdx) / ImageDiffError + +# Class: ImageDiffError + +## Extends + +- `BaseStateError` + +## Constructors + +### new ImageDiffError() + +```ts +new ImageDiffError(__namedParameters): ImageDiffError +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `object` | +| `__namedParameters.currImg` | [`ImageInfo`](../interfaces/ImageInfo.mdx) | +| `__namedParameters.diffAreas`? | `DiffAreas` | +| `__namedParameters.diffBuffer` | `Buffer` | +| `__namedParameters.diffOpts` | `DiffOptions` | +| `__namedParameters.diffRatio` | `number` | +| `__namedParameters.differentPixels` | `number` | +| `__namedParameters.refImg` | [`RefImageInfo`](../interfaces/RefImageInfo.mdx) | +| `__namedParameters.stateName` | `string` | + +#### Returns + +[`ImageDiffError`](ImageDiffError.mdx) + +#### Overrides + +`BaseStateError.constructor` + +#### Defined in + +testplane-docs/.testplane/src/browser/commands/assert-view/errors/image-diff-error.ts:79 + +## Properties + +| Property | Modifier | Type | Description | Overrides | Inherited from | Defined in | +| ------ | ------ | ------ | ------ | ------ | ------ | ------ | +| `currImg` | `public` | [`ImageInfo`](../interfaces/ImageInfo.mdx) | - | - | `BaseStateError.currImg` | testplane-docs/.testplane/src/browser/commands/assert-view/errors/base-state-error.ts:4 | +| `diffBounds?` | `public` | `CoordBounds` | - | - | - | testplane-docs/.testplane/src/browser/commands/assert-view/errors/image-diff-error.ts:43 | +| `diffBuffer` | `public` | `Buffer` | - | - | - | testplane-docs/.testplane/src/browser/commands/assert-view/errors/image-diff-error.ts:45 | +| `diffClusters?` | `public` | `CoordBounds`[] | - | - | - | testplane-docs/.testplane/src/browser/commands/assert-view/errors/image-diff-error.ts:44 | +| `diffOpts` | `public` | `DiffOptions` | - | - | - | testplane-docs/.testplane/src/browser/commands/assert-view/errors/image-diff-error.ts:42 | +| `diffRatio` | `public` | `number` | - | - | - | testplane-docs/.testplane/src/browser/commands/assert-view/errors/image-diff-error.ts:47 | +| `differentPixels` | `public` | `number` | - | - | - | testplane-docs/.testplane/src/browser/commands/assert-view/errors/image-diff-error.ts:46 | +| `message` | `public` | `string` | - | `BaseStateError.message` | - | testplane-docs/.testplane/src/browser/commands/assert-view/errors/image-diff-error.ts:41 | +| `name` | `public` | `string` | - | - | `BaseStateError.name` | testplane-docs/node\_modules/typescript/lib/lib.es5.d.ts:1076 | +| `refImg` | `public` | [`RefImageInfo`](../interfaces/RefImageInfo.mdx) | - | - | `BaseStateError.refImg` | testplane-docs/.testplane/src/browser/commands/assert-view/errors/base-state-error.ts:4 | +| `stack?` | `public` | `string` | - | - | `BaseStateError.stack` | testplane-docs/node\_modules/typescript/lib/lib.es5.d.ts:1078 | +| `stateName` | `public` | `string` | - | - | `BaseStateError.stateName` | testplane-docs/.testplane/src/browser/commands/assert-view/errors/base-state-error.ts:4 | +| `prepareStackTrace?` | `static` | (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` | Optional override for formatting stack traces **See** https://v8.dev/docs/stack-trace-api#customizing-stack-traces | - | `BaseStateError.prepareStackTrace` | testplane/node\_modules/@types/node/globals.d.ts:27 | +| `stackTraceLimit` | `static` | `number` | - | - | `BaseStateError.stackTraceLimit` | testplane/node\_modules/@types/node/globals.d.ts:29 | + +## Methods + +### saveDiffTo() + +```ts +saveDiffTo(diffPath): Promise +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `diffPath` | `string` | + +#### Returns + +`Promise`\<`null`\> + +#### Defined in + +testplane-docs/.testplane/src/browser/commands/assert-view/errors/image-diff-error.ts:109 + +*** + +### captureStackTrace() + +```ts +static captureStackTrace(targetObject, constructorOpt?): void +``` + +Create .stack property on a target object + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `targetObject` | `object` | +| `constructorOpt`? | `Function` | + +#### Returns + +`void` + +#### Inherited from + +`BaseStateError.captureStackTrace` + +#### Defined in + +testplane/node\_modules/@types/node/globals.d.ts:20 + +*** + +### create() + +```ts +static create(this, __namedParameters): T +``` + +#### Type Parameters + +| Type Parameter | +| ------ | +| `T` *extends* [`ImageDiffError`](ImageDiffError.mdx) | + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `this` | `ImageDiffErrorConstructor`\<`T`\> | +| `__namedParameters` | `object` | +| `__namedParameters.currImg` | [`ImageInfo`](../interfaces/ImageInfo.mdx) | +| `__namedParameters.diffAreas`? | `DiffAreas` | +| `__namedParameters.diffBuffer` | `Buffer` | +| `__namedParameters.diffOpts` | `DiffOptions` | +| `__namedParameters.diffRatio` | `number` | +| `__namedParameters.differentPixels` | `number` | +| `__namedParameters.refImg` | [`RefImageInfo`](../interfaces/RefImageInfo.mdx) | +| `__namedParameters.stateName` | `string` | + +#### Returns + +`T` + +#### Defined in + +testplane-docs/.testplane/src/browser/commands/assert-view/errors/image-diff-error.ts:49 + +*** + +### fromObject() + +```ts +static fromObject(this, data): T +``` + +#### Type Parameters + +| Type Parameter | +| ------ | +| `T` | + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `this` | `ImageDiffErrorConstructor`\<`T`\> | +| `data` | `ImageDiffErrorData` | + +#### Returns + +`T` + +#### Defined in + +testplane-docs/.testplane/src/browser/commands/assert-view/errors/image-diff-error.ts:74 diff --git a/docs/api-reference/classes/NoRefImageError.mdx b/docs/api-reference/classes/NoRefImageError.mdx new file mode 100644 index 0000000..2128ed9 --- /dev/null +++ b/docs/api-reference/classes/NoRefImageError.mdx @@ -0,0 +1,144 @@ +[testplane](../README.mdx) / NoRefImageError + +# Class: NoRefImageError + +## Extends + +- `BaseStateError` + +## Constructors + +### new NoRefImageError() + +```ts +new NoRefImageError( + stateName, + currImg, + refImg): NoRefImageError +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `stateName` | `string` | +| `currImg` | [`ImageInfo`](../interfaces/ImageInfo.mdx) | +| `refImg` | [`RefImageInfo`](../interfaces/RefImageInfo.mdx) | + +#### Returns + +[`NoRefImageError`](NoRefImageError.mdx) + +#### Overrides + +`BaseStateError.constructor` + +#### Defined in + +testplane-docs/.testplane/src/browser/commands/assert-view/errors/no-ref-image-error.ts:26 + +## Properties + +| Property | Modifier | Type | Description | Inherited from | Defined in | +| ------ | ------ | ------ | ------ | ------ | ------ | +| `currImg` | `public` | [`ImageInfo`](../interfaces/ImageInfo.mdx) | - | `BaseStateError.currImg` | testplane-docs/.testplane/src/browser/commands/assert-view/errors/base-state-error.ts:4 | +| `message` | `public` | `string` | - | `BaseStateError.message` | testplane-docs/node\_modules/typescript/lib/lib.es5.d.ts:1077 | +| `name` | `public` | `string` | - | `BaseStateError.name` | testplane-docs/node\_modules/typescript/lib/lib.es5.d.ts:1076 | +| `refImg` | `public` | [`RefImageInfo`](../interfaces/RefImageInfo.mdx) | - | `BaseStateError.refImg` | testplane-docs/.testplane/src/browser/commands/assert-view/errors/base-state-error.ts:4 | +| `stack?` | `public` | `string` | - | `BaseStateError.stack` | testplane-docs/node\_modules/typescript/lib/lib.es5.d.ts:1078 | +| `stateName` | `public` | `string` | - | `BaseStateError.stateName` | testplane-docs/.testplane/src/browser/commands/assert-view/errors/base-state-error.ts:4 | +| `prepareStackTrace?` | `static` | (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` | Optional override for formatting stack traces **See** https://v8.dev/docs/stack-trace-api#customizing-stack-traces | `BaseStateError.prepareStackTrace` | testplane/node\_modules/@types/node/globals.d.ts:27 | +| `stackTraceLimit` | `static` | `number` | - | `BaseStateError.stackTraceLimit` | testplane/node\_modules/@types/node/globals.d.ts:29 | + +## Methods + +### captureStackTrace() + +```ts +static captureStackTrace(targetObject, constructorOpt?): void +``` + +Create .stack property on a target object + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `targetObject` | `object` | +| `constructorOpt`? | `Function` | + +#### Returns + +`void` + +#### Inherited from + +`BaseStateError.captureStackTrace` + +#### Defined in + +testplane/node\_modules/@types/node/globals.d.ts:20 + +*** + +### create() + +```ts +static create( + this, + stateName, + currImg, + refImg): T +``` + +#### Type Parameters + +| Type Parameter | +| ------ | +| `T` *extends* [`NoRefImageError`](NoRefImageError.mdx) | + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `this` | `NoRefImageErrorConstructor`\<`T`\> | +| `stateName` | `string` | +| `currImg` | [`ImageInfo`](../interfaces/ImageInfo.mdx) | +| `refImg` | [`RefImageInfo`](../interfaces/RefImageInfo.mdx) | + +#### Returns + +`T` + +#### Defined in + +testplane-docs/.testplane/src/browser/commands/assert-view/errors/no-ref-image-error.ts:13 + +*** + +### fromObject() + +```ts +static fromObject(this, data): T +``` + +#### Type Parameters + +| Type Parameter | +| ------ | +| `T` *extends* [`NoRefImageError`](NoRefImageError.mdx) | + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `this` | `NoRefImageErrorConstructor`\<`T`\> | +| `data` | `NoRefImageErrorData` | + +#### Returns + +`T` + +#### Defined in + +testplane-docs/.testplane/src/browser/commands/assert-view/errors/no-ref-image-error.ts:22 diff --git a/docs/api-reference/classes/OffsetViewportError.mdx b/docs/api-reference/classes/OffsetViewportError.mdx new file mode 100644 index 0000000..098577a --- /dev/null +++ b/docs/api-reference/classes/OffsetViewportError.mdx @@ -0,0 +1,74 @@ +[testplane](../README.mdx) / OffsetViewportError + +# Class: OffsetViewportError + +Position of an element is outside of a viewport left, top or right bounds + +## Extends + +- `Error` + +## Constructors + +### new OffsetViewportError() + +```ts +new OffsetViewportError(message): OffsetViewportError +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +#### Returns + +[`OffsetViewportError`](OffsetViewportError.mdx) + +#### Overrides + +`Error.constructor` + +#### Defined in + +testplane-docs/.testplane/src/browser/screen-shooter/viewport/coord-validator/errors/offset-viewport-error.ts:5 + +## Properties + +| Property | Modifier | Type | Description | Inherited from | Defined in | +| ------ | ------ | ------ | ------ | ------ | ------ | +| `message` | `public` | `string` | - | `Error.message` | testplane-docs/node\_modules/typescript/lib/lib.es5.d.ts:1077 | +| `name` | `public` | `string` | - | `Error.name` | testplane-docs/node\_modules/typescript/lib/lib.es5.d.ts:1076 | +| `stack?` | `public` | `string` | - | `Error.stack` | testplane-docs/node\_modules/typescript/lib/lib.es5.d.ts:1078 | +| `prepareStackTrace?` | `static` | (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` | Optional override for formatting stack traces **See** https://v8.dev/docs/stack-trace-api#customizing-stack-traces | `Error.prepareStackTrace` | testplane/node\_modules/@types/node/globals.d.ts:27 | +| `stackTraceLimit` | `static` | `number` | - | `Error.stackTraceLimit` | testplane/node\_modules/@types/node/globals.d.ts:29 | + +## Methods + +### captureStackTrace() + +```ts +static captureStackTrace(targetObject, constructorOpt?): void +``` + +Create .stack property on a target object + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `targetObject` | `object` | +| `constructorOpt`? | `Function` | + +#### Returns + +`void` + +#### Inherited from + +`Error.captureStackTrace` + +#### Defined in + +testplane/node\_modules/@types/node/globals.d.ts:20 diff --git a/docs/api-reference/classes/Suite.mdx b/docs/api-reference/classes/Suite.mdx new file mode 100644 index 0000000..49001f3 --- /dev/null +++ b/docs/api-reference/classes/Suite.mdx @@ -0,0 +1,766 @@ +[testplane](../README.mdx) / Suite + +# Class: Suite + +## Extends + +- `ConfigurableTestObject` + +## Extended by + +- [`RootSuite`](../interfaces/RootSuite.mdx) + +## Constructors + +### new Suite() + +```ts +new Suite(__namedParameters): Suite +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `SuiteOpts` | + +#### Returns + +[`Suite`](Suite.mdx) + +#### Overrides + +`ConfigurableTestObject.constructor` + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/suite.ts:20 + +## Properties + +| Property | Modifier | Type | Default value | Inherited from | Defined in | +| ------ | ------ | ------ | ------ | ------ | ------ | +| `parent` | `public` | `null` \| [`Suite`](Suite.mdx) | `null` | `ConfigurableTestObject.parent` | testplane-docs/.testplane/src/test-reader/test-object/test-object.ts:6 | + +## Accessors + +### afterEachHooks + +```ts +get afterEachHooks(): Hook[] +``` + +#### Returns + +`Hook`[] + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/suite.ts:95 + +*** + +### beforeEachHooks + +```ts +get beforeEachHooks(): Hook[] +``` + +#### Returns + +`Hook`[] + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/suite.ts:91 + +*** + +### browserId + +```ts +get browserId(): string +``` + +```ts +set browserId(id): void +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `id` | `string` | + +#### Returns + +`string` + +#### Inherited from + +`ConfigurableTestObject.browserId` + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/configurable-test-object.ts:93 + +*** + +### browserVersion + +```ts +get browserVersion(): undefined | string +``` + +```ts +set browserVersion(version): void +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `version` | `string` | + +#### Returns + +`undefined` \| `string` + +#### Inherited from + +`ConfigurableTestObject.browserVersion` + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/configurable-test-object.ts:101 + +*** + +### disabled + +```ts +get disabled(): boolean +``` + +```ts +set disabled(val): void +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `val` | `boolean` | + +#### Returns + +`boolean` + +#### Inherited from + +`ConfigurableTestObject.disabled` + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/configurable-test-object.ts:69 + +*** + +### file + +```ts +get file(): string +``` + +#### Returns + +`string` + +#### Inherited from + +`ConfigurableTestObject.file` + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/configurable-test-object.ts:45 + +*** + +### hasBrowserVersionOverwritten + +```ts +get hasBrowserVersionOverwritten(): boolean +``` + +#### Returns + +`boolean` + +#### Inherited from + +`ConfigurableTestObject.hasBrowserVersionOverwritten` + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/configurable-test-object.ts:105 + +*** + +### id + +```ts +get id(): string +``` + +#### Returns + +`string` + +#### Inherited from + +`ConfigurableTestObject.id` + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/configurable-test-object.ts:41 + +*** + +### pending + +```ts +get pending(): boolean +``` + +```ts +set pending(val): void +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `val` | `boolean` | + +#### Returns + +`boolean` + +#### Inherited from + +`ConfigurableTestObject.pending` + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/configurable-test-object.ts:53 + +*** + +### root + +```ts +get root(): boolean +``` + +#### Returns + +`boolean` + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/suite.ts:79 + +*** + +### silentSkip + +```ts +get silentSkip(): boolean +``` + +```ts +set silentSkip(val): void +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `val` | `boolean` | + +#### Returns + +`boolean` + +#### Inherited from + +`ConfigurableTestObject.silentSkip` + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/configurable-test-object.ts:77 + +*** + +### skipReason + +```ts +get skipReason(): string +``` + +```ts +set skipReason(reason): void +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `reason` | `string` | + +#### Returns + +`string` + +#### Inherited from + +`ConfigurableTestObject.skipReason` + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/configurable-test-object.ts:61 + +*** + +### suites + +```ts +get suites(): Suite[] +``` + +#### Returns + +[`Suite`](Suite.mdx)[] + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/suite.ts:83 + +*** + +### tests + +```ts +get tests(): Test[] +``` + +#### Returns + +[`Test`](Test.mdx)[] + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/suite.ts:87 + +*** + +### timeout + +```ts +get timeout(): number +``` + +```ts +set timeout(timeout): void +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `timeout` | `number` | + +#### Returns + +`number` + +#### Inherited from + +`ConfigurableTestObject.timeout` + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/configurable-test-object.ts:85 + +*** + +### title + +```ts +get title(): string +``` + +#### Returns + +`string` + +#### Inherited from + +`ConfigurableTestObject.title` + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/test-object.ts:16 + +## Methods + +### addAfterEachHook() + +```ts +addAfterEachHook(hook): this +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `hook` | `Hook` | + +#### Returns + +`this` + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/suite.ts:41 + +*** + +### addBeforeEachHook() + +```ts +addBeforeEachHook(hook): this +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `hook` | `Hook` | + +#### Returns + +`this` + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/suite.ts:37 + +*** + +### addSuite() + +```ts +addSuite(suite): this +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `suite` | [`Suite`](Suite.mdx) | + +#### Returns + +`this` + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/suite.ts:29 + +*** + +### addTest() + +```ts +addTest(test): this +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `test` | [`Test`](Test.mdx) | + +#### Returns + +`this` + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/suite.ts:33 + +*** + +### afterEach() + +```ts +afterEach(fn): this +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `fn` | `TestFunction`\<[`TestFunctionCtx`](../interfaces/TestFunctionCtx.mdx)\> | + +#### Returns + +`this` + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/suite.ts:49 + +*** + +### assign() + +```ts +assign(src): this +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `src` | `this` | + +#### Returns + +`this` + +#### Inherited from + +`ConfigurableTestObject.assign` + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/configurable-test-object.ts:20 + +*** + +### beforeEach() + +```ts +beforeEach(fn): this +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `fn` | `TestFunction`\<[`TestFunctionCtx`](../interfaces/TestFunctionCtx.mdx)\> | + +#### Returns + +`this` + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/suite.ts:45 + +*** + +### disable() + +```ts +disable(): void +``` + +#### Returns + +`void` + +#### Inherited from + +`ConfigurableTestObject.disable` + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/configurable-test-object.ts:31 + +*** + +### eachTest() + +```ts +eachTest(cb): void +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `cb` | (`test`) => `void` | + +#### Returns + +`void` + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/suite.ts:60 + +*** + +### enable() + +```ts +enable(): void +``` + +#### Returns + +`void` + +#### Inherited from + +`ConfigurableTestObject.enable` + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/configurable-test-object.ts:36 + +*** + +### filterTests() + +```ts +filterTests(cb): this +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `cb` | (`test`) => `unknown` | + +#### Returns + +`this` + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/suite.ts:70 + +*** + +### fullTitle() + +```ts +fullTitle(): string +``` + +#### Returns + +`string` + +#### Inherited from + +`ConfigurableTestObject.fullTitle` + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/test-object.ts:30 + +*** + +### getTests() + +```ts +getTests(): Test[] +``` + +#### Returns + +[`Test`](Test.mdx)[] + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/suite.ts:65 + +*** + +### skip() + +```ts +skip(__namedParameters): void +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `SkipData` | + +#### Returns + +`void` + +#### Inherited from + +`ConfigurableTestObject.skip` + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/configurable-test-object.ts:26 + +*** + +### titlePath() + +```ts +titlePath(): string[] +``` + +#### Returns + +`string`[] + +#### Inherited from + +`ConfigurableTestObject.titlePath` + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/test-object.ts:20 + +*** + +### create() + +```ts +static create(this, opts): T +``` + +#### Type Parameters + +| Type Parameter | +| ------ | +| `T` *extends* [`Suite`](Suite.mdx) | + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `this` | (`opts`) => `T` | +| `opts` | `SuiteOpts` | + +#### Returns + +`T` + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/suite.ts:15 diff --git a/docs/api-reference/classes/Test.mdx b/docs/api-reference/classes/Test.mdx new file mode 100644 index 0000000..9717a80 --- /dev/null +++ b/docs/api-reference/classes/Test.mdx @@ -0,0 +1,512 @@ +[testplane](../README.mdx) / Test + +# Class: Test + +## Extends + +- `ConfigurableTestObject` + +## Extended by + +- [`TestResult`](../interfaces/TestResult.mdx) + +## Constructors + +### new Test() + +```ts +new Test(__namedParameters): Test +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `TestOpts` | + +#### Returns + +[`Test`](Test.mdx) + +#### Overrides + +`ConfigurableTestObject.constructor` + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/test.ts:17 + +## Properties + +| Property | Modifier | Type | Default value | Inherited from | Defined in | +| ------ | ------ | ------ | ------ | ------ | ------ | +| `err?` | `public` | `Error` | `undefined` | - | testplane-docs/.testplane/src/test-reader/test-object/test.ts:11 | +| `fn` | `public` | `TestFunction`\<[`TestFunctionCtx`](../interfaces/TestFunctionCtx.mdx)\> | `undefined` | - | testplane-docs/.testplane/src/test-reader/test-object/test.ts:10 | +| `parent` | `public` | `null` \| [`Suite`](Suite.mdx) | `null` | `ConfigurableTestObject.parent` | testplane-docs/.testplane/src/test-reader/test-object/test-object.ts:6 | + +## Accessors + +### browserId + +```ts +get browserId(): string +``` + +```ts +set browserId(id): void +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `id` | `string` | + +#### Returns + +`string` + +#### Inherited from + +`ConfigurableTestObject.browserId` + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/configurable-test-object.ts:93 + +*** + +### browserVersion + +```ts +get browserVersion(): undefined | string +``` + +```ts +set browserVersion(version): void +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `version` | `string` | + +#### Returns + +`undefined` \| `string` + +#### Inherited from + +`ConfigurableTestObject.browserVersion` + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/configurable-test-object.ts:101 + +*** + +### disabled + +```ts +get disabled(): boolean +``` + +```ts +set disabled(val): void +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `val` | `boolean` | + +#### Returns + +`boolean` + +#### Inherited from + +`ConfigurableTestObject.disabled` + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/configurable-test-object.ts:69 + +*** + +### file + +```ts +get file(): string +``` + +#### Returns + +`string` + +#### Inherited from + +`ConfigurableTestObject.file` + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/configurable-test-object.ts:45 + +*** + +### hasBrowserVersionOverwritten + +```ts +get hasBrowserVersionOverwritten(): boolean +``` + +#### Returns + +`boolean` + +#### Inherited from + +`ConfigurableTestObject.hasBrowserVersionOverwritten` + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/configurable-test-object.ts:105 + +*** + +### id + +```ts +get id(): string +``` + +#### Returns + +`string` + +#### Inherited from + +`ConfigurableTestObject.id` + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/configurable-test-object.ts:41 + +*** + +### pending + +```ts +get pending(): boolean +``` + +```ts +set pending(val): void +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `val` | `boolean` | + +#### Returns + +`boolean` + +#### Inherited from + +`ConfigurableTestObject.pending` + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/configurable-test-object.ts:53 + +*** + +### silentSkip + +```ts +get silentSkip(): boolean +``` + +```ts +set silentSkip(val): void +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `val` | `boolean` | + +#### Returns + +`boolean` + +#### Inherited from + +`ConfigurableTestObject.silentSkip` + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/configurable-test-object.ts:77 + +*** + +### skipReason + +```ts +get skipReason(): string +``` + +```ts +set skipReason(reason): void +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `reason` | `string` | + +#### Returns + +`string` + +#### Inherited from + +`ConfigurableTestObject.skipReason` + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/configurable-test-object.ts:61 + +*** + +### timeout + +```ts +get timeout(): number +``` + +```ts +set timeout(timeout): void +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `timeout` | `number` | + +#### Returns + +`number` + +#### Inherited from + +`ConfigurableTestObject.timeout` + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/configurable-test-object.ts:85 + +*** + +### title + +```ts +get title(): string +``` + +#### Returns + +`string` + +#### Inherited from + +`ConfigurableTestObject.title` + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/test-object.ts:16 + +## Methods + +### assign() + +```ts +assign(src): this +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `src` | `this` | + +#### Returns + +`this` + +#### Inherited from + +`ConfigurableTestObject.assign` + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/configurable-test-object.ts:20 + +*** + +### clone() + +```ts +clone(): Test +``` + +#### Returns + +[`Test`](Test.mdx) + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/test.ts:23 + +*** + +### disable() + +```ts +disable(): void +``` + +#### Returns + +`void` + +#### Inherited from + +`ConfigurableTestObject.disable` + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/configurable-test-object.ts:31 + +*** + +### enable() + +```ts +enable(): void +``` + +#### Returns + +`void` + +#### Inherited from + +`ConfigurableTestObject.enable` + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/configurable-test-object.ts:36 + +*** + +### fullTitle() + +```ts +fullTitle(): string +``` + +#### Returns + +`string` + +#### Inherited from + +`ConfigurableTestObject.fullTitle` + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/test-object.ts:30 + +*** + +### skip() + +```ts +skip(__namedParameters): void +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `SkipData` | + +#### Returns + +`void` + +#### Inherited from + +`ConfigurableTestObject.skip` + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/configurable-test-object.ts:26 + +*** + +### titlePath() + +```ts +titlePath(): string[] +``` + +#### Returns + +`string`[] + +#### Inherited from + +`ConfigurableTestObject.titlePath` + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/test-object.ts:20 + +*** + +### create() + +```ts +static create(this, opts): T +``` + +#### Type Parameters + +| Type Parameter | +| ------ | +| `T` *extends* [`Test`](Test.mdx) | + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `this` | (`opts`) => `T` | +| `opts` | `TestOpts` | + +#### Returns + +`T` + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/test.ts:13 diff --git a/docs/api-reference/classes/TestCollection.mdx b/docs/api-reference/classes/TestCollection.mdx new file mode 100644 index 0000000..d792fcd --- /dev/null +++ b/docs/api-reference/classes/TestCollection.mdx @@ -0,0 +1,374 @@ +[testplane](../README.mdx) / TestCollection + +# Class: TestCollection + +## Constructors + +### new TestCollection() + +```ts +new TestCollection(specs): TestCollection +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `specs` | `Record`\<`string`, [`Test`](Test.mdx)[]\> | + +#### Returns + +[`TestCollection`](TestCollection.mdx) + +#### Defined in + +testplane-docs/.testplane/src/test-collection.ts:20 + +## Methods + +### disableAll() + +```ts +disableAll(browserId?): this +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `browserId`? | `string` | + +#### Returns + +`this` + +#### Defined in + +testplane-docs/.testplane/src/test-collection.ts:122 + +*** + +### disableTest() + +```ts +disableTest(fullTitle, browserId?): this +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `fullTitle` | `string` | +| `browserId`? | `string` | + +#### Returns + +`this` + +#### Defined in + +testplane-docs/.testplane/src/test-collection.ts:136 + +*** + +### eachRootSuite() + +```ts +eachRootSuite(cb): void +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `cb` | (`root`, `browserId`) => `void` | + +#### Returns + +`void` + +#### Defined in + +testplane-docs/.testplane/src/test-collection.ts:30 + +*** + +### eachTest() + +#### eachTest(callback) + +```ts +eachTest(callback): void +``` + +##### Parameters + +| Parameter | Type | +| ------ | ------ | +| `callback` | `TestsCallback`\<`void`\> | + +##### Returns + +`void` + +##### Defined in + +testplane-docs/.testplane/src/test-collection.ts:87 + +#### eachTest(browserId, callback) + +```ts +eachTest(browserId, callback): void +``` + +##### Parameters + +| Parameter | Type | +| ------ | ------ | +| `browserId` | `undefined` \| `string` | +| `callback` | `TestsCallback`\<`void`\> | + +##### Returns + +`void` + +##### Defined in + +testplane-docs/.testplane/src/test-collection.ts:88 + +*** + +### eachTestByVersions() + +```ts +eachTestByVersions(browserId, cb): void +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `browserId` | `string` | +| `cb` | (`test`, `browserId`, `browserVersion`?) => `void` | + +#### Returns + +`void` + +#### Defined in + +testplane-docs/.testplane/src/test-collection.ts:102 + +*** + +### enableAll() + +```ts +enableAll(browserId?): this +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `browserId`? | `string` | + +#### Returns + +`this` + +#### Defined in + +testplane-docs/.testplane/src/test-collection.ts:153 + +*** + +### enableTest() + +```ts +enableTest(fullTitle, browserId?): this +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `fullTitle` | `string` | +| `browserId`? | `string` | + +#### Returns + +`this` + +#### Defined in + +testplane-docs/.testplane/src/test-collection.ts:163 + +*** + +### getBrowsers() + +```ts +getBrowsers(): string[] +``` + +#### Returns + +`string`[] + +#### Defined in + +testplane-docs/.testplane/src/test-collection.ts:43 + +*** + +### getRootSuite() + +```ts +getRootSuite(browserId): null | RootSuite +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `browserId` | `string` | + +#### Returns + +`null` \| [`RootSuite`](../interfaces/RootSuite.mdx) + +#### Defined in + +testplane-docs/.testplane/src/test-collection.ts:25 + +*** + +### mapTests() + +#### mapTests(cb) + +```ts +mapTests(cb): T[] +``` + +##### Type Parameters + +| Type Parameter | +| ------ | +| `T` | + +##### Parameters + +| Parameter | Type | +| ------ | ------ | +| `cb` | `TestsCallback`\<`T`\> | + +##### Returns + +`T`[] + +##### Defined in + +testplane-docs/.testplane/src/test-collection.ts:47 + +#### mapTests(browserId, cb) + +```ts +mapTests(browserId, cb): T[] +``` + +##### Type Parameters + +| Type Parameter | +| ------ | +| `T` | + +##### Parameters + +| Parameter | Type | +| ------ | ------ | +| `browserId` | `undefined` \| `string` | +| `cb` | `TestsCallback`\<`T`\> | + +##### Returns + +`T`[] + +##### Defined in + +testplane-docs/.testplane/src/test-collection.ts:48 + +*** + +### sortTests() + +#### sortTests(callback) + +```ts +sortTests(callback): this +``` + +##### Parameters + +| Parameter | Type | +| ------ | ------ | +| `callback` | `SortTestsCallback` | + +##### Returns + +`this` + +##### Defined in + +testplane-docs/.testplane/src/test-collection.ts:63 + +#### sortTests(browserId, callback) + +```ts +sortTests(browserId, callback): this +``` + +##### Parameters + +| Parameter | Type | +| ------ | ------ | +| `browserId` | `undefined` \| `string` | +| `callback` | `SortTestsCallback` | + +##### Returns + +`this` + +##### Defined in + +testplane-docs/.testplane/src/test-collection.ts:64 + +*** + +### create() + +```ts +static create(this, specs): T +``` + +#### Type Parameters + +| Type Parameter | +| ------ | +| `T` *extends* [`TestCollection`](TestCollection.mdx) | + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `this` | (`specs`) => `T` | +| `specs` | `Record`\<`string`, [`Test`](Test.mdx)[]\> | + +#### Returns + +`T` + +#### Defined in + +testplane-docs/.testplane/src/test-collection.ts:13 diff --git a/docs/api-reference/classes/Testplane.mdx b/docs/api-reference/classes/Testplane.mdx new file mode 100644 index 0000000..a50a844 --- /dev/null +++ b/docs/api-reference/classes/Testplane.mdx @@ -0,0 +1,1408 @@ +[testplane](../README.mdx) / Testplane + +# Class: Testplane + +## Extends + +- `BaseTestplane` + +## Constructors + +### new Testplane() + +```ts +new Testplane(config?): Testplane +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `config`? | `string` \| [`ConfigInput`](../type-aliases/ConfigInput.mdx) | + +#### Returns + +[`Testplane`](Testplane.mdx) + +#### Defined in + +testplane-docs/.testplane/src/testplane.ts:67 + +## Properties + +| Property | Modifier | Type | Description | Defined in | +| ------ | ------ | ------ | ------ | ------ | +| `on` | `public` | [`MasterEventHandler`](../type-aliases/MasterEventHandler.mdx)\<[`Testplane`](Testplane.mdx)\> | - | testplane-docs/.testplane/src/testplane.ts:57 | +| `once` | `public` | [`MasterEventHandler`](../type-aliases/MasterEventHandler.mdx)\<[`Testplane`](Testplane.mdx)\> | - | testplane-docs/.testplane/src/testplane.ts:58 | +| `prependListener` | `public` | [`MasterEventHandler`](../type-aliases/MasterEventHandler.mdx)\<[`Testplane`](Testplane.mdx)\> | - | testplane-docs/.testplane/src/testplane.ts:59 | +| `captureRejectionSymbol` | `readonly` | *typeof* `captureRejectionSymbol` | - | testplane/node\_modules/@types/node/events.d.ts:405 | +| `captureRejections` | `static` | `boolean` | Sets or gets the default captureRejection value for all emitters. | testplane/node\_modules/@types/node/events.d.ts:410 | +| `defaultMaxListeners` | `static` | `number` | - | testplane/node\_modules/@types/node/events.d.ts:411 | +| `errorMonitor` | `readonly` | *typeof* `errorMonitor` | This symbol shall be used to install a listener for only monitoring `'error'` events. Listeners installed using this symbol are called before the regular `'error'` listeners are called. Installing a listener using this symbol does not change the behavior once an `'error'` event is emitted, therefore the process will still crash if no regular `'error'` listener is installed. | testplane/node\_modules/@types/node/events.d.ts:404 | + +## Accessors + +### config + +```ts +get config(): Config +``` + +#### Returns + +[`Config`](Config.mdx) + +#### Defined in + +testplane-docs/.testplane/src/base-testplane.ts:45 + +*** + +### errors + +```ts +get errors(): { + AbortOnReconnectError: typeof AbortOnReconnectError; + AssertViewError: typeof AssertViewError; + CancelledError: typeof CancelledError; + ClientBridgeError: typeof ClientBridgeError; + CoreError: typeof CoreError; + HeightViewportError: typeof HeightViewportError; + ImageDiffError: typeof ImageDiffError; + NoRefImageError: typeof NoRefImageError; + OffsetViewportError: typeof OffsetViewportError; + TestplaneInternalError: typeof TestplaneInternalError; +} +``` + +#### Returns + +```ts +{ + AbortOnReconnectError: typeof AbortOnReconnectError; + AssertViewError: typeof AssertViewError; + CancelledError: typeof CancelledError; + ClientBridgeError: typeof ClientBridgeError; + CoreError: typeof CoreError; + HeightViewportError: typeof HeightViewportError; + ImageDiffError: typeof ImageDiffError; + NoRefImageError: typeof NoRefImageError; + OffsetViewportError: typeof OffsetViewportError; + TestplaneInternalError: typeof TestplaneInternalError; +} +``` + +| Name | Type | Defined in | +| ------ | ------ | ------ | +| `AbortOnReconnectError` | *typeof* [`AbortOnReconnectError`](AbortOnReconnectError.mdx) | testplane-docs/.testplane/src/errors.ts:34 | +| `AssertViewError` | *typeof* [`AssertViewError`](AssertViewError.mdx) | testplane-docs/.testplane/src/errors.ts:30 | +| `CancelledError` | *typeof* [`CancelledError`](CancelledError.mdx) | testplane-docs/.testplane/src/errors.ts:26 | +| `ClientBridgeError` | *typeof* [`ClientBridgeError`](ClientBridgeError.mdx) | testplane-docs/.testplane/src/errors.ts:27 | +| `CoreError` | *typeof* [`CoreError`](CoreError.mdx) | testplane-docs/.testplane/src/errors.ts:25 | +| `HeightViewportError` | *typeof* [`HeightViewportError`](HeightViewportError.mdx) | testplane-docs/.testplane/src/errors.ts:28 | +| `ImageDiffError` | *typeof* [`ImageDiffError`](ImageDiffError.mdx) | testplane-docs/.testplane/src/errors.ts:31 | +| `NoRefImageError` | *typeof* [`NoRefImageError`](NoRefImageError.mdx) | testplane-docs/.testplane/src/errors.ts:32 | +| `OffsetViewportError` | *typeof* [`OffsetViewportError`](OffsetViewportError.mdx) | testplane-docs/.testplane/src/errors.ts:29 | +| `TestplaneInternalError` | *typeof* [`TestplaneInternalError`](TestplaneInternalError.mdx) | testplane-docs/.testplane/src/errors.ts:33 | + +#### Defined in + +testplane-docs/.testplane/src/base-testplane.ts:53 + +*** + +### events + +```ts +get events(): { + AFTER_FILE_READ: MasterEvents.AFTER_FILE_READ; + AFTER_TESTS_READ: MasterEvents.AFTER_TESTS_READ; + BEFORE_FILE_READ: MasterEvents.BEFORE_FILE_READ; + BEGIN: "begin"; + CLI: "cli"; + END: "end"; + ERROR: "err"; + EXIT: "exit"; + INFO: "info"; + INIT: MasterEvents.INIT; + NEW_BROWSER: "newBrowser"; + NEW_WORKER_PROCESS: "newWorkerProcess"; + RETRY: "retry"; + RUNNER_END: "endRunner"; + RUNNER_START: "startRunner"; + SESSION_END: "endSession"; + SESSION_START: "startSession"; + SUITE_BEGIN: "beginSuite"; + SUITE_END: "endSuite"; + TEST_BEGIN: "beginTest"; + TEST_END: "endTest"; + TEST_FAIL: "failTest"; + TEST_PASS: "passTest"; + TEST_PENDING: "pendingTest"; + UPDATE_REFERENCE: "updateReference"; + WARNING: "warning"; +} +``` + +#### Returns + +```ts +{ + AFTER_FILE_READ: MasterEvents.AFTER_FILE_READ; + AFTER_TESTS_READ: MasterEvents.AFTER_TESTS_READ; + BEFORE_FILE_READ: MasterEvents.BEFORE_FILE_READ; + BEGIN: "begin"; + CLI: "cli"; + END: "end"; + ERROR: "err"; + EXIT: "exit"; + INFO: "info"; + INIT: MasterEvents.INIT; + NEW_BROWSER: "newBrowser"; + NEW_WORKER_PROCESS: "newWorkerProcess"; + RETRY: "retry"; + RUNNER_END: "endRunner"; + RUNNER_START: "startRunner"; + SESSION_END: "endSession"; + SESSION_START: "startSession"; + SUITE_BEGIN: "beginSuite"; + SUITE_END: "endSuite"; + TEST_BEGIN: "beginTest"; + TEST_END: "endTest"; + TEST_FAIL: "failTest"; + TEST_PASS: "passTest"; + TEST_PENDING: "pendingTest"; + UPDATE_REFERENCE: "updateReference"; + WARNING: "warning"; +} +``` + +| Name | Type | Default value | Defined in | +| ------ | ------ | ------ | ------ | +| `AFTER_FILE_READ` | `"afterFileRead"` | MasterEvents.AFTER\_FILE\_READ | testplane-docs/.testplane/src/events/index.ts:92 | +| `AFTER_TESTS_READ` | `"afterTestsRead"` | MasterEvents.AFTER\_TESTS\_READ | testplane-docs/.testplane/src/events/index.ts:94 | +| `BEFORE_FILE_READ` | `"beforeFileRead"` | MasterEvents.BEFORE\_FILE\_READ | testplane-docs/.testplane/src/events/index.ts:91 | +| `BEGIN` | `"begin"` | "begin" | testplane-docs/.testplane/src/events/index.ts:53 | +| `CLI` | `"cli"` | "cli" | testplane-docs/.testplane/src/events/index.ts:51 | +| `END` | `"end"` | "end" | testplane-docs/.testplane/src/events/index.ts:54 | +| `ERROR` | `"err"` | "err" | testplane-docs/.testplane/src/events/index.ts:63 | +| `EXIT` | `"exit"` | "exit" | testplane-docs/.testplane/src/events/index.ts:23 | +| `INFO` | `"info"` | "info" | testplane-docs/.testplane/src/events/index.ts:61 | +| `INIT` | `"init"` | MasterEvents.INIT | testplane-docs/.testplane/src/events/index.ts:89 | +| `NEW_BROWSER` | `"newBrowser"` | "newBrowser" | testplane-docs/.testplane/src/events/index.ts:96 | +| `NEW_WORKER_PROCESS` | `"newWorkerProcess"` | "newWorkerProcess" | testplane-docs/.testplane/src/events/index.ts:31 | +| `RETRY` | `"retry"` | "retry" | testplane-docs/.testplane/src/events/index.ts:43 | +| `RUNNER_END` | `"endRunner"` | "endRunner" | testplane-docs/.testplane/src/events/index.ts:18 | +| `RUNNER_START` | `"startRunner"` | "startRunner" | testplane-docs/.testplane/src/events/index.ts:17 | +| `SESSION_END` | `"endSession"` | "endSession" | testplane-docs/.testplane/src/events/index.ts:21 | +| `SESSION_START` | `"startSession"` | "startSession" | testplane-docs/.testplane/src/events/index.ts:20 | +| `SUITE_BEGIN` | `"beginSuite"` | "beginSuite" | testplane-docs/.testplane/src/events/index.ts:33 | +| `SUITE_END` | `"endSuite"` | "endSuite" | testplane-docs/.testplane/src/events/index.ts:34 | +| `TEST_BEGIN` | `"beginTest"` | "beginTest" | testplane-docs/.testplane/src/events/index.ts:36 | +| `TEST_END` | `"endTest"` | "endTest" | testplane-docs/.testplane/src/events/index.ts:37 | +| `TEST_FAIL` | `"failTest"` | "failTest" | testplane-docs/.testplane/src/events/index.ts:40 | +| `TEST_PASS` | `"passTest"` | "passTest" | testplane-docs/.testplane/src/events/index.ts:39 | +| `TEST_PENDING` | `"pendingTest"` | "pendingTest" | testplane-docs/.testplane/src/events/index.ts:41 | +| `UPDATE_REFERENCE` | `"updateReference"` | "updateReference" | testplane-docs/.testplane/src/events/index.ts:98 | +| `WARNING` | `"warning"` | "warning" | testplane-docs/.testplane/src/events/index.ts:62 | + +#### Defined in + +testplane-docs/.testplane/src/base-testplane.ts:49 + +## Methods + +### \[captureRejectionSymbol\]()? + +```ts +optional [captureRejectionSymbol]( + error, + event, ... + args): void +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `error` | `Error` | +| `event` | `string` | +| ...`args` | `any`[] | + +#### Returns + +`void` + +#### Defined in + +testplane/node\_modules/@types/node/events.d.ts:115 + +*** + +### addListener() + +```ts +addListener(eventName, listener): this +``` + +Alias for `emitter.on(eventName, listener)`. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `eventName` | `string` \| `symbol` | +| `listener` | (...`args`) => `void` | + +#### Returns + +`this` + +#### Since + +v0.1.26 + +#### Defined in + +testplane/node\_modules/@types/node/events.d.ts:475 + +*** + +### addTestToRun() + +```ts +addTestToRun(test, browserId): boolean +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `test` | [`Test`](Test.mdx) | +| `browserId` | `string` | + +#### Returns + +`boolean` + +#### Defined in + +testplane-docs/.testplane/src/testplane.ts:152 + +*** + +### emit() + +```ts +emit(eventName, ...args): boolean +``` + +Synchronously calls each of the listeners registered for the event named`eventName`, in the order they were registered, passing the supplied arguments +to each. + +Returns `true` if the event had listeners, `false` otherwise. + +```js +const EventEmitter = require('events'); +const myEmitter = new EventEmitter(); + +// First listener +myEmitter.on('event', function firstListener() { + console.log('Helloooo! first listener'); +}); +// Second listener +myEmitter.on('event', function secondListener(arg1, arg2) { + console.log(`event with parameters ${arg1}, ${arg2} in second listener`); +}); +// Third listener +myEmitter.on('event', function thirdListener(...args) { + const parameters = args.join(', '); + console.log(`event with parameters ${parameters} in third listener`); +}); + +console.log(myEmitter.listeners('event')); + +myEmitter.emit('event', 1, 2, 3, 4, 5); + +// Prints: +// [ +// [Function: firstListener], +// [Function: secondListener], +// [Function: thirdListener] +// ] +// Helloooo! first listener +// event with parameters 1, 2 in second listener +// event with parameters 1, 2, 3, 4, 5 in third listener +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `eventName` | `string` \| `symbol` | +| ...`args` | `any`[] | + +#### Returns + +`boolean` + +#### Since + +v0.1.26 + +#### Defined in + +testplane/node\_modules/@types/node/events.d.ts:731 + +*** + +### emitAndWait() + +```ts +emitAndWait(event, ...args): Promise +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `event` | `string` \| `symbol` | +| ...`args` | `unknown`[] | + +#### Returns + +`Promise`\<`unknown`[]\> + +#### Defined in + +testplane-docs/.testplane/src/events/async-emitter/index.ts:5 + +*** + +### eventNames() + +```ts +eventNames(): (string | symbol)[] +``` + +Returns an array listing the events for which the emitter has registered +listeners. The values in the array are strings or `Symbol`s. + +```js +const EventEmitter = require('events'); +const myEE = new EventEmitter(); +myEE.on('foo', () => {}); +myEE.on('bar', () => {}); + +const sym = Symbol('symbol'); +myEE.on(sym, () => {}); + +console.log(myEE.eventNames()); +// Prints: [ 'foo', 'bar', Symbol(symbol) ] +``` + +#### Returns + +(`string` \| `symbol`)[] + +#### Since + +v6.0.0 + +#### Defined in + +testplane/node\_modules/@types/node/events.d.ts:794 + +*** + +### extendCli() + +```ts +extendCli(parser): void +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `parser` | `Command` | + +#### Returns + +`void` + +#### Defined in + +testplane-docs/.testplane/src/testplane.ts:75 + +*** + +### getMaxListeners() + +```ts +getMaxListeners(): number +``` + +Returns the current max listener value for the `EventEmitter` which is either +set by `emitter.setMaxListeners(n)` or defaults to defaultMaxListeners. + +#### Returns + +`number` + +#### Since + +v1.0.0 + +#### Defined in + +testplane/node\_modules/@types/node/events.d.ts:647 + +*** + +### halt() + +```ts +halt(err, timeout): void +``` + +#### Parameters + +| Parameter | Type | Default value | +| ------ | ------ | ------ | +| `err` | `Error` | `undefined` | +| `timeout` | `number` | `60000` | + +#### Returns + +`void` + +#### Defined in + +testplane-docs/.testplane/src/testplane.ts:207 + +*** + +### intercept() + +```ts +intercept(event, handler): this +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `event` | [`InterceptedEvent`](../type-aliases/InterceptedEvent.mdx) | +| `handler` | [`InterceptHandler`](../type-aliases/InterceptHandler.mdx) | + +#### Returns + +`this` + +#### Defined in + +testplane-docs/.testplane/src/base-testplane.ts:57 + +*** + +### isFailed() + +```ts +isFailed(): boolean +``` + +#### Returns + +`boolean` + +#### Defined in + +testplane-docs/.testplane/src/testplane.ts:187 + +*** + +### isWorker() + +```ts +isWorker(): boolean +``` + +#### Returns + +`boolean` + +#### Defined in + +testplane-docs/.testplane/src/testplane.ts:203 + +*** + +### listenerCount() + +```ts +listenerCount(eventName, listener?): number +``` + +Returns the number of listeners listening to the event named `eventName`. + +If `listener` is provided, it will return how many times the listener +is found in the list of the listeners of the event. + +#### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `eventName` | `string` \| `symbol` | Returns the number of listeners listening to the event named `eventName`. If `listener` is provided, it will return how many times the listener is found in the list of the listeners of the event. | +| `listener`? | `Function` | Returns the number of listeners listening to the event named `eventName`. If `listener` is provided, it will return how many times the listener is found in the list of the listeners of the event. | + +#### Returns + +`number` + +#### Since + +v3.2.0 + +#### Defined in + +testplane/node\_modules/@types/node/events.d.ts:741 + +*** + +### listeners() + +```ts +listeners(eventName): Function[] +``` + +Returns a copy of the array of listeners for the event named `eventName`. + +```js +server.on('connection', (stream) => { + console.log('someone connected!'); +}); +console.log(util.inspect(server.listeners('connection'))); +// Prints: [ [Function] ] +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `eventName` | `string` \| `symbol` | + +#### Returns + +`Function`[] + +#### Since + +v0.1.26 + +#### Defined in + +testplane/node\_modules/@types/node/events.d.ts:660 + +*** + +### off() + +```ts +off(eventName, listener): this +``` + +Alias for `emitter.removeListener()`. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `eventName` | `string` \| `symbol` | +| `listener` | (...`args`) => `void` | + +#### Returns + +`this` + +#### Since + +v10.0.0 + +#### Defined in + +testplane/node\_modules/@types/node/events.d.ts:620 + +*** + +### prependOnceListener() + +```ts +prependOnceListener(eventName, listener): this +``` + +Adds a **one-time**`listener` function for the event named `eventName` to the _beginning_ of the listeners array. The next time `eventName` is triggered, this +listener is removed, and then invoked. + +```js +server.prependOnceListener('connection', (stream) => { + console.log('Ah, we have our first user!'); +}); +``` + +Returns a reference to the `EventEmitter`, so that calls can be chained. + +#### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `eventName` | `string` \| `symbol` | Adds a **one-time**`listener` function for the event named `eventName` to the _beginning_ of the listeners array. The next time `eventName` is triggered, this listener is removed, and then invoked. `server.prependOnceListener('connection', (stream) => { console.log('Ah, we have our first user!'); });` Returns a reference to the `EventEmitter`, so that calls can be chained. | +| `listener` | (...`args`) => `void` | Adds a **one-time**`listener` function for the event named `eventName` to the _beginning_ of the listeners array. The next time `eventName` is triggered, this listener is removed, and then invoked. `server.prependOnceListener('connection', (stream) => { console.log('Ah, we have our first user!'); });` Returns a reference to the `EventEmitter`, so that calls can be chained. | + +#### Returns + +`this` + +#### Since + +v6.0.0 + +#### Defined in + +testplane/node\_modules/@types/node/events.d.ts:775 + +*** + +### rawListeners() + +```ts +rawListeners(eventName): Function[] +``` + +Returns a copy of the array of listeners for the event named `eventName`, +including any wrappers (such as those created by `.once()`). + +```js +const emitter = new EventEmitter(); +emitter.once('log', () => console.log('log once')); + +// Returns a new Array with a function `onceWrapper` which has a property +// `listener` which contains the original listener bound above +const listeners = emitter.rawListeners('log'); +const logFnWrapper = listeners[0]; + +// Logs "log once" to the console and does not unbind the `once` event +logFnWrapper.listener(); + +// Logs "log once" to the console and removes the listener +logFnWrapper(); + +emitter.on('log', () => console.log('log persistently')); +// Will return a new Array with a single function bound by `.on()` above +const newListeners = emitter.rawListeners('log'); + +// Logs "log persistently" twice +newListeners[0](); +emitter.emit('log'); +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `eventName` | `string` \| `symbol` | + +#### Returns + +`Function`[] + +#### Since + +v9.4.0 + +#### Defined in + +testplane/node\_modules/@types/node/events.d.ts:690 + +*** + +### readTests() + +```ts +readTests(testPaths, __namedParameters): Promise +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `testPaths` | `string`[] | +| `__namedParameters` | `Partial`\<[`ReadTestsOpts`](../interfaces/ReadTestsOpts.mdx)\> | + +#### Returns + +`Promise`\<[`TestCollection`](TestCollection.mdx)\> + +#### Defined in + +testplane-docs/.testplane/src/testplane.ts:156 + +*** + +### removeAllListeners() + +```ts +removeAllListeners(event?): this +``` + +Removes all listeners, or those of the specified `eventName`. + +It is bad practice to remove listeners added elsewhere in the code, +particularly when the `EventEmitter` instance was created by some other +component or module (e.g. sockets or file streams). + +Returns a reference to the `EventEmitter`, so that calls can be chained. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `event`? | `string` \| `symbol` | + +#### Returns + +`this` + +#### Since + +v0.1.26 + +#### Defined in + +testplane/node\_modules/@types/node/events.d.ts:631 + +*** + +### removeListener() + +```ts +removeListener(eventName, listener): this +``` + +Removes the specified `listener` from the listener array for the event named`eventName`. + +```js +const callback = (stream) => { + console.log('someone connected!'); +}; +server.on('connection', callback); +// ... +server.removeListener('connection', callback); +``` + +`removeListener()` will remove, at most, one instance of a listener from the +listener array. If any single listener has been added multiple times to the +listener array for the specified `eventName`, then `removeListener()` must be +called multiple times to remove each instance. + +Once an event is emitted, all listeners attached to it at the +time of emitting are called in order. This implies that any`removeListener()` or `removeAllListeners()` calls _after_ emitting and _before_ the last listener finishes execution +will not remove them from`emit()` in progress. Subsequent events behave as expected. + +```js +const myEmitter = new MyEmitter(); + +const callbackA = () => { + console.log('A'); + myEmitter.removeListener('event', callbackB); +}; + +const callbackB = () => { + console.log('B'); +}; + +myEmitter.on('event', callbackA); + +myEmitter.on('event', callbackB); + +// callbackA removes listener callbackB but it will still be called. +// Internal listener array at time of emit [callbackA, callbackB] +myEmitter.emit('event'); +// Prints: +// A +// B + +// callbackB is now removed. +// Internal listener array [callbackA] +myEmitter.emit('event'); +// Prints: +// A +``` + +Because listeners are managed using an internal array, calling this will +change the position indices of any listener registered _after_ the listener +being removed. This will not impact the order in which listeners are called, +but it means that any copies of the listener array as returned by +the `emitter.listeners()` method will need to be recreated. + +When a single function has been added as a handler multiple times for a single +event (as in the example below), `removeListener()` will remove the most +recently added instance. In the example the `once('ping')`listener is removed: + +```js +const ee = new EventEmitter(); + +function pong() { + console.log('pong'); +} + +ee.on('ping', pong); +ee.once('ping', pong); +ee.removeListener('ping', pong); + +ee.emit('ping'); +ee.emit('ping'); +``` + +Returns a reference to the `EventEmitter`, so that calls can be chained. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `eventName` | `string` \| `symbol` | +| `listener` | (...`args`) => `void` | + +#### Returns + +`this` + +#### Since + +v0.1.26 + +#### Defined in + +testplane/node\_modules/@types/node/events.d.ts:615 + +*** + +### run() + +```ts +run(testPaths, __namedParameters): Promise +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `testPaths` | `string`[] \| [`TestCollection`](TestCollection.mdx) | +| `__namedParameters` | `Partial`\<[`RunOpts`](../interfaces/RunOpts.mdx)\> | + +#### Returns + +`Promise`\<`boolean`\> + +#### Defined in + +testplane-docs/.testplane/src/testplane.ts:89 + +*** + +### setMaxListeners() + +```ts +setMaxListeners(n): this +``` + +By default `EventEmitter`s will print a warning if more than `10` listeners are +added for a particular event. This is a useful default that helps finding +memory leaks. The `emitter.setMaxListeners()` method allows the limit to be +modified for this specific `EventEmitter` instance. The value can be set to`Infinity` (or `0`) to indicate an unlimited number of listeners. + +Returns a reference to the `EventEmitter`, so that calls can be chained. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `n` | `number` | + +#### Returns + +`this` + +#### Since + +v0.3.5 + +#### Defined in + +testplane/node\_modules/@types/node/events.d.ts:641 + +*** + +### addAbortListener() + +```ts +static addAbortListener(signal, resource): Disposable +``` + +**`Experimental`** + +Listens once to the `abort` event on the provided `signal`. + +Listening to the `abort` event on abort signals is unsafe and may +lead to resource leaks since another third party with the signal can +call `e.stopImmediatePropagation()`. Unfortunately Node.js cannot change +this since it would violate the web standard. Additionally, the original +API makes it easy to forget to remove listeners. + +This API allows safely using `AbortSignal`s in Node.js APIs by solving these +two issues by listening to the event such that `stopImmediatePropagation` does +not prevent the listener from running. + +Returns a disposable so that it may be unsubscribed from more easily. + +```js +import { addAbortListener } from 'node:events'; + +function example(signal) { + let disposable; + try { + signal.addEventListener('abort', (e) => e.stopImmediatePropagation()); + disposable = addAbortListener(signal, (e) => { + // Do something when signal is aborted. + }); + } finally { + disposable?.[Symbol.dispose](); + } +} +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `signal` | `AbortSignal` | +| `resource` | (`event`) => `void` | + +#### Returns + +`Disposable` + +Disposable that removes the `abort` listener. + +#### Since + +v18.18.0 + +#### Defined in + +testplane/node\_modules/@types/node/events.d.ts:394 + +*** + +### create() + +```ts +static create(this, config?): T +``` + +#### Type Parameters + +| Type Parameter | +| ------ | +| `T` *extends* `BaseTestplane` | + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `this` | (`config`?) => `T` | +| `config`? | `string` \| [`ConfigInput`](../type-aliases/ConfigInput.mdx) | + +#### Returns + +`T` + +#### Defined in + +testplane-docs/.testplane/src/base-testplane.ts:21 + +*** + +### getEventListeners() + +```ts +static getEventListeners(emitter, name): Function[] +``` + +Returns a copy of the array of listeners for the event named `eventName`. + +For `EventEmitter`s this behaves exactly the same as calling `.listeners` on +the emitter. + +For `EventTarget`s this is the only way to get the event listeners for the +event target. This is useful for debugging and diagnostic purposes. + +```js +const { getEventListeners, EventEmitter } = require('events'); + +{ + const ee = new EventEmitter(); + const listener = () => console.log('Events are fun'); + ee.on('foo', listener); + getEventListeners(ee, 'foo'); // [listener] +} +{ + const et = new EventTarget(); + const listener = () => console.log('Events are fun'); + et.addEventListener('foo', listener); + getEventListeners(et, 'foo'); // [listener] +} +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `emitter` | `EventEmitter` \| `_DOMEventTarget` | +| `name` | `string` \| `symbol` | + +#### Returns + +`Function`[] + +#### Since + +v15.2.0, v14.17.0 + +#### Defined in + +testplane/node\_modules/@types/node/events.d.ts:312 + +*** + +### getMaxListeners() + +```ts +static getMaxListeners(emitter): number +``` + +Returns the current max listener value for the `EventEmitter` which is either +set by `emitter.setMaxListeners(n)` or defaults to defaultMaxListeners. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `emitter` | `EventEmitter` \| `_DOMEventTarget` | + +#### Returns + +`number` + +#### Since + +v1.0.0 + +#### Defined in + +testplane/node\_modules/@types/node/events.d.ts:341 + +*** + +### ~~listenerCount()~~ + +```ts +static listenerCount(emitter, eventName): number +``` + +Returns the number of listeners listening to the event named `eventName`. + +If `listener` is provided, it will return how many times the listener +is found in the list of the listeners of the event. + +#### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `emitter` | `EventEmitter` | Returns the number of listeners listening to the event named `eventName`. If `listener` is provided, it will return how many times the listener is found in the list of the listeners of the event. | +| `eventName` | `string` \| `symbol` | Returns the number of listeners listening to the event named `eventName`. If `listener` is provided, it will return how many times the listener is found in the list of the listeners of the event. | + +#### Returns + +`number` + +#### Since + +v3.2.0 + +#### Deprecated + +Since v3.2.0 - Use `listenerCount` instead. + +#### Defined in + +testplane/node\_modules/@types/node/events.d.ts:284 + +*** + +### on() + +```ts +static on( + emitter, + eventName, +options?): AsyncIterableIterator +``` + +```js +const { on, EventEmitter } = require('events'); + +(async () => { + const ee = new EventEmitter(); + + // Emit later on + process.nextTick(() => { + ee.emit('foo', 'bar'); + ee.emit('foo', 42); + }); + + for await (const event of on(ee, 'foo')) { + // The execution of this inner block is synchronous and it + // processes one event at a time (even with await). Do not use + // if concurrent execution is required. + console.log(event); // prints ['bar'] [42] + } + // Unreachable here +})(); +``` + +Returns an `AsyncIterator` that iterates `eventName` events. It will throw +if the `EventEmitter` emits `'error'`. It removes all listeners when +exiting the loop. The `value` returned by each iteration is an array +composed of the emitted event arguments. + +An `AbortSignal` can be used to cancel waiting on events: + +```js +const { on, EventEmitter } = require('events'); +const ac = new AbortController(); + +(async () => { + const ee = new EventEmitter(); + + // Emit later on + process.nextTick(() => { + ee.emit('foo', 'bar'); + ee.emit('foo', 42); + }); + + for await (const event of on(ee, 'foo', { signal: ac.signal })) { + // The execution of this inner block is synchronous and it + // processes one event at a time (even with await). Do not use + // if concurrent execution is required. + console.log(event); // prints ['bar'] [42] + } + // Unreachable here +})(); + +process.nextTick(() => ac.abort()); +``` + +#### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `emitter` | `EventEmitter` | - | +| `eventName` | `string` | `const { on, EventEmitter } = require('events'); (async () => { const ee = new EventEmitter(); // Emit later on process.nextTick(() => { ee.emit('foo', 'bar'); ee.emit('foo', 42); }); for await (const event of on(ee, 'foo')) { // The execution of this inner block is synchronous and it // processes one event at a time (even with await). Do not use // if concurrent execution is required. console.log(event); // prints ['bar'] [42] } // Unreachable here })();` Returns an `AsyncIterator` that iterates `eventName` events. It will throw if the `EventEmitter` emits `'error'`. It removes all listeners when exiting the loop. The `value` returned by each iteration is an array composed of the emitted event arguments. An `AbortSignal` can be used to cancel waiting on events: `const { on, EventEmitter } = require('events'); const ac = new AbortController(); (async () => { const ee = new EventEmitter(); // Emit later on process.nextTick(() => { ee.emit('foo', 'bar'); ee.emit('foo', 42); }); for await (const event of on(ee, 'foo', { signal: ac.signal })) { // The execution of this inner block is synchronous and it // processes one event at a time (even with await). Do not use // if concurrent execution is required. console.log(event); // prints ['bar'] [42] } // Unreachable here })(); process.nextTick(() => ac.abort());` | +| `options`? | `StaticEventEmitterOptions` | - | + +#### Returns + +`AsyncIterableIterator`\<`any`\> + +that iterates `eventName` events emitted by the `emitter` + +#### Since + +v13.6.0, v12.16.0 + +#### Defined in + +testplane/node\_modules/@types/node/events.d.ts:263 + +*** + +### once() + +#### once(emitter, eventName, options) + +```ts +static once( + emitter, + eventName, +options?): Promise +``` + +Creates a `Promise` that is fulfilled when the `EventEmitter` emits the given +event or that is rejected if the `EventEmitter` emits `'error'` while waiting. +The `Promise` will resolve with an array of all the arguments emitted to the +given event. + +This method is intentionally generic and works with the web platform [EventTarget](https://dom.spec.whatwg.org/#interface-eventtarget) interface, which has no special`'error'` event +semantics and does not listen to the `'error'` event. + +```js +const { once, EventEmitter } = require('events'); + +async function run() { + const ee = new EventEmitter(); + + process.nextTick(() => { + ee.emit('myevent', 42); + }); + + const [value] = await once(ee, 'myevent'); + console.log(value); + + const err = new Error('kaboom'); + process.nextTick(() => { + ee.emit('error', err); + }); + + try { + await once(ee, 'myevent'); + } catch (err) { + console.log('error happened', err); + } +} + +run(); +``` + +The special handling of the `'error'` event is only used when `events.once()`is used to wait for another event. If `events.once()` is used to wait for the +'`error'` event itself, then it is treated as any other kind of event without +special handling: + +```js +const { EventEmitter, once } = require('events'); + +const ee = new EventEmitter(); + +once(ee, 'error') + .then(([err]) => console.log('ok', err.message)) + .catch((err) => console.log('error', err.message)); + +ee.emit('error', new Error('boom')); + +// Prints: ok boom +``` + +An `AbortSignal` can be used to cancel waiting for the event: + +```js +const { EventEmitter, once } = require('events'); + +const ee = new EventEmitter(); +const ac = new AbortController(); + +async function foo(emitter, event, signal) { + try { + await once(emitter, event, { signal }); + console.log('event emitted!'); + } catch (error) { + if (error.name === 'AbortError') { + console.error('Waiting for the event was canceled!'); + } else { + console.error('There was an error', error.message); + } + } +} + +foo(ee, 'foo', ac.signal); +ac.abort(); // Abort waiting for the event +ee.emit('foo'); // Prints: Waiting for the event was canceled! +``` + +##### Parameters + +| Parameter | Type | +| ------ | ------ | +| `emitter` | `_NodeEventTarget` | +| `eventName` | `string` \| `symbol` | +| `options`? | `StaticEventEmitterOptions` | + +##### Returns + +`Promise`\<`any`[]\> + +##### Since + +v11.13.0, v10.16.0 + +##### Defined in + +testplane/node\_modules/@types/node/events.d.ts:199 + +#### once(emitter, eventName, options) + +```ts +static once( + emitter, + eventName, +options?): Promise +``` + +##### Parameters + +| Parameter | Type | +| ------ | ------ | +| `emitter` | `_DOMEventTarget` | +| `eventName` | `string` | +| `options`? | `StaticEventEmitterOptions` | + +##### Returns + +`Promise`\<`any`[]\> + +##### Defined in + +testplane/node\_modules/@types/node/events.d.ts:204 + +*** + +### setMaxListeners() + +```ts +static setMaxListeners(n?, ...eventTargets?): void +``` + +By default `EventEmitter`s will print a warning if more than `10` listeners are +added for a particular event. This is a useful default that helps finding +memory leaks. The `emitter.setMaxListeners()` method allows the limit to be +modified for this specific `EventEmitter` instance. The value can be set to`Infinity` (or `0`) to indicate an unlimited number of listeners. + +Returns a reference to the `EventEmitter`, so that calls can be chained. + +#### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `n`? | `number` | By default `EventEmitter`s will print a warning if more than `10` listeners are added for a particular event. This is a useful default that helps finding memory leaks. The `emitter.setMaxListeners()` method allows the limit to be modified for this specific `EventEmitter` instance. The value can be set to`Infinity` (or `0`) to indicate an unlimited number of listeners. Returns a reference to the `EventEmitter`, so that calls can be chained. | +| ...`eventTargets`? | (`EventEmitter` \| `_DOMEventTarget`)[] | - | + +#### Returns + +`void` + +#### Since + +v0.3.5 + +#### Defined in + +testplane/node\_modules/@types/node/events.d.ts:359 diff --git a/docs/api-reference/classes/TestplaneInternalError.mdx b/docs/api-reference/classes/TestplaneInternalError.mdx new file mode 100644 index 0000000..aa54e1e --- /dev/null +++ b/docs/api-reference/classes/TestplaneInternalError.mdx @@ -0,0 +1,72 @@ +[testplane](../README.mdx) / TestplaneInternalError + +# Class: TestplaneInternalError + +## Extends + +- `Error` + +## Constructors + +### new TestplaneInternalError() + +```ts +new TestplaneInternalError(message): TestplaneInternalError +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +#### Returns + +[`TestplaneInternalError`](TestplaneInternalError.mdx) + +#### Overrides + +`Error.constructor` + +#### Defined in + +testplane-docs/.testplane/src/errors/testplane-internal-error.ts:2 + +## Properties + +| Property | Modifier | Type | Description | Inherited from | Defined in | +| ------ | ------ | ------ | ------ | ------ | ------ | +| `message` | `public` | `string` | - | `Error.message` | testplane-docs/node\_modules/typescript/lib/lib.es5.d.ts:1077 | +| `name` | `public` | `string` | - | `Error.name` | testplane-docs/node\_modules/typescript/lib/lib.es5.d.ts:1076 | +| `stack?` | `public` | `string` | - | `Error.stack` | testplane-docs/node\_modules/typescript/lib/lib.es5.d.ts:1078 | +| `prepareStackTrace?` | `static` | (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` | Optional override for formatting stack traces **See** https://v8.dev/docs/stack-trace-api#customizing-stack-traces | `Error.prepareStackTrace` | testplane/node\_modules/@types/node/globals.d.ts:27 | +| `stackTraceLimit` | `static` | `number` | - | `Error.stackTraceLimit` | testplane/node\_modules/@types/node/globals.d.ts:29 | + +## Methods + +### captureStackTrace() + +```ts +static captureStackTrace(targetObject, constructorOpt?): void +``` + +Create .stack property on a target object + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `targetObject` | `object` | +| `constructorOpt`? | `Function` | + +#### Returns + +`void` + +#### Inherited from + +`Error.captureStackTrace` + +#### Defined in + +testplane/node\_modules/@types/node/globals.d.ts:20 diff --git a/docs/api-reference/interfaces/AfterFileReadData.mdx b/docs/api-reference/interfaces/AfterFileReadData.mdx new file mode 100644 index 0000000..fc4002a --- /dev/null +++ b/docs/api-reference/interfaces/AfterFileReadData.mdx @@ -0,0 +1,16 @@ +[testplane](../README.mdx) / AfterFileReadData + +# Interface: AfterFileReadData + +## Extended by + +- [`BeforeFileReadData`](BeforeFileReadData.mdx) + +## Properties + +| Property | Type | Description | Defined in | +| ------ | ------ | ------ | ------ | +| `browser` | `string` | - | testplane-docs/.testplane/src/types/index.ts:176 | +| `file` | `string` | - | testplane-docs/.testplane/src/types/index.ts:177 | +| ~~`hermione`~~ | [`GlobalHelper`](GlobalHelper.mdx) | **Deprecated** Use `testplane` instead | testplane-docs/.testplane/src/types/index.ts:175 | +| `testplane` | [`GlobalHelper`](GlobalHelper.mdx) | - | testplane-docs/.testplane/src/types/index.ts:171 | diff --git a/docs/api-reference/interfaces/AssertViewOpts.mdx b/docs/api-reference/interfaces/AssertViewOpts.mdx new file mode 100644 index 0000000..142574c --- /dev/null +++ b/docs/api-reference/interfaces/AssertViewOpts.mdx @@ -0,0 +1,22 @@ +[testplane](../README.mdx) / AssertViewOpts + +# Interface: AssertViewOpts + +## Extends + +- `Partial`\<[`AssertViewOptsConfig`](AssertViewOptsConfig.mdx)\> + +## Properties + +| Property | Type | Default value | Description | Inherited from | Defined in | +| ------ | ------ | ------ | ------ | ------ | ------ | +| `allowViewportOverflow?` | `boolean` | `false` | Disables check that element is outside of the viewport left, top, right or bottom bounds. **Remarks** By default Testplane throws an error if element is outside the viewport bounds. This option disables check that element is outside of the viewport left, top, right or bottom bounds. And in this case if browser option [https://github.com/gemini-testing/testplane#compositeimage compositeImage](https://github.com/gemini-testing/testplane#compositeimage) set to `false`, then only visible part of the element will be captured. But if [https://github.com/gemini-testing/testplane#compositeimage compositeImage](https://github.com/gemini-testing/testplane#compositeimage) set to `true` (default), then in the resulting screenshot will appear the whole element with not visible parts outside of the bottom bounds of viewport. | `Partial.allowViewportOverflow` | testplane-docs/.testplane/src/config/types.ts:45 | +| `antialiasingTolerance?` | `number` | `4` | Minimum difference in brightness (zero by default) between the darkest/lightest pixel (which is adjacent to the antialiasing pixel) and theirs adjacent pixels. Overrides config https://github.com/gemini-testing/testplane#browsers browsers.https://github.com/gemini-testing/testplane#antialiasingTolerance antialiasingTolerance value. **Remarks** Read more about this option in [https://github.com/gemini-testing/looks-same#comparing-images-with-ignoring-antialiasing looks-same](https://github.com/gemini-testing/looks-same#comparing-images-with-ignoring-antialiasing) | - | testplane-docs/.testplane/src/browser/commands/types.ts:26 | +| `captureElementFromTop?` | `boolean` | `true` | Ability to set capture element from the top area or from current position. **Remarks** In the first case viewport will be scrolled to the top of the element. | `Partial.captureElementFromTop` | testplane-docs/.testplane/src/config/types.ts:33 | +| `compositeImage?` | `boolean` | `true` | Allows testing of regions which bottom bounds are outside of a viewport height. Overrides config https://github.com/gemini-testing/testplane#browsers browsers.https://github.com/gemini-testing/testplane#compositeImage compositeImage value. **Remarks** In the resulting screenshot the area which fits the viewport bounds will be joined with the area which is outside of the viewport height. | - | testplane-docs/.testplane/src/browser/commands/types.ts:36 | +| `disableAnimation?` | `boolean` | `true` | Ability to disable animations and transitions while making a screenshot **Remarks** Usefull when you capture screenshot of a page, having animations and transitions. Iframe animations are only disabled when using webdriver protocol. | - | testplane-docs/.testplane/src/browser/commands/types.ts:67 | +| `ignoreDiffPixelCount?` | `number` \| \`$\{number\}%\` | `0` | Ability to ignore a small amount of different pixels to classify screenshots as being "identical" **Examples** `5` `'1.5%'` **Remarks** Useful when you encounter a few pixels difference that cannot be eliminated using the tolerance and antialiasingTolerance settings. **Note** This should be considered a last resort and only used in small number of cases where necessary. | - | testplane-docs/.testplane/src/browser/commands/types.ts:82 | +| `ignoreElements?` | `string` \| `string`[] | `[]` | DOM-node selectors which will be ignored (painted with a black rectangle) when comparing images. | `Partial.ignoreElements` | testplane-docs/.testplane/src/config/types.ts:24 | +| `screenshotDelay?` | `number` | `0` | Allows to specify a delay (in milliseconds) before making any screenshot. Overrides config https://github.com/gemini-testing/testplane#browsers browsers.https://github.com/gemini-testing/testplane#screenshotDelay screenshotDelay value. **Remarks** This is useful when the page has elements which are animated or if you do not want to screen a scrollbar. | - | testplane-docs/.testplane/src/browser/commands/types.ts:46 | +| `selectorToScroll?` | `string` | `undefined` | Ability to set DOM-node selector which should be scroll when the captured element does not completely fit on the screen. **Remarks** Useful when you capture the modal (popup). In this case a duplicate of the modal appears on the screenshot. That happens because we scroll the page using `window` selector, which scroll only the background of the modal, and the modal itself remains in place. Default value is `undefined` (it means scroll relative to `window`). Works only when `compositeImage` is `true` (default). | - | testplane-docs/.testplane/src/browser/commands/types.ts:57 | +| `tolerance?` | `number` | `2.3` | Maximum allowed difference between colors. Overrides config https://github.com/gemini-testing/testplane#browsers browsers.https://github.com/gemini-testing/testplane#tolerance tolerance value. **Remarks** Indicates maximum allowed CIEDE2000 difference between colors. Used only in non-strict mode. Increasing global default is not recommended, prefer changing tolerance for particular suites or states instead. By default it's 2.3 which should be enough for the most cases. | - | testplane-docs/.testplane/src/browser/commands/types.ts:16 | diff --git a/docs/api-reference/interfaces/AssertViewOptsConfig.mdx b/docs/api-reference/interfaces/AssertViewOptsConfig.mdx new file mode 100644 index 0000000..030940f --- /dev/null +++ b/docs/api-reference/interfaces/AssertViewOptsConfig.mdx @@ -0,0 +1,11 @@ +[testplane](../README.mdx) / AssertViewOptsConfig + +# Interface: AssertViewOptsConfig + +## Properties + +| Property | Type | Default value | Description | Defined in | +| ------ | ------ | ------ | ------ | ------ | +| `allowViewportOverflow` | `boolean` | `false` | Disables check that element is outside of the viewport left, top, right or bottom bounds. **Remarks** By default Testplane throws an error if element is outside the viewport bounds. This option disables check that element is outside of the viewport left, top, right or bottom bounds. And in this case if browser option [https://github.com/gemini-testing/testplane#compositeimage compositeImage](https://github.com/gemini-testing/testplane#compositeimage) set to `false`, then only visible part of the element will be captured. But if [https://github.com/gemini-testing/testplane#compositeimage compositeImage](https://github.com/gemini-testing/testplane#compositeimage) set to `true` (default), then in the resulting screenshot will appear the whole element with not visible parts outside of the bottom bounds of viewport. | testplane-docs/.testplane/src/config/types.ts:45 | +| `captureElementFromTop` | `boolean` | `true` | Ability to set capture element from the top area or from current position. **Remarks** In the first case viewport will be scrolled to the top of the element. | testplane-docs/.testplane/src/config/types.ts:33 | +| `ignoreElements` | `string` \| `string`[] | `[]` | DOM-node selectors which will be ignored (painted with a black rectangle) when comparing images. | testplane-docs/.testplane/src/config/types.ts:24 | diff --git a/docs/api-reference/interfaces/AssertViewResultDiff.mdx b/docs/api-reference/interfaces/AssertViewResultDiff.mdx new file mode 100644 index 0000000..0846dbf --- /dev/null +++ b/docs/api-reference/interfaces/AssertViewResultDiff.mdx @@ -0,0 +1,19 @@ +[testplane](../README.mdx) / AssertViewResultDiff + +# Interface: AssertViewResultDiff + +## Properties + +| Property | Type | Defined in | +| ------ | ------ | ------ | +| `currImg` | [`ImageInfo`](ImageInfo.mdx) | testplane-docs/.testplane/src/types/index.ts:83 | +| `diffBuffer?` | `ArrayBuffer` | testplane-docs/.testplane/src/types/index.ts:84 | +| `diffClusters` | `CoordBounds`[] | testplane-docs/.testplane/src/types/index.ts:85 | +| `diffOpts` | [`DiffOptions`](DiffOptions.mdx) | testplane-docs/.testplane/src/types/index.ts:86 | +| `diffRatio` | `number` | testplane-docs/.testplane/src/types/index.ts:93 | +| `differentPixels` | `number` | testplane-docs/.testplane/src/types/index.ts:92 | +| `message` | `string` | testplane-docs/.testplane/src/types/index.ts:87 | +| `name` | `"ImageDiffError"` | testplane-docs/.testplane/src/types/index.ts:88 | +| `refImg` | [`RefImageInfo`](RefImageInfo.mdx) | testplane-docs/.testplane/src/types/index.ts:89 | +| `stack` | `string` | testplane-docs/.testplane/src/types/index.ts:90 | +| `stateName` | `string` | testplane-docs/.testplane/src/types/index.ts:91 | diff --git a/docs/api-reference/interfaces/AssertViewResultNoRefImage.mdx b/docs/api-reference/interfaces/AssertViewResultNoRefImage.mdx new file mode 100644 index 0000000..a6a86f0 --- /dev/null +++ b/docs/api-reference/interfaces/AssertViewResultNoRefImage.mdx @@ -0,0 +1,14 @@ +[testplane](../README.mdx) / AssertViewResultNoRefImage + +# Interface: AssertViewResultNoRefImage + +## Properties + +| Property | Type | Defined in | +| ------ | ------ | ------ | +| `currImg` | [`ImageInfo`](ImageInfo.mdx) | testplane-docs/.testplane/src/types/index.ts:97 | +| `message` | `string` | testplane-docs/.testplane/src/types/index.ts:98 | +| `name` | `"NoRefImageError"` | testplane-docs/.testplane/src/types/index.ts:99 | +| `refImg` | [`RefImageInfo`](RefImageInfo.mdx) | testplane-docs/.testplane/src/types/index.ts:100 | +| `stack` | `string` | testplane-docs/.testplane/src/types/index.ts:101 | +| `stateName` | `string` | testplane-docs/.testplane/src/types/index.ts:102 | diff --git a/docs/api-reference/interfaces/AssertViewResultSuccess.mdx b/docs/api-reference/interfaces/AssertViewResultSuccess.mdx new file mode 100644 index 0000000..66fbcf6 --- /dev/null +++ b/docs/api-reference/interfaces/AssertViewResultSuccess.mdx @@ -0,0 +1,10 @@ +[testplane](../README.mdx) / AssertViewResultSuccess + +# Interface: AssertViewResultSuccess + +## Properties + +| Property | Type | Defined in | +| ------ | ------ | ------ | +| `refImg` | [`RefImageInfo`](RefImageInfo.mdx) | testplane-docs/.testplane/src/types/index.ts:78 | +| `stateName` | `string` | testplane-docs/.testplane/src/types/index.ts:79 | diff --git a/docs/api-reference/interfaces/BeforeFileReadData.mdx b/docs/api-reference/interfaces/BeforeFileReadData.mdx new file mode 100644 index 0000000..72559ac --- /dev/null +++ b/docs/api-reference/interfaces/BeforeFileReadData.mdx @@ -0,0 +1,17 @@ +[testplane](../README.mdx) / BeforeFileReadData + +# Interface: BeforeFileReadData + +## Extends + +- [`AfterFileReadData`](AfterFileReadData.mdx) + +## Properties + +| Property | Type | Description | Inherited from | Defined in | +| ------ | ------ | ------ | ------ | ------ | +| `browser` | `string` | - | [`AfterFileReadData`](AfterFileReadData.mdx).`browser` | testplane-docs/.testplane/src/types/index.ts:176 | +| `file` | `string` | - | [`AfterFileReadData`](AfterFileReadData.mdx).`file` | testplane-docs/.testplane/src/types/index.ts:177 | +| ~~`hermione`~~ | [`GlobalHelper`](GlobalHelper.mdx) | **Deprecated** Use `testplane` instead | [`AfterFileReadData`](AfterFileReadData.mdx).`hermione` | testplane-docs/.testplane/src/types/index.ts:175 | +| `testParser` | `TestParserAPI` | - | - | testplane-docs/.testplane/src/types/index.ts:181 | +| `testplane` | [`GlobalHelper`](GlobalHelper.mdx) | - | [`AfterFileReadData`](AfterFileReadData.mdx).`testplane` | testplane-docs/.testplane/src/types/index.ts:171 | diff --git a/docs/api-reference/interfaces/BrowserHistory.mdx b/docs/api-reference/interfaces/BrowserHistory.mdx new file mode 100644 index 0000000..e60e2fe --- /dev/null +++ b/docs/api-reference/interfaces/BrowserHistory.mdx @@ -0,0 +1,9 @@ +[testplane](../README.mdx) / BrowserHistory + +# Interface: BrowserHistory + +## Properties + +| Property | Type | Defined in | +| ------ | ------ | ------ | +| `runGroup` | (`callstack`: `Callstack`, `name`: `string`, `fn`: () => `unknown`) => `Promise`\<`unknown`\> | testplane-docs/.testplane/src/types/index.ts:185 | diff --git a/docs/api-reference/interfaces/BrowserInfo.mdx b/docs/api-reference/interfaces/BrowserInfo.mdx new file mode 100644 index 0000000..cd0c869 --- /dev/null +++ b/docs/api-reference/interfaces/BrowserInfo.mdx @@ -0,0 +1,10 @@ +[testplane](../README.mdx) / BrowserInfo + +# Interface: BrowserInfo + +## Properties + +| Property | Type | Defined in | +| ------ | ------ | ------ | +| `browserId` | `string` | testplane-docs/.testplane/src/types/index.ts:32 | +| `sessionId` | `string` | testplane-docs/.testplane/src/types/index.ts:33 | diff --git a/docs/api-reference/interfaces/BuildDiffOptsConfig.mdx b/docs/api-reference/interfaces/BuildDiffOptsConfig.mdx new file mode 100644 index 0000000..af5bdf1 --- /dev/null +++ b/docs/api-reference/interfaces/BuildDiffOptsConfig.mdx @@ -0,0 +1,10 @@ +[testplane](../README.mdx) / BuildDiffOptsConfig + +# Interface: BuildDiffOptsConfig + +## Properties + +| Property | Type | Defined in | +| ------ | ------ | ------ | +| `ignoreAntialiasing` | `boolean` | testplane-docs/.testplane/src/config/types.ts:14 | +| `ignoreCaret` | `boolean` | testplane-docs/.testplane/src/config/types.ts:15 | diff --git a/docs/api-reference/interfaces/CommandHistory.mdx b/docs/api-reference/interfaces/CommandHistory.mdx new file mode 100644 index 0000000..6be0bf8 --- /dev/null +++ b/docs/api-reference/interfaces/CommandHistory.mdx @@ -0,0 +1,15 @@ +[testplane](../README.mdx) / CommandHistory + +# Interface: CommandHistory + +## Properties + +| Property | Type | Description | Defined in | +| ------ | ------ | ------ | ------ | +| `a` | `unknown`[] | Arguments: array of passed arguments | testplane-docs/.testplane/src/types/index.ts:111 | +| `c` | [`CommandHistory`](CommandHistory.mdx)[] | Children: array of children commands | testplane-docs/.testplane/src/types/index.ts:121 | +| `d` | `number` | Duration | testplane-docs/.testplane/src/types/index.ts:117 | +| `n` | `string` | Name: command name | testplane-docs/.testplane/src/types/index.ts:109 | +| `s` | `"b"` \| `"e"` | Scope: scope of execution (browser or element) | testplane-docs/.testplane/src/types/index.ts:119 | +| `te` | `number` | Time end | testplane-docs/.testplane/src/types/index.ts:115 | +| `ts` | `number` | Time start | testplane-docs/.testplane/src/types/index.ts:113 | diff --git a/docs/api-reference/interfaces/CommonConfig.mdx b/docs/api-reference/interfaces/CommonConfig.mdx new file mode 100644 index 0000000..662b570 --- /dev/null +++ b/docs/api-reference/interfaces/CommonConfig.mdx @@ -0,0 +1,146 @@ +[testplane](../README.mdx) / CommonConfig + +# Interface: CommonConfig + +## Extended by + +- [`Config`](../classes/Config.mdx) + +## Properties + +| Property | Type | Defined in | +| ------ | ------ | ------ | +| `antialiasingTolerance` | `number` | testplane-docs/.testplane/src/config/types.ts:133 | +| `assertViewOpts` | [`AssertViewOptsConfig`](AssertViewOptsConfig.mdx) | testplane-docs/.testplane/src/config/types.ts:136 | +| `automationProtocol` | `"webdriver"` \| `"devtools"` | testplane-docs/.testplane/src/config/types.ts:97 | +| `baseUrl` | `string` | testplane-docs/.testplane/src/config/types.ts:104 | +| `buildDiffOpts` | [`BuildDiffOptsConfig`](BuildDiffOptsConfig.mdx) | testplane-docs/.testplane/src/config/types.ts:135 | +| `calibrate` | `boolean` | testplane-docs/.testplane/src/config/types.ts:127 | +| `compareOpts` | [`CompareOptsConfig`](CompareOptsConfig.mdx) | testplane-docs/.testplane/src/config/types.ts:134 | +| `compositeImage` | `boolean` | testplane-docs/.testplane/src/config/types.ts:128 | +| `configPath?` | `string` | testplane-docs/.testplane/src/config/types.ts:96 | +| `desiredCapabilities` | `null` \| `Capabilities` | testplane-docs/.testplane/src/config/types.ts:98 | +| `devServer` | \{ `args`: `string`[]; `command`: `null` \| `string`; `cwd`: `null` \| `string`; `env`: `Record`\<`string`, `string`\>; `logs`: `boolean`; `readinessProbe`: `ReadinessProbe`; \} | testplane-docs/.testplane/src/config/types.ts:170 | +| `devServer.args` | `string`[] | testplane-docs/.testplane/src/config/types.ts:174 | +| `devServer.command` | `null` \| `string` | testplane-docs/.testplane/src/config/types.ts:171 | +| `devServer.cwd` | `null` \| `string` | testplane-docs/.testplane/src/config/types.ts:172 | +| `devServer.env` | `Record`\<`string`, `string`\> | testplane-docs/.testplane/src/config/types.ts:173 | +| `devServer.logs` | `boolean` | testplane-docs/.testplane/src/config/types.ts:175 | +| `devServer.readinessProbe` | `ReadinessProbe` | testplane-docs/.testplane/src/config/types.ts:176 | +| `expectOpts` | [`ExpectOptsConfig`](ExpectOptsConfig.mdx) | testplane-docs/.testplane/src/config/types.ts:137 | +| `gridUrl` | `string` | testplane-docs/.testplane/src/config/types.ts:103 | +| `headers` | `null` \| `Record`\<`string`, `string`\> | testplane-docs/.testplane/src/config/types.ts:142 | +| `headless` | `null` \| `boolean` \| `"old"` \| `"new"` | testplane-docs/.testplane/src/config/types.ts:153 | +| `httpTimeout` | `number` | testplane-docs/.testplane/src/config/types.ts:109 | +| `isolation` | `boolean` | testplane-docs/.testplane/src/config/types.ts:154 | +| `key` | `null` \| `string` | testplane-docs/.testplane/src/config/types.ts:149 | +| `lastFailed` | \{ `input`: `string` \| `string`[]; `only`: `boolean`; `output`: `string`; \} | testplane-docs/.testplane/src/config/types.ts:156 | +| `lastFailed.input` | `string` \| `string`[] | testplane-docs/.testplane/src/config/types.ts:158 | +| `lastFailed.only` | `boolean` | testplane-docs/.testplane/src/config/types.ts:157 | +| `lastFailed.output` | `string` | testplane-docs/.testplane/src/config/types.ts:159 | +| `meta` | \{\} | testplane-docs/.testplane/src/config/types.ts:138 | +| `openAndWaitOpts` | \{ `failOnNetworkError`: `boolean`; `ignoreNetworkErrorsPatterns`: (`string` \| `RegExp`)[]; `timeout`: `number`; `waitNetworkIdle`: `boolean`; `waitNetworkIdleTimeout`: `number`; \} | testplane-docs/.testplane/src/config/types.ts:162 | +| `openAndWaitOpts.failOnNetworkError` | `boolean` | testplane-docs/.testplane/src/config/types.ts:166 | +| `openAndWaitOpts.ignoreNetworkErrorsPatterns` | (`string` \| `RegExp`)[] | testplane-docs/.testplane/src/config/types.ts:167 | +| `openAndWaitOpts.timeout?` | `number` | testplane-docs/.testplane/src/config/types.ts:163 | +| `openAndWaitOpts.waitNetworkIdle` | `boolean` | testplane-docs/.testplane/src/config/types.ts:164 | +| `openAndWaitOpts.waitNetworkIdleTimeout` | `number` | testplane-docs/.testplane/src/config/types.ts:165 | +| `orientation` | `null` \| `"landscape"` \| `"portrait"` | testplane-docs/.testplane/src/config/types.ts:140 | +| `pageLoadTimeout` | `null` \| `number` | testplane-docs/.testplane/src/config/types.ts:111 | +| `region` | `null` \| `string` | testplane-docs/.testplane/src/config/types.ts:150 | +| `resetCursor` | `boolean` | testplane-docs/.testplane/src/config/types.ts:141 | +| `retry` | `number` | testplane-docs/.testplane/src/config/types.ts:107 | +| `saveHistoryMode` | `"all"` \| `"none"` \| `"onlyFailed"` | testplane-docs/.testplane/src/config/types.ts:117 | +| `screenshotDelay` | `number` | testplane-docs/.testplane/src/config/types.ts:131 | +| `screenshotMode` | `"auto"` \| `"fullpage"` \| `"viewport"` | testplane-docs/.testplane/src/config/types.ts:130 | +| `screenshotPath` | `null` \| `string` | testplane-docs/.testplane/src/config/types.ts:125 | +| `sessionEnvFlags` | `Record`\< \| `"isW3C"` \| `"isAndroid"` \| `"isMobile"` \| `"isIOS"` \| `"isSauce"` \| `"isSeleniumStandalone"` \| `"isChrome"`, `boolean`\> | testplane-docs/.testplane/src/config/types.ts:99 | +| `sessionQuitTimeout` | `null` \| `number` | testplane-docs/.testplane/src/config/types.ts:113 | +| `sessionRequestTimeout` | `null` \| `number` | testplane-docs/.testplane/src/config/types.ts:112 | +| `sessionsPerBrowser` | `number` | testplane-docs/.testplane/src/config/types.ts:105 | +| `strictSSL` | `null` \| `boolean` | testplane-docs/.testplane/src/config/types.ts:147 | +| `strictTestsOrder` | `boolean` | testplane-docs/.testplane/src/config/types.ts:129 | +| `system` | [`SystemConfig`](SystemConfig.mdx) | testplane-docs/.testplane/src/config/types.ts:152 | +| `takeScreenshotOnFails` | \{ `assertViewFail`: `boolean`; `testFail`: `boolean`; \} | testplane-docs/.testplane/src/config/types.ts:118 | +| `takeScreenshotOnFails.assertViewFail` | `boolean` | testplane-docs/.testplane/src/config/types.ts:120 | +| `takeScreenshotOnFails.testFail` | `boolean` | testplane-docs/.testplane/src/config/types.ts:119 | +| `takeScreenshotOnFailsMode` | `"fullpage"` \| `"viewport"` | testplane-docs/.testplane/src/config/types.ts:123 | +| `takeScreenshotOnFailsTimeout` | `null` \| `number` | testplane-docs/.testplane/src/config/types.ts:122 | +| `testTimeout` | `null` \| `number` | testplane-docs/.testplane/src/config/types.ts:114 | +| `testsPerSession` | `number` | testplane-docs/.testplane/src/config/types.ts:106 | +| `tolerance` | `number` | testplane-docs/.testplane/src/config/types.ts:132 | +| `transformRequest` | (`req`: `RequestOptions`) => `RequestOptions` | testplane-docs/.testplane/src/config/types.ts:144 | +| `transformResponse` | (`res`: `Response`, `req`: `RequestOptions`) => `Response` | testplane-docs/.testplane/src/config/types.ts:145 | +| `urlHttpTimeout` | `null` \| `number` | testplane-docs/.testplane/src/config/types.ts:110 | +| `user` | `null` \| `string` | testplane-docs/.testplane/src/config/types.ts:148 | +| `waitInterval` | `number` | testplane-docs/.testplane/src/config/types.ts:116 | +| `waitTimeout` | `number` | testplane-docs/.testplane/src/config/types.ts:115 | +| `windowSize` | `null` \| `string` \| \{ `height`: `number`; `width`: `number`; \} | testplane-docs/.testplane/src/config/types.ts:139 | + +## Methods + +### prepareBrowser() + +```ts +prepareBrowser(browser): null | void +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `browser` | `Browser` | + +#### Returns + +`null` \| `void` + +#### Defined in + +testplane-docs/.testplane/src/config/types.ts:124 + +*** + +### screenshotsDir() + +```ts +screenshotsDir(test): string +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `test` | [`Test`](../classes/Test.mdx) | + +#### Returns + +`string` + +#### Defined in + +testplane-docs/.testplane/src/config/types.ts:126 + +*** + +### shouldRetry() + +```ts +shouldRetry(testInfo): null | boolean +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `testInfo` | `object` | +| `testInfo.ctx` | [`Test`](../classes/Test.mdx) | +| `testInfo.retriesLeft` | `number` | + +#### Returns + +`null` \| `boolean` + +#### Defined in + +testplane-docs/.testplane/src/config/types.ts:108 diff --git a/docs/api-reference/interfaces/CompareOptsConfig.mdx b/docs/api-reference/interfaces/CompareOptsConfig.mdx new file mode 100644 index 0000000..cd6964b --- /dev/null +++ b/docs/api-reference/interfaces/CompareOptsConfig.mdx @@ -0,0 +1,11 @@ +[testplane](../README.mdx) / CompareOptsConfig + +# Interface: CompareOptsConfig + +## Properties + +| Property | Type | Defined in | +| ------ | ------ | ------ | +| `clustersSize` | `number` | testplane-docs/.testplane/src/config/types.ts:9 | +| `shouldCluster` | `boolean` | testplane-docs/.testplane/src/config/types.ts:8 | +| `stopOnFirstFail` | `boolean` | testplane-docs/.testplane/src/config/types.ts:10 | diff --git a/docs/api-reference/interfaces/DiffOptions.mdx b/docs/api-reference/interfaces/DiffOptions.mdx new file mode 100644 index 0000000..df740a3 --- /dev/null +++ b/docs/api-reference/interfaces/DiffOptions.mdx @@ -0,0 +1,25 @@ +[testplane](../README.mdx) / DiffOptions + +# Interface: DiffOptions + +## Extends + +- `LooksSameOptions` + +## Properties + +| Property | Type | Description | Inherited from | Defined in | +| ------ | ------ | ------ | ------ | ------ | +| `antialiasingTolerance?` | `number` | Sometimes the antialiasing algorithm can work incorrectly due to some features of the browser rendering engine. Use the option antialiasingTolerance to make the algorithm less strict. With this option you can specify the minimum difference in brightness (zero by default) between the darkest/lightest pixel (which is adjacent to the antialiasing pixel) and theirs adjacent pixels. We recommend that you don't increase this value above 10. If you need to increase more than 10 then this is definitely not antialiasing. | `LooksSameOptions.antialiasingTolerance` | testplane/node\_modules/looks-same/index.d.ts:139 | +| `clustersSize?` | `number` | Radius for every diff cluster | `LooksSameOptions.clustersSize` | testplane/node\_modules/looks-same/index.d.ts:152 | +| `createDiffImage?` | `boolean` | If you need both to compare images and create diff image | `LooksSameOptions.createDiffImage` | testplane/node\_modules/looks-same/index.d.ts:156 | +| `current` | `string` | - | - | testplane-docs/.testplane/src/types/index.ts:72 | +| `diffColor` | `string` | - | - | testplane-docs/.testplane/src/types/index.ts:74 | +| `ignoreAntialiasing?` | `boolean` | Some images has difference while comparing because of antialiasing. These diffs will be ignored by default. You can use ignoreAntialiasing option with false value to disable ignoring such diffs. In that way antialiased pixels will be marked as diffs. | `LooksSameOptions.ignoreAntialiasing` | testplane/node\_modules/looks-same/index.d.ts:130 | +| `ignoreCaret?` | `boolean` | Text caret in text input elements it is a pain for visual regression tasks, because it is always blinks. These diffs will be ignored by default. You can use `ignoreCaret` option with `false` value to disable ignoring such diffs. In that way text caret will be marked as diffs. | `LooksSameOptions.ignoreCaret` | testplane/node\_modules/looks-same/index.d.ts:124 | +| `pixelRatio?` | `number` | Some devices can have different proportion between physical and logical screen resolutions also known as pixel ratio. Default value for this proportion is 1. This param also affects the comparison result, so it can be set manually with pixelRatio option. | `LooksSameOptions.pixelRatio` | testplane/node\_modules/looks-same/index.d.ts:118 | +| `reference` | `string` | - | - | testplane-docs/.testplane/src/types/index.ts:73 | +| `shouldCluster?` | `boolean` | Responsible for diff bounds clustering | `LooksSameOptions.shouldCluster` | testplane/node\_modules/looks-same/index.d.ts:148 | +| `stopOnFirstFail?` | `boolean` | Responsible for diff area which will be returned when comparing images. Diff bounds will contain the whole diff if stopOnFirstFail is false and only first diff pixel - otherwise. | `LooksSameOptions.stopOnFirstFail` | testplane/node\_modules/looks-same/index.d.ts:144 | +| `strict?` | `boolean` | By default, it will detect only noticeable differences. If you wish to detect any difference, use strict options. | `LooksSameOptions.strict` | testplane/node\_modules/looks-same/index.d.ts:108 | +| `tolerance?` | `number` | You can also adjust the ΔE value that will be treated as error in non-strict mode. | `LooksSameOptions.tolerance` | testplane/node\_modules/looks-same/index.d.ts:112 | diff --git a/docs/api-reference/interfaces/ErrorDetails.mdx b/docs/api-reference/interfaces/ErrorDetails.mdx new file mode 100644 index 0000000..f5eeb87 --- /dev/null +++ b/docs/api-reference/interfaces/ErrorDetails.mdx @@ -0,0 +1,11 @@ +[testplane](../README.mdx) / ErrorDetails + +# Interface: ErrorDetails + +## Properties + +| Property | Type | Defined in | +| ------ | ------ | ------ | +| `data?` | `unknown` | testplane-docs/.testplane/src/types/index.ts:53 | +| `filePath` | `string` | testplane-docs/.testplane/src/types/index.ts:54 | +| `title` | `string` | testplane-docs/.testplane/src/types/index.ts:52 | diff --git a/docs/api-reference/interfaces/ExecutionThreadToolCtx.mdx b/docs/api-reference/interfaces/ExecutionThreadToolCtx.mdx new file mode 100644 index 0000000..47daa55 --- /dev/null +++ b/docs/api-reference/interfaces/ExecutionThreadToolCtx.mdx @@ -0,0 +1,14 @@ +[testplane](../README.mdx) / ExecutionThreadToolCtx + +# Interface: ExecutionThreadToolCtx + +## Properties + +| Property | Type | Defined in | +| ------ | ------ | ------ | +| `assertViewResults` | \{ `add`: (`result`) => `void`; `get`: () => [`AssertViewResult`](../type-aliases/AssertViewResult.mdx)[]; `hasFails`: () => `boolean`; `hasState`: (`stateName`) => `boolean`; `toRawObject`: () => [`AssertViewResult`](../type-aliases/AssertViewResult.mdx)[]; \} | testplane-docs/.testplane/src/types/index.ts:125 | +| `assertViewResults.add` | (`result`: [`AssertViewResult`](../type-aliases/AssertViewResult.mdx)) => `void` | testplane-docs/.testplane/src/types/index.ts:126 | +| `assertViewResults.get` | () => [`AssertViewResult`](../type-aliases/AssertViewResult.mdx)[] | testplane-docs/.testplane/src/types/index.ts:130 | +| `assertViewResults.hasFails` | () => `boolean` | testplane-docs/.testplane/src/types/index.ts:127 | +| `assertViewResults.hasState` | (`stateName`: `string`) => `boolean` | testplane-docs/.testplane/src/types/index.ts:128 | +| `assertViewResults.toRawObject` | () => [`AssertViewResult`](../type-aliases/AssertViewResult.mdx)[] | testplane-docs/.testplane/src/types/index.ts:129 | diff --git a/docs/api-reference/interfaces/ExpectOptsConfig.mdx b/docs/api-reference/interfaces/ExpectOptsConfig.mdx new file mode 100644 index 0000000..8ad07b9 --- /dev/null +++ b/docs/api-reference/interfaces/ExpectOptsConfig.mdx @@ -0,0 +1,10 @@ +[testplane](../README.mdx) / ExpectOptsConfig + +# Interface: ExpectOptsConfig + +## Properties + +| Property | Type | Defined in | +| ------ | ------ | ------ | +| `interval` | `number` | testplane-docs/.testplane/src/config/types.ts:50 | +| `wait` | `number` | testplane-docs/.testplane/src/config/types.ts:49 | diff --git a/docs/api-reference/interfaces/GlobalHelper.mdx b/docs/api-reference/interfaces/GlobalHelper.mdx new file mode 100644 index 0000000..14fb338 --- /dev/null +++ b/docs/api-reference/interfaces/GlobalHelper.mdx @@ -0,0 +1,14 @@ +[testplane](../README.mdx) / GlobalHelper + +# Interface: GlobalHelper + +## Properties + +| Property | Type | Defined in | +| ------ | ------ | ------ | +| `also` | `AlsoController` | testplane-docs/.testplane/src/types/index.ts:165 | +| `browser` | (`browserName`: `string`) => `BrowserVersionController` | testplane-docs/.testplane/src/types/index.ts:166 | +| `config` | `ConfigController` | testplane-docs/.testplane/src/types/index.ts:167 | +| `ctx` | [`TestplaneCtx`](TestplaneCtx.mdx) | testplane-docs/.testplane/src/types/index.ts:162 | +| `only` | `OnlyController` | testplane-docs/.testplane/src/types/index.ts:164 | +| `skip` | `SkipController` | testplane-docs/.testplane/src/types/index.ts:163 | diff --git a/docs/api-reference/interfaces/HermioneCtx.mdx b/docs/api-reference/interfaces/HermioneCtx.mdx new file mode 100644 index 0000000..4cc0a8c --- /dev/null +++ b/docs/api-reference/interfaces/HermioneCtx.mdx @@ -0,0 +1,15 @@ +[testplane](../README.mdx) / HermioneCtx + +# Interface: ~~HermioneCtx~~ + +## Deprecated + +Use `TestplaneCtx` instead + +## Extends + +- `Record`\<`string`, `unknown`\> + +## Extended by + +- [`TestplaneCtx`](TestplaneCtx.mdx) diff --git a/docs/api-reference/interfaces/ImageBase64.mdx b/docs/api-reference/interfaces/ImageBase64.mdx new file mode 100644 index 0000000..48a744d --- /dev/null +++ b/docs/api-reference/interfaces/ImageBase64.mdx @@ -0,0 +1,10 @@ +[testplane](../README.mdx) / ImageBase64 + +# Interface: ImageBase64 + +## Properties + +| Property | Type | Defined in | +| ------ | ------ | ------ | +| `base64` | `string` | testplane-docs/.testplane/src/types/index.ts:47 | +| `size` | [`ImageSize`](ImageSize.mdx) | testplane-docs/.testplane/src/types/index.ts:48 | diff --git a/docs/api-reference/interfaces/ImageInfo.mdx b/docs/api-reference/interfaces/ImageInfo.mdx new file mode 100644 index 0000000..5391b1e --- /dev/null +++ b/docs/api-reference/interfaces/ImageInfo.mdx @@ -0,0 +1,14 @@ +[testplane](../README.mdx) / ImageInfo + +# Interface: ImageInfo + +## Extended by + +- [`RefImageInfo`](RefImageInfo.mdx) + +## Properties + +| Property | Type | Defined in | +| ------ | ------ | ------ | +| `path` | `string` | testplane-docs/.testplane/src/types/index.ts:63 | +| `size` | [`ImageSize`](ImageSize.mdx) | testplane-docs/.testplane/src/types/index.ts:64 | diff --git a/docs/api-reference/interfaces/ImageSize.mdx b/docs/api-reference/interfaces/ImageSize.mdx new file mode 100644 index 0000000..9b34c8f --- /dev/null +++ b/docs/api-reference/interfaces/ImageSize.mdx @@ -0,0 +1,10 @@ +[testplane](../README.mdx) / ImageSize + +# Interface: ImageSize + +## Properties + +| Property | Type | Defined in | +| ------ | ------ | ------ | +| `height` | `number` | testplane-docs/.testplane/src/types/index.ts:43 | +| `width` | `number` | testplane-docs/.testplane/src/types/index.ts:42 | diff --git a/docs/api-reference/interfaces/InterceptData.mdx b/docs/api-reference/interfaces/InterceptData.mdx new file mode 100644 index 0000000..3cb78fc --- /dev/null +++ b/docs/api-reference/interfaces/InterceptData.mdx @@ -0,0 +1,10 @@ +[testplane](../README.mdx) / InterceptData + +# Interface: InterceptData + +## Properties + +| Property | Type | Defined in | +| ------ | ------ | ------ | +| `data?` | [`Test`](../classes/Test.mdx) | testplane-docs/.testplane/src/events/types.ts:6 | +| `event?` | [`InterceptedEvent`](../type-aliases/InterceptedEvent.mdx) | testplane-docs/.testplane/src/events/types.ts:5 | diff --git a/docs/api-reference/interfaces/MochaOpts.mdx b/docs/api-reference/interfaces/MochaOpts.mdx new file mode 100644 index 0000000..33e2cb8 --- /dev/null +++ b/docs/api-reference/interfaces/MochaOpts.mdx @@ -0,0 +1,11 @@ +[testplane](../README.mdx) / MochaOpts + +# Interface: MochaOpts + +## Properties + +| Property | Type | Description | Defined in | +| ------ | ------ | ------ | ------ | +| `grep?` | `string` \| `RegExp` | string or regexp to filter tests with. | testplane-docs/.testplane/src/config/types.ts:61 | +| `slow?` | `number` | milliseconds to wait before considering a test slow. | testplane-docs/.testplane/src/config/types.ts:55 | +| `timeout?` | `number` | timeout in milliseconds or time string like '1s'. | testplane-docs/.testplane/src/config/types.ts:58 | diff --git a/docs/api-reference/interfaces/ReadTestsOpts.mdx b/docs/api-reference/interfaces/ReadTestsOpts.mdx new file mode 100644 index 0000000..88f4fbc --- /dev/null +++ b/docs/api-reference/interfaces/ReadTestsOpts.mdx @@ -0,0 +1,21 @@ +[testplane](../README.mdx) / ReadTestsOpts + +# Interface: ReadTestsOpts + +## Extends + +- `Pick`\<[`RunOpts`](RunOpts.mdx), `"browsers"` \| `"sets"` \| `"grep"` \| `"replMode"`\> + +## Properties + +| Property | Type | Inherited from | Defined in | +| ------ | ------ | ------ | ------ | +| `browsers` | `string`[] | `Pick.browsers` | testplane-docs/.testplane/src/testplane.ts:23 | +| `grep` | `RegExp` | `Pick.grep` | testplane-docs/.testplane/src/testplane.ts:25 | +| `ignore` | `string` \| `string`[] | - | testplane-docs/.testplane/src/testplane.ts:49 | +| `replMode` | \{ `beforeTest`: `boolean`; `enabled`: `boolean`; `onFail`: `boolean`; \} | `Pick.replMode` | testplane-docs/.testplane/src/testplane.ts:33 | +| `replMode.beforeTest` | `boolean` | - | testplane-docs/.testplane/src/testplane.ts:35 | +| `replMode.enabled` | `boolean` | - | testplane-docs/.testplane/src/testplane.ts:34 | +| `replMode.onFail` | `boolean` | - | testplane-docs/.testplane/src/testplane.ts:36 | +| `sets` | `string`[] | `Pick.sets` | testplane-docs/.testplane/src/testplane.ts:24 | +| `silent` | `boolean` | - | testplane-docs/.testplane/src/testplane.ts:48 | diff --git a/docs/api-reference/interfaces/RefImageInfo.mdx b/docs/api-reference/interfaces/RefImageInfo.mdx new file mode 100644 index 0000000..3c77d75 --- /dev/null +++ b/docs/api-reference/interfaces/RefImageInfo.mdx @@ -0,0 +1,15 @@ +[testplane](../README.mdx) / RefImageInfo + +# Interface: RefImageInfo + +## Extends + +- [`ImageInfo`](ImageInfo.mdx) + +## Properties + +| Property | Type | Inherited from | Defined in | +| ------ | ------ | ------ | ------ | +| `path` | `string` | [`ImageInfo`](ImageInfo.mdx).`path` | testplane-docs/.testplane/src/types/index.ts:63 | +| `relativePath` | `string` | - | testplane-docs/.testplane/src/types/index.ts:68 | +| `size` | [`ImageSize`](ImageSize.mdx) | [`ImageInfo`](ImageInfo.mdx).`size` | testplane-docs/.testplane/src/types/index.ts:64 | diff --git a/docs/api-reference/interfaces/RootSuite.mdx b/docs/api-reference/interfaces/RootSuite.mdx new file mode 100644 index 0000000..ce72ca0 --- /dev/null +++ b/docs/api-reference/interfaces/RootSuite.mdx @@ -0,0 +1,744 @@ +[testplane](../README.mdx) / RootSuite + +# Interface: RootSuite + +## Extends + +- [`Suite`](../classes/Suite.mdx) + +## Properties + +| Property | Modifier | Type | Default value | Overrides | Inherited from | Defined in | +| ------ | ------ | ------ | ------ | ------ | ------ | ------ | +| `parent` | `public` | `null` \| [`Suite`](../classes/Suite.mdx) | `null` | - | [`Suite`](../classes/Suite.mdx).`parent` | testplane-docs/.testplane/src/test-reader/test-object/test-object.ts:6 | +| `root` | `public` | `true` | `undefined` | [`Suite`](../classes/Suite.mdx).[`root`](../classes/Suite.mdx#root) | - | testplane-docs/.testplane/src/types/index.ts:28 | + +## Accessors + +### afterEachHooks + +```ts +get afterEachHooks(): Hook[] +``` + +#### Returns + +`Hook`[] + +#### Inherited from + +[`Suite`](../classes/Suite.mdx).[`afterEachHooks`](../classes/Suite.mdx#aftereachhooks) + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/suite.ts:95 + +*** + +### beforeEachHooks + +```ts +get beforeEachHooks(): Hook[] +``` + +#### Returns + +`Hook`[] + +#### Inherited from + +[`Suite`](../classes/Suite.mdx).[`beforeEachHooks`](../classes/Suite.mdx#beforeeachhooks) + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/suite.ts:91 + +*** + +### browserId + +```ts +get browserId(): string +``` + +```ts +set browserId(id): void +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `id` | `string` | + +#### Returns + +`string` + +#### Inherited from + +[`Suite`](../classes/Suite.mdx).[`browserId`](../classes/Suite.mdx#browserid) + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/configurable-test-object.ts:93 + +*** + +### browserVersion + +```ts +get browserVersion(): undefined | string +``` + +```ts +set browserVersion(version): void +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `version` | `string` | + +#### Returns + +`undefined` \| `string` + +#### Inherited from + +[`Suite`](../classes/Suite.mdx).[`browserVersion`](../classes/Suite.mdx#browserversion) + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/configurable-test-object.ts:101 + +*** + +### disabled + +```ts +get disabled(): boolean +``` + +```ts +set disabled(val): void +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `val` | `boolean` | + +#### Returns + +`boolean` + +#### Inherited from + +[`Suite`](../classes/Suite.mdx).[`disabled`](../classes/Suite.mdx#disabled) + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/configurable-test-object.ts:69 + +*** + +### file + +```ts +get file(): string +``` + +#### Returns + +`string` + +#### Inherited from + +[`Suite`](../classes/Suite.mdx).[`file`](../classes/Suite.mdx#file) + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/configurable-test-object.ts:45 + +*** + +### hasBrowserVersionOverwritten + +```ts +get hasBrowserVersionOverwritten(): boolean +``` + +#### Returns + +`boolean` + +#### Inherited from + +[`Suite`](../classes/Suite.mdx).[`hasBrowserVersionOverwritten`](../classes/Suite.mdx#hasbrowserversionoverwritten) + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/configurable-test-object.ts:105 + +*** + +### id + +```ts +get id(): string +``` + +#### Returns + +`string` + +#### Inherited from + +[`Suite`](../classes/Suite.mdx).[`id`](../classes/Suite.mdx#id) + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/configurable-test-object.ts:41 + +*** + +### pending + +```ts +get pending(): boolean +``` + +```ts +set pending(val): void +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `val` | `boolean` | + +#### Returns + +`boolean` + +#### Inherited from + +[`Suite`](../classes/Suite.mdx).[`pending`](../classes/Suite.mdx#pending) + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/configurable-test-object.ts:53 + +*** + +### silentSkip + +```ts +get silentSkip(): boolean +``` + +```ts +set silentSkip(val): void +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `val` | `boolean` | + +#### Returns + +`boolean` + +#### Inherited from + +[`Suite`](../classes/Suite.mdx).[`silentSkip`](../classes/Suite.mdx#silentskip) + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/configurable-test-object.ts:77 + +*** + +### skipReason + +```ts +get skipReason(): string +``` + +```ts +set skipReason(reason): void +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `reason` | `string` | + +#### Returns + +`string` + +#### Inherited from + +[`Suite`](../classes/Suite.mdx).[`skipReason`](../classes/Suite.mdx#skipreason) + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/configurable-test-object.ts:61 + +*** + +### suites + +```ts +get suites(): Suite[] +``` + +#### Returns + +[`Suite`](../classes/Suite.mdx)[] + +#### Inherited from + +[`Suite`](../classes/Suite.mdx).[`suites`](../classes/Suite.mdx#suites) + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/suite.ts:83 + +*** + +### tests + +```ts +get tests(): Test[] +``` + +#### Returns + +[`Test`](../classes/Test.mdx)[] + +#### Inherited from + +[`Suite`](../classes/Suite.mdx).[`tests`](../classes/Suite.mdx#tests) + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/suite.ts:87 + +*** + +### timeout + +```ts +get timeout(): number +``` + +```ts +set timeout(timeout): void +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `timeout` | `number` | + +#### Returns + +`number` + +#### Inherited from + +[`Suite`](../classes/Suite.mdx).[`timeout`](../classes/Suite.mdx#timeout) + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/configurable-test-object.ts:85 + +*** + +### title + +```ts +get title(): string +``` + +#### Returns + +`string` + +#### Inherited from + +[`Suite`](../classes/Suite.mdx).[`title`](../classes/Suite.mdx#title) + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/test-object.ts:16 + +## Methods + +### addAfterEachHook() + +```ts +addAfterEachHook(hook): this +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `hook` | `Hook` | + +#### Returns + +`this` + +#### Inherited from + +[`Suite`](../classes/Suite.mdx).[`addAfterEachHook`](../classes/Suite.mdx#addaftereachhook) + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/suite.ts:41 + +*** + +### addBeforeEachHook() + +```ts +addBeforeEachHook(hook): this +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `hook` | `Hook` | + +#### Returns + +`this` + +#### Inherited from + +[`Suite`](../classes/Suite.mdx).[`addBeforeEachHook`](../classes/Suite.mdx#addbeforeeachhook) + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/suite.ts:37 + +*** + +### addSuite() + +```ts +addSuite(suite): this +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `suite` | [`Suite`](../classes/Suite.mdx) | + +#### Returns + +`this` + +#### Inherited from + +[`Suite`](../classes/Suite.mdx).[`addSuite`](../classes/Suite.mdx#addsuite) + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/suite.ts:29 + +*** + +### addTest() + +```ts +addTest(test): this +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `test` | [`Test`](../classes/Test.mdx) | + +#### Returns + +`this` + +#### Inherited from + +[`Suite`](../classes/Suite.mdx).[`addTest`](../classes/Suite.mdx#addtest) + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/suite.ts:33 + +*** + +### afterEach() + +```ts +afterEach(fn): this +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `fn` | `TestFunction`\<[`TestFunctionCtx`](TestFunctionCtx.mdx)\> | + +#### Returns + +`this` + +#### Inherited from + +[`Suite`](../classes/Suite.mdx).[`afterEach`](../classes/Suite.mdx#aftereach) + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/suite.ts:49 + +*** + +### assign() + +```ts +assign(src): this +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `src` | `this` | + +#### Returns + +`this` + +#### Inherited from + +[`Suite`](../classes/Suite.mdx).[`assign`](../classes/Suite.mdx#assign) + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/configurable-test-object.ts:20 + +*** + +### beforeEach() + +```ts +beforeEach(fn): this +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `fn` | `TestFunction`\<[`TestFunctionCtx`](TestFunctionCtx.mdx)\> | + +#### Returns + +`this` + +#### Inherited from + +[`Suite`](../classes/Suite.mdx).[`beforeEach`](../classes/Suite.mdx#beforeeach) + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/suite.ts:45 + +*** + +### disable() + +```ts +disable(): void +``` + +#### Returns + +`void` + +#### Inherited from + +[`Suite`](../classes/Suite.mdx).[`disable`](../classes/Suite.mdx#disable) + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/configurable-test-object.ts:31 + +*** + +### eachTest() + +```ts +eachTest(cb): void +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `cb` | (`test`) => `void` | + +#### Returns + +`void` + +#### Inherited from + +[`Suite`](../classes/Suite.mdx).[`eachTest`](../classes/Suite.mdx#eachtest) + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/suite.ts:60 + +*** + +### enable() + +```ts +enable(): void +``` + +#### Returns + +`void` + +#### Inherited from + +[`Suite`](../classes/Suite.mdx).[`enable`](../classes/Suite.mdx#enable) + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/configurable-test-object.ts:36 + +*** + +### filterTests() + +```ts +filterTests(cb): this +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `cb` | (`test`) => `unknown` | + +#### Returns + +`this` + +#### Inherited from + +[`Suite`](../classes/Suite.mdx).[`filterTests`](../classes/Suite.mdx#filtertests) + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/suite.ts:70 + +*** + +### fullTitle() + +```ts +fullTitle(): string +``` + +#### Returns + +`string` + +#### Inherited from + +[`Suite`](../classes/Suite.mdx).[`fullTitle`](../classes/Suite.mdx#fulltitle) + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/test-object.ts:30 + +*** + +### getTests() + +```ts +getTests(): Test[] +``` + +#### Returns + +[`Test`](../classes/Test.mdx)[] + +#### Inherited from + +[`Suite`](../classes/Suite.mdx).[`getTests`](../classes/Suite.mdx#gettests) + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/suite.ts:65 + +*** + +### skip() + +```ts +skip(__namedParameters): void +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `SkipData` | + +#### Returns + +`void` + +#### Inherited from + +[`Suite`](../classes/Suite.mdx).[`skip`](../classes/Suite.mdx#skip) + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/configurable-test-object.ts:26 + +*** + +### titlePath() + +```ts +titlePath(): string[] +``` + +#### Returns + +`string`[] + +#### Inherited from + +[`Suite`](../classes/Suite.mdx).[`titlePath`](../classes/Suite.mdx#titlepath) + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/test-object.ts:20 diff --git a/docs/api-reference/interfaces/RunOpts.mdx b/docs/api-reference/interfaces/RunOpts.mdx new file mode 100644 index 0000000..7cf2653 --- /dev/null +++ b/docs/api-reference/interfaces/RunOpts.mdx @@ -0,0 +1,22 @@ +[testplane](../README.mdx) / RunOpts + +# Interface: RunOpts + +## Properties + +| Property | Type | Defined in | +| ------ | ------ | ------ | +| `browsers` | `string`[] | testplane-docs/.testplane/src/testplane.ts:23 | +| `devtools` | `boolean` | testplane-docs/.testplane/src/testplane.ts:38 | +| `grep` | `RegExp` | testplane-docs/.testplane/src/testplane.ts:25 | +| `inspectMode` | \{ `inspect`: `boolean`; `inspectBrk`: `boolean`; \} | testplane-docs/.testplane/src/testplane.ts:28 | +| `inspectMode.inspect` | `boolean` | testplane-docs/.testplane/src/testplane.ts:29 | +| `inspectMode.inspectBrk` | `boolean` | testplane-docs/.testplane/src/testplane.ts:30 | +| `replMode` | \{ `beforeTest`: `boolean`; `enabled`: `boolean`; `onFail`: `boolean`; \} | testplane-docs/.testplane/src/testplane.ts:33 | +| `replMode.beforeTest` | `boolean` | testplane-docs/.testplane/src/testplane.ts:35 | +| `replMode.enabled` | `boolean` | testplane-docs/.testplane/src/testplane.ts:34 | +| `replMode.onFail` | `boolean` | testplane-docs/.testplane/src/testplane.ts:36 | +| `reporters` | `string`[] | testplane-docs/.testplane/src/testplane.ts:32 | +| `requireModules` | `string`[] | testplane-docs/.testplane/src/testplane.ts:27 | +| `sets` | `string`[] | testplane-docs/.testplane/src/testplane.ts:24 | +| `updateRefs` | `boolean` | testplane-docs/.testplane/src/testplane.ts:26 | diff --git a/docs/api-reference/interfaces/SetsConfig.mdx b/docs/api-reference/interfaces/SetsConfig.mdx new file mode 100644 index 0000000..b85b741 --- /dev/null +++ b/docs/api-reference/interfaces/SetsConfig.mdx @@ -0,0 +1,11 @@ +[testplane](../README.mdx) / SetsConfig + +# Interface: SetsConfig + +## Properties + +| Property | Type | Defined in | +| ------ | ------ | ------ | +| `browsers?` | `string`[] | testplane-docs/.testplane/src/config/types.ts:183 | +| `files` | `string` \| `string`[] | testplane-docs/.testplane/src/config/types.ts:181 | +| `ignoreFiles?` | `string`[] | testplane-docs/.testplane/src/config/types.ts:182 | diff --git a/docs/api-reference/interfaces/SystemConfig.mdx b/docs/api-reference/interfaces/SystemConfig.mdx new file mode 100644 index 0000000..dd63434 --- /dev/null +++ b/docs/api-reference/interfaces/SystemConfig.mdx @@ -0,0 +1,20 @@ +[testplane](../README.mdx) / SystemConfig + +# Interface: SystemConfig + +## Properties + +| Property | Type | Defined in | +| ------ | ------ | ------ | +| `ctx` | \{\} | testplane-docs/.testplane/src/config/types.ts:68 | +| `debug` | `boolean` | testplane-docs/.testplane/src/config/types.ts:65 | +| `diffColor` | `string` | testplane-docs/.testplane/src/config/types.ts:72 | +| `expectOpts` | [`ExpectOptsConfig`](ExpectOptsConfig.mdx) | testplane-docs/.testplane/src/config/types.ts:67 | +| `fileExtensions` | `string`[] | testplane-docs/.testplane/src/config/types.ts:75 | +| `mochaOpts` | [`MochaOpts`](MochaOpts.mdx) | testplane-docs/.testplane/src/config/types.ts:66 | +| `parallelLimit` | `number` | testplane-docs/.testplane/src/config/types.ts:74 | +| `patternsOnReject` | `string`[] | testplane-docs/.testplane/src/config/types.ts:69 | +| `tempDir` | `string` | testplane-docs/.testplane/src/config/types.ts:73 | +| `testRunEnv` | `"nodejs"` \| `"browser"` \| [`"browser"`, `BrowserTestRunEnvOptions`] | testplane-docs/.testplane/src/config/types.ts:76 | +| `testsPerWorker` | `number` | testplane-docs/.testplane/src/config/types.ts:71 | +| `workers` | `number` | testplane-docs/.testplane/src/config/types.ts:70 | diff --git a/docs/api-reference/interfaces/TestError.mdx b/docs/api-reference/interfaces/TestError.mdx new file mode 100644 index 0000000..e19e9d8 --- /dev/null +++ b/docs/api-reference/interfaces/TestError.mdx @@ -0,0 +1,17 @@ +[testplane](../README.mdx) / TestError + +# Interface: TestError + +## Extends + +- `Error` + +## Properties + +| Property | Type | Inherited from | Defined in | +| ------ | ------ | ------ | ------ | +| `details` | [`ErrorDetails`](ErrorDetails.mdx) | - | testplane-docs/.testplane/src/types/index.ts:59 | +| `message` | `string` | `Error.message` | testplane-docs/node\_modules/typescript/lib/lib.es5.d.ts:1077 | +| `name` | `string` | `Error.name` | testplane-docs/node\_modules/typescript/lib/lib.es5.d.ts:1076 | +| `screenshot?` | [`ImageBase64`](ImageBase64.mdx) | - | testplane-docs/.testplane/src/types/index.ts:58 | +| `stack?` | `string` | `Error.stack` | testplane-docs/node\_modules/typescript/lib/lib.es5.d.ts:1078 | diff --git a/docs/api-reference/interfaces/TestFunctionCtx.mdx b/docs/api-reference/interfaces/TestFunctionCtx.mdx new file mode 100644 index 0000000..f7f7092 --- /dev/null +++ b/docs/api-reference/interfaces/TestFunctionCtx.mdx @@ -0,0 +1,10 @@ +[testplane](../README.mdx) / TestFunctionCtx + +# Interface: TestFunctionCtx + +## Properties + +| Property | Type | Defined in | +| ------ | ------ | ------ | +| `browser` | `Browser` | testplane-docs/.testplane/src/test-reader/test-object/types.ts:22 | +| `currentTest` | [`Test`](../classes/Test.mdx) | testplane-docs/.testplane/src/test-reader/test-object/types.ts:23 | diff --git a/docs/api-reference/interfaces/TestResult.mdx b/docs/api-reference/interfaces/TestResult.mdx new file mode 100644 index 0000000..eb227eb --- /dev/null +++ b/docs/api-reference/interfaces/TestResult.mdx @@ -0,0 +1,470 @@ +[testplane](../README.mdx) / TestResult + +# Interface: TestResult + +## Extends + +- [`Test`](../classes/Test.mdx) + +## Extended by + +- [`TestResultWithRetries`](TestResultWithRetries.mdx) + +## Properties + +| Property | Modifier | Type | Default value | Description | Overrides | Inherited from | Defined in | +| ------ | ------ | ------ | ------ | ------ | ------ | ------ | ------ | +| `assertViewResults` | `public` | [`AssertViewResult`](../type-aliases/AssertViewResult.mdx)[] | `undefined` | - | - | - | testplane-docs/.testplane/src/types/index.ts:135 | +| `description?` | `public` | `string` | `undefined` | - | - | - | testplane-docs/.testplane/src/types/index.ts:136 | +| `duration` | `public` | `number` | `undefined` | - | - | - | testplane-docs/.testplane/src/types/index.ts:137 | +| `err?` | `public` | [`TestError`](TestError.mdx) | `undefined` | - | [`Test`](../classes/Test.mdx).`err` | - | testplane-docs/.testplane/src/types/index.ts:138 | +| `fn` | `public` | `TestFunction`\<[`TestFunctionCtx`](TestFunctionCtx.mdx)\> | `undefined` | - | - | [`Test`](../classes/Test.mdx).`fn` | testplane-docs/.testplane/src/test-reader/test-object/test.ts:10 | +| ~~`hermioneCtx`~~ | `public` | [`ExecutionThreadToolCtx`](ExecutionThreadToolCtx.mdx) | `undefined` | **Deprecated** Use `testplaneCtx` instead | - | - | testplane-docs/.testplane/src/types/index.ts:143 | +| `history` | `public` | [`CommandHistory`](CommandHistory.mdx) | `undefined` | - | - | - | testplane-docs/.testplane/src/types/index.ts:144 | +| `meta` | `public` | \{\} | `undefined` | - | - | - | testplane-docs/.testplane/src/types/index.ts:145 | +| `parent` | `public` | `null` \| [`Suite`](../classes/Suite.mdx) | `null` | - | - | [`Test`](../classes/Test.mdx).`parent` | testplane-docs/.testplane/src/test-reader/test-object/test-object.ts:6 | +| `sessionId` | `public` | `string` | `undefined` | - | - | - | testplane-docs/.testplane/src/types/index.ts:146 | +| `startTime` | `public` | `number` | `undefined` | - | - | - | testplane-docs/.testplane/src/types/index.ts:147 | +| `testplaneCtx` | `public` | [`ExecutionThreadToolCtx`](ExecutionThreadToolCtx.mdx) | `undefined` | - | - | - | testplane-docs/.testplane/src/types/index.ts:139 | + +## Accessors + +### browserId + +```ts +get browserId(): string +``` + +```ts +set browserId(id): void +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `id` | `string` | + +#### Returns + +`string` + +#### Inherited from + +[`Test`](../classes/Test.mdx).[`browserId`](../classes/Test.mdx#browserid) + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/configurable-test-object.ts:93 + +*** + +### browserVersion + +```ts +get browserVersion(): undefined | string +``` + +```ts +set browserVersion(version): void +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `version` | `string` | + +#### Returns + +`undefined` \| `string` + +#### Inherited from + +[`Test`](../classes/Test.mdx).[`browserVersion`](../classes/Test.mdx#browserversion) + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/configurable-test-object.ts:101 + +*** + +### disabled + +```ts +get disabled(): boolean +``` + +```ts +set disabled(val): void +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `val` | `boolean` | + +#### Returns + +`boolean` + +#### Inherited from + +[`Test`](../classes/Test.mdx).[`disabled`](../classes/Test.mdx#disabled) + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/configurable-test-object.ts:69 + +*** + +### file + +```ts +get file(): string +``` + +#### Returns + +`string` + +#### Inherited from + +[`Test`](../classes/Test.mdx).[`file`](../classes/Test.mdx#file) + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/configurable-test-object.ts:45 + +*** + +### hasBrowserVersionOverwritten + +```ts +get hasBrowserVersionOverwritten(): boolean +``` + +#### Returns + +`boolean` + +#### Inherited from + +[`Test`](../classes/Test.mdx).[`hasBrowserVersionOverwritten`](../classes/Test.mdx#hasbrowserversionoverwritten) + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/configurable-test-object.ts:105 + +*** + +### id + +```ts +get id(): string +``` + +#### Returns + +`string` + +#### Inherited from + +[`Test`](../classes/Test.mdx).[`id`](../classes/Test.mdx#id) + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/configurable-test-object.ts:41 + +*** + +### pending + +```ts +get pending(): boolean +``` + +```ts +set pending(val): void +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `val` | `boolean` | + +#### Returns + +`boolean` + +#### Inherited from + +[`Test`](../classes/Test.mdx).[`pending`](../classes/Test.mdx#pending) + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/configurable-test-object.ts:53 + +*** + +### silentSkip + +```ts +get silentSkip(): boolean +``` + +```ts +set silentSkip(val): void +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `val` | `boolean` | + +#### Returns + +`boolean` + +#### Inherited from + +[`Test`](../classes/Test.mdx).[`silentSkip`](../classes/Test.mdx#silentskip) + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/configurable-test-object.ts:77 + +*** + +### skipReason + +```ts +get skipReason(): string +``` + +```ts +set skipReason(reason): void +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `reason` | `string` | + +#### Returns + +`string` + +#### Inherited from + +[`Test`](../classes/Test.mdx).[`skipReason`](../classes/Test.mdx#skipreason) + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/configurable-test-object.ts:61 + +*** + +### timeout + +```ts +get timeout(): number +``` + +```ts +set timeout(timeout): void +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `timeout` | `number` | + +#### Returns + +`number` + +#### Inherited from + +[`Test`](../classes/Test.mdx).[`timeout`](../classes/Test.mdx#timeout) + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/configurable-test-object.ts:85 + +*** + +### title + +```ts +get title(): string +``` + +#### Returns + +`string` + +#### Inherited from + +[`Test`](../classes/Test.mdx).[`title`](../classes/Test.mdx#title) + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/test-object.ts:16 + +## Methods + +### assign() + +```ts +assign(src): this +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `src` | `this` | + +#### Returns + +`this` + +#### Inherited from + +[`Test`](../classes/Test.mdx).[`assign`](../classes/Test.mdx#assign) + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/configurable-test-object.ts:20 + +*** + +### clone() + +```ts +clone(): Test +``` + +#### Returns + +[`Test`](../classes/Test.mdx) + +#### Inherited from + +[`Test`](../classes/Test.mdx).[`clone`](../classes/Test.mdx#clone) + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/test.ts:23 + +*** + +### disable() + +```ts +disable(): void +``` + +#### Returns + +`void` + +#### Inherited from + +[`Test`](../classes/Test.mdx).[`disable`](../classes/Test.mdx#disable) + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/configurable-test-object.ts:31 + +*** + +### enable() + +```ts +enable(): void +``` + +#### Returns + +`void` + +#### Inherited from + +[`Test`](../classes/Test.mdx).[`enable`](../classes/Test.mdx#enable) + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/configurable-test-object.ts:36 + +*** + +### fullTitle() + +```ts +fullTitle(): string +``` + +#### Returns + +`string` + +#### Inherited from + +[`Test`](../classes/Test.mdx).[`fullTitle`](../classes/Test.mdx#fulltitle) + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/test-object.ts:30 + +*** + +### skip() + +```ts +skip(__namedParameters): void +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `SkipData` | + +#### Returns + +`void` + +#### Inherited from + +[`Test`](../classes/Test.mdx).[`skip`](../classes/Test.mdx#skip) + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/configurable-test-object.ts:26 + +*** + +### titlePath() + +```ts +titlePath(): string[] +``` + +#### Returns + +`string`[] + +#### Inherited from + +[`Test`](../classes/Test.mdx).[`titlePath`](../classes/Test.mdx#titlepath) + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/test-object.ts:20 diff --git a/docs/api-reference/interfaces/TestResultWithRetries.mdx b/docs/api-reference/interfaces/TestResultWithRetries.mdx new file mode 100644 index 0000000..17a76c6 --- /dev/null +++ b/docs/api-reference/interfaces/TestResultWithRetries.mdx @@ -0,0 +1,467 @@ +[testplane](../README.mdx) / TestResultWithRetries + +# Interface: TestResultWithRetries + +## Extends + +- [`TestResult`](TestResult.mdx) + +## Properties + +| Property | Modifier | Type | Default value | Description | Inherited from | Defined in | +| ------ | ------ | ------ | ------ | ------ | ------ | ------ | +| `assertViewResults` | `public` | [`AssertViewResult`](../type-aliases/AssertViewResult.mdx)[] | `undefined` | - | [`TestResult`](TestResult.mdx).`assertViewResults` | testplane-docs/.testplane/src/types/index.ts:135 | +| `description?` | `public` | `string` | `undefined` | - | [`TestResult`](TestResult.mdx).`description` | testplane-docs/.testplane/src/types/index.ts:136 | +| `duration` | `public` | `number` | `undefined` | - | [`TestResult`](TestResult.mdx).`duration` | testplane-docs/.testplane/src/types/index.ts:137 | +| `err?` | `public` | [`TestError`](TestError.mdx) | `undefined` | - | [`TestResult`](TestResult.mdx).`err` | testplane-docs/.testplane/src/types/index.ts:138 | +| `fn` | `public` | `TestFunction`\<[`TestFunctionCtx`](TestFunctionCtx.mdx)\> | `undefined` | - | [`TestResult`](TestResult.mdx).`fn` | testplane-docs/.testplane/src/test-reader/test-object/test.ts:10 | +| ~~`hermioneCtx`~~ | `public` | [`ExecutionThreadToolCtx`](ExecutionThreadToolCtx.mdx) | `undefined` | **Deprecated** Use `testplaneCtx` instead | [`TestResult`](TestResult.mdx).`hermioneCtx` | testplane-docs/.testplane/src/types/index.ts:143 | +| `history` | `public` | [`CommandHistory`](CommandHistory.mdx) | `undefined` | - | [`TestResult`](TestResult.mdx).`history` | testplane-docs/.testplane/src/types/index.ts:144 | +| `meta` | `public` | \{\} | `undefined` | - | [`TestResult`](TestResult.mdx).`meta` | testplane-docs/.testplane/src/types/index.ts:145 | +| `parent` | `public` | `null` \| [`Suite`](../classes/Suite.mdx) | `null` | - | [`TestResult`](TestResult.mdx).`parent` | testplane-docs/.testplane/src/test-reader/test-object/test-object.ts:6 | +| `retriesLeft` | `public` | `number` | `undefined` | - | - | testplane-docs/.testplane/src/types/index.ts:151 | +| `sessionId` | `public` | `string` | `undefined` | - | [`TestResult`](TestResult.mdx).`sessionId` | testplane-docs/.testplane/src/types/index.ts:146 | +| `startTime` | `public` | `number` | `undefined` | - | [`TestResult`](TestResult.mdx).`startTime` | testplane-docs/.testplane/src/types/index.ts:147 | +| `testplaneCtx` | `public` | [`ExecutionThreadToolCtx`](ExecutionThreadToolCtx.mdx) | `undefined` | - | [`TestResult`](TestResult.mdx).`testplaneCtx` | testplane-docs/.testplane/src/types/index.ts:139 | + +## Accessors + +### browserId + +```ts +get browserId(): string +``` + +```ts +set browserId(id): void +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `id` | `string` | + +#### Returns + +`string` + +#### Inherited from + +[`TestResult`](TestResult.mdx).[`browserId`](TestResult.mdx#browserid) + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/configurable-test-object.ts:93 + +*** + +### browserVersion + +```ts +get browserVersion(): undefined | string +``` + +```ts +set browserVersion(version): void +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `version` | `string` | + +#### Returns + +`undefined` \| `string` + +#### Inherited from + +[`TestResult`](TestResult.mdx).[`browserVersion`](TestResult.mdx#browserversion) + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/configurable-test-object.ts:101 + +*** + +### disabled + +```ts +get disabled(): boolean +``` + +```ts +set disabled(val): void +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `val` | `boolean` | + +#### Returns + +`boolean` + +#### Inherited from + +[`TestResult`](TestResult.mdx).[`disabled`](TestResult.mdx#disabled) + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/configurable-test-object.ts:69 + +*** + +### file + +```ts +get file(): string +``` + +#### Returns + +`string` + +#### Inherited from + +[`TestResult`](TestResult.mdx).[`file`](TestResult.mdx#file) + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/configurable-test-object.ts:45 + +*** + +### hasBrowserVersionOverwritten + +```ts +get hasBrowserVersionOverwritten(): boolean +``` + +#### Returns + +`boolean` + +#### Inherited from + +[`TestResult`](TestResult.mdx).[`hasBrowserVersionOverwritten`](TestResult.mdx#hasbrowserversionoverwritten) + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/configurable-test-object.ts:105 + +*** + +### id + +```ts +get id(): string +``` + +#### Returns + +`string` + +#### Inherited from + +[`TestResult`](TestResult.mdx).[`id`](TestResult.mdx#id) + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/configurable-test-object.ts:41 + +*** + +### pending + +```ts +get pending(): boolean +``` + +```ts +set pending(val): void +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `val` | `boolean` | + +#### Returns + +`boolean` + +#### Inherited from + +[`TestResult`](TestResult.mdx).[`pending`](TestResult.mdx#pending) + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/configurable-test-object.ts:53 + +*** + +### silentSkip + +```ts +get silentSkip(): boolean +``` + +```ts +set silentSkip(val): void +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `val` | `boolean` | + +#### Returns + +`boolean` + +#### Inherited from + +[`TestResult`](TestResult.mdx).[`silentSkip`](TestResult.mdx#silentskip) + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/configurable-test-object.ts:77 + +*** + +### skipReason + +```ts +get skipReason(): string +``` + +```ts +set skipReason(reason): void +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `reason` | `string` | + +#### Returns + +`string` + +#### Inherited from + +[`TestResult`](TestResult.mdx).[`skipReason`](TestResult.mdx#skipreason) + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/configurable-test-object.ts:61 + +*** + +### timeout + +```ts +get timeout(): number +``` + +```ts +set timeout(timeout): void +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `timeout` | `number` | + +#### Returns + +`number` + +#### Inherited from + +[`TestResult`](TestResult.mdx).[`timeout`](TestResult.mdx#timeout) + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/configurable-test-object.ts:85 + +*** + +### title + +```ts +get title(): string +``` + +#### Returns + +`string` + +#### Inherited from + +[`TestResult`](TestResult.mdx).[`title`](TestResult.mdx#title) + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/test-object.ts:16 + +## Methods + +### assign() + +```ts +assign(src): this +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `src` | `this` | + +#### Returns + +`this` + +#### Inherited from + +[`TestResult`](TestResult.mdx).[`assign`](TestResult.mdx#assign) + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/configurable-test-object.ts:20 + +*** + +### clone() + +```ts +clone(): Test +``` + +#### Returns + +[`Test`](../classes/Test.mdx) + +#### Inherited from + +[`TestResult`](TestResult.mdx).[`clone`](TestResult.mdx#clone) + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/test.ts:23 + +*** + +### disable() + +```ts +disable(): void +``` + +#### Returns + +`void` + +#### Inherited from + +[`TestResult`](TestResult.mdx).[`disable`](TestResult.mdx#disable) + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/configurable-test-object.ts:31 + +*** + +### enable() + +```ts +enable(): void +``` + +#### Returns + +`void` + +#### Inherited from + +[`TestResult`](TestResult.mdx).[`enable`](TestResult.mdx#enable) + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/configurable-test-object.ts:36 + +*** + +### fullTitle() + +```ts +fullTitle(): string +``` + +#### Returns + +`string` + +#### Inherited from + +[`TestResult`](TestResult.mdx).[`fullTitle`](TestResult.mdx#fulltitle) + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/test-object.ts:30 + +*** + +### skip() + +```ts +skip(__namedParameters): void +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `SkipData` | + +#### Returns + +`void` + +#### Inherited from + +[`TestResult`](TestResult.mdx).[`skip`](TestResult.mdx#skip) + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/configurable-test-object.ts:26 + +*** + +### titlePath() + +```ts +titlePath(): string[] +``` + +#### Returns + +`string`[] + +#### Inherited from + +[`TestResult`](TestResult.mdx).[`titlePath`](TestResult.mdx#titlepath) + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/test-object.ts:20 diff --git a/docs/api-reference/interfaces/TestplaneCtx.mdx b/docs/api-reference/interfaces/TestplaneCtx.mdx new file mode 100644 index 0000000..3d91be2 --- /dev/null +++ b/docs/api-reference/interfaces/TestplaneCtx.mdx @@ -0,0 +1,11 @@ +[testplane](../README.mdx) / TestplaneCtx + +# Interface: ~~TestplaneCtx~~ + +## Deprecated + +Use `TestplaneCtx` instead + +## Extends + +- [`HermioneCtx`](HermioneCtx.mdx) diff --git a/docs/api-reference/interfaces/WdioBrowser.mdx b/docs/api-reference/interfaces/WdioBrowser.mdx new file mode 100644 index 0000000..018dfdc --- /dev/null +++ b/docs/api-reference/interfaces/WdioBrowser.mdx @@ -0,0 +1,10465 @@ +[testplane](../README.mdx) / WdioBrowser + +# Interface: ~~WdioBrowser~~ + +## Deprecated + +use `WebdriverIO.Browser` instead + +## Extends + +- `Omit`\<`BrowserBase`, `"on"` \| `"once"`\>.`BidiEventHandler`.`BidiHandler`.`ProtocolCommands`.`BrowserCommandsType` + +## Properties + +| Property | Type | Description | Inherited from | Defined in | +| ------ | ------ | ------ | ------ | ------ | +| ~~`$`~~ | (...`args`: [`Selector`]) => `ChainablePromiseElement`\<`Element`\> | - | `BrowserCommandsType.$` | | +| ~~`$$`~~ | (...`args`: [`HTMLElement`[] \| `Selector` \| `ElementReference`[] \| `Element`[]]) => `ChainablePromiseArray`\<`ElementArray`\> | - | `BrowserCommandsType.$$` | | +| ~~`CDP_SESSIONS`~~ | `Record`\<`string`, `CDPSession`\> | - | `BrowserCommandsType.CDP_SESSIONS` | testplane/node\_modules/webdriverio/build/commands/browser/mock.d.ts:6 | +| ~~`SESSION_MOCKS`~~ | `Record`\<`string`, `Set`\<`Interception`\>\> | - | `BrowserCommandsType.SESSION_MOCKS` | testplane/node\_modules/webdriverio/build/commands/browser/mock.d.ts:5 | +| ~~`action`~~ | (`this`: `Browser`, `type`: `"key"`, `opts`?: `Pick`\<`BaseActionParams`, `"id"`\>) => `KeyAction`(`this`: `Browser`, `type`: `"pointer"`, `opts`?: `BaseActionParams`) => `PointerAction`(`this`: `Browser`, `type`: `"wheel"`, `opts`?: `Pick`\<`BaseActionParams`, `"id"`\>) => `WheelAction` | - | `BrowserCommandsType.action` | testplane/node\_modules/webdriverio/build/commands/browser/action.d.ts:151 | +| ~~`actions`~~ | (`this`: `Browser`, `actions`: (`KeyAction` \| `PointerAction` \| `WheelAction`)[]) => `Promise`\<`void`\> | - | `BrowserCommandsType.actions` | testplane/node\_modules/webdriverio/build/commands/browser/actions.d.ts:28 | +| ~~`call`~~ | \<`T`\>(`fn`: () => `T`) => `T` \| `Promise`\<`T`\> | - | `BrowserCommandsType.call` | testplane/node\_modules/webdriverio/build/commands/browser/call.d.ts:43 | +| ~~`capabilities`~~ | `RemoteCapability` | Applied capabilities used in the current session. Note: these can differ from the actual requested capabilities if the remote end couldn't provide an exact match. | `Omit.capabilities` | testplane/node\_modules/webdriverio/build/types.d.ts:154 | +| ~~`commandList`~~ | `string`[] | - | `Omit.commandList` | testplane/node\_modules/webdriverio/build/types.d.ts:169 | +| ~~`custom$`~~ | (...`args`: [`string`, `...strategyArguments: any[]`]) => `ChainablePromiseElement`\<`Element`\> | - | `BrowserCommandsType.custom$` | | +| ~~`custom$$`~~ | (...`args`: [`string`, `...strategyArguments: any[]`]) => `ChainablePromiseArray`\<`ElementArray`\> | - | `BrowserCommandsType.custom$$` | | +| ~~`debug`~~ | (`this`: `Browser`, `commandTimeout`?: `number`) => `Promise`\<`unknown`\> | - | `BrowserCommandsType.debug` | testplane/node\_modules/webdriverio/build/commands/browser/debug.d.ts:31 | +| ~~`deleteCookies`~~ | (`this`: `Browser`, `names`?: `string` \| `string`[]) => `Promise`\<`void`\> \| `Promise`\<`void`[]\> | - | `BrowserCommandsType.deleteCookies` | testplane/node\_modules/webdriverio/build/commands/browser/deleteCookies.d.ts:11 | +| ~~`downloadFile`~~ | (`this`: `Browser`, `fileName`: `string`, `targetDirectory`: `string`) => `Promise`\<`object`\> | - | `BrowserCommandsType.downloadFile` | testplane/node\_modules/webdriverio/build/commands/browser/downloadFile.d.ts:43 | +| ~~`emulate`~~ | \<`Scope`\>(`this`: `Browser`, `scope`: `Scope`, `options`: `EmulationOptions`\[`Scope`\]) => `Promise`\<`void`\> | - | `BrowserCommandsType.emulate` | testplane/node\_modules/webdriverio/build/commands/browser/emulate.d.ts:34 | +| ~~`execute`~~ | \<`ReturnValue`, `InnerArguments`\>(`this`: `Browser` \| `MultiRemoteBrowser` \| `Element`, `script`: `string` \| (...`innerArgs`) => `ReturnValue`, ...`args`: `InnerArguments`) => `Promise`\<`ReturnValue`\> | - | `BrowserCommandsType.execute` | testplane/node\_modules/webdriverio/build/commands/browser/execute.d.ts:36 | +| ~~`executeAsync`~~ | \<`ReturnValue`, `InnerArguments`\>(`this`: `Browser` \| `Element`, `script`: `string` \| (...`args`) => `void`, ...`args`: `InnerArguments`) => `Promise`\<`ReturnValue`\> | - | `BrowserCommandsType.executeAsync` | testplane/node\_modules/webdriverio/build/commands/browser/executeAsync.d.ts:44 | +| ~~`getCookies`~~ | (`this`: `Browser`, `names`?: `string` \| `string`[]) => `Promise`\<`Cookie`[]\> | - | `BrowserCommandsType.getCookies` | testplane/node\_modules/webdriverio/build/commands/browser/getCookies.d.ts:33 | +| ~~`getPuppeteer`~~ | (`this`: `Browser`) => `Promise`\<`PuppeteerBrowser`\> | - | `BrowserCommandsType.getPuppeteer` | testplane/node\_modules/webdriverio/build/commands/browser/getPuppeteer.d.ts:37 | +| ~~`getWindowSize`~~ | (`this`: `Browser`) => `Promise`\<`BrowserSize`\> | - | `BrowserCommandsType.getWindowSize` | testplane/node\_modules/webdriverio/build/commands/browser/getWindowSize.d.ts:23 | +| ~~`isAndroid`~~ | `boolean` | - | `Omit.isAndroid` | testplane/node\_modules/webdriver/build/types.d.ts:16 | +| ~~`isBidi`~~ | `boolean` | - | `Omit.isBidi` | testplane/node\_modules/webdriver/build/types.d.ts:22 | +| ~~`isChromium`~~ | `boolean` | - | `Omit.isChromium` | testplane/node\_modules/webdriver/build/types.d.ts:14 | +| ~~`isDevTools`~~ | `boolean` | - | `Omit.isDevTools` | testplane/node\_modules/webdriver/build/types.d.ts:21 | +| ~~`isFirefox`~~ | `boolean` | - | `Omit.isFirefox` | testplane/node\_modules/webdriver/build/types.d.ts:15 | +| ~~`isIOS`~~ | `boolean` | - | `Omit.isIOS` | testplane/node\_modules/webdriver/build/types.d.ts:18 | +| ~~`isMobile`~~ | `boolean` | - | `Omit.isMobile` | testplane/node\_modules/webdriver/build/types.d.ts:17 | +| ~~`isMultiremote`~~ | `false` | - | `Omit.isMultiremote` | testplane/node\_modules/webdriverio/build/types.d.ts:183 | +| ~~`isSauce`~~ | `boolean` | - | `Omit.isSauce` | testplane/node\_modules/webdriver/build/types.d.ts:19 | +| ~~`isSeleniumStandalone`~~ | `boolean` | - | `Omit.isSeleniumStandalone` | testplane/node\_modules/webdriver/build/types.d.ts:20 | +| ~~`isW3C`~~ | `boolean` | - | `Omit.isW3C` | testplane/node\_modules/webdriver/build/types.d.ts:13 | +| ~~`keys`~~ | (`this`: `Browser`, `value`: `string` \| `string`[]) => `Promise`\<`void`\> | - | `BrowserCommandsType.keys` | testplane/node\_modules/webdriverio/build/commands/browser/keys.d.ts:22 | +| ~~`mock`~~ | (`this`: `Browser`, `url`: `string` \| `RegExp`, `filterOptions`?: `MockFilterOptions`) => `Promise`\<`Mock`\> | - | `BrowserCommandsType.mock` | testplane/node\_modules/webdriverio/build/commands/browser/mock.d.ts:113 | +| ~~`mockClearAll`~~ | () => `Promise`\<`void`\> | - | `BrowserCommandsType.mockClearAll` | testplane/node\_modules/webdriverio/build/commands/browser/mockClearAll.d.ts:27 | +| ~~`mockRestoreAll`~~ | () => `Promise`\<`void`\> | - | `BrowserCommandsType.mockRestoreAll` | testplane/node\_modules/webdriverio/build/commands/browser/mockRestoreAll.d.ts:25 | +| ~~`newWindow`~~ | (`this`: `Browser`, `url`: `string`, `__namedParameters`?: `NewWindowOptions`) => `Promise`\<`string`\> | - | `BrowserCommandsType.newWindow` | testplane/node\_modules/webdriverio/build/commands/browser/newWindow.d.ts:40 | +| ~~`options`~~ | `WebdriverIO` \| `Testrunner` | Applied WebdriverIO options (options that aren't officially part of WebdriverIO are stripped out of this object). | `Omit.options` | testplane/node\_modules/webdriverio/build/types.d.ts:163 | +| ~~`pause`~~ | (`this`: `Browser`, `milliseconds`?: `number`) => `Promise`\<`unknown`\> | - | `BrowserCommandsType.pause` | testplane/node\_modules/webdriverio/build/commands/browser/pause.d.ts:22 | +| ~~`puppeteer?`~~ | `Browser` | Puppeteer instance | `Omit.puppeteer` | testplane/node\_modules/webdriverio/build/types.d.ts:167 | +| ~~`react$`~~ | (...`args`: [`string`, `ReactSelectorOptions?`]) => `ChainablePromiseElement`\<`Element`\> | - | `BrowserCommandsType.react$` | | +| ~~`react$$`~~ | (...`args`: [`string`, `ReactSelectorOptions?`]) => `ChainablePromiseArray`\<`ElementArray`\> | - | `BrowserCommandsType.react$$` | | +| ~~`reloadSession`~~ | (`this`: `Browser`, `newCapabilities`?: `Capabilities`) => `Promise`\<`string`\> | - | `BrowserCommandsType.reloadSession` | testplane/node\_modules/webdriverio/build/commands/browser/reloadSession.d.ts:51 | +| ~~`requestedCapabilities`~~ | `RemoteCapability` | Requested capabilities defined in the config object. | `Omit.requestedCapabilities` | testplane/node\_modules/webdriverio/build/types.d.ts:158 | +| ~~`savePDF`~~ | (`this`: `Browser`, `filepath`: `string`, `options`?: `PDFPrintOptions`) => `Promise`\<`Buffer`\> | - | `BrowserCommandsType.savePDF` | testplane/node\_modules/webdriverio/build/commands/browser/savePDF.d.ts:44 | +| ~~`saveRecordingScreen`~~ | (`this`: `Browser`, `filepath`: `string`) => `Promise`\<`Buffer`\> | - | `BrowserCommandsType.saveRecordingScreen` | testplane/node\_modules/webdriverio/build/commands/browser/saveRecordingScreen.d.ts:27 | +| ~~`saveScreenshot`~~ | (`this`: `Browser`, `filepath`: `string`) => `Promise`\<`Buffer`\> | - | `BrowserCommandsType.saveScreenshot` | testplane/node\_modules/webdriverio/build/commands/browser/saveScreenshot.d.ts:28 | +| ~~`scroll`~~ | (`this`: `Browser`, `x`?: `number`, `y`?: `number`) => `void` \| `Promise`\<`void`\> | - | `BrowserCommandsType.scroll` | testplane/node\_modules/webdriverio/build/commands/browser/scroll.d.ts:24 | +| ~~`sessionId`~~ | `string` | Session id for the current running session | `Omit.sessionId` | testplane/node\_modules/webdriverio/build/types.d.ts:149 | +| ~~`setCookies`~~ | (`this`: `Browser`, `cookieObjs`: `Cookie` \| `Cookie`[]) => `Promise`\<`void`\> | - | `BrowserCommandsType.setCookies` | testplane/node\_modules/webdriverio/build/commands/browser/setCookies.d.ts:56 | +| ~~`setTimeout`~~ | (`this`: `Browser`, `timeouts`: `Partial`\<`Timeouts`\>) => `Promise`\<`void`\> | - | `BrowserCommandsType.setTimeout` | testplane/node\_modules/webdriverio/build/commands/browser/setTimeout.d.ts:37 | +| ~~`setWindowSize`~~ | (`this`: `Browser`, `width`: `number`, `height`: `number`) => `Promise`\<`void`\> | - | `BrowserCommandsType.setWindowSize` | testplane/node\_modules/webdriverio/build/commands/browser/setWindowSize.d.ts:19 | +| ~~`shadow$`~~ | (...`args`: [`string`]) => `ChainablePromiseElement`\<`Element`\> | - | `BrowserCommandsType.shadow$` | | +| ~~`shadow$$`~~ | (...`args`: [`string`]) => `ChainablePromiseArray`\<`ElementArray`\> | - | `BrowserCommandsType.shadow$$` | | +| ~~`strategies`~~ | `Map`\<`any`, `any`\> | - | `Omit.strategies` | testplane/node\_modules/webdriverio/build/types.d.ts:168 | +| ~~`switchWindow`~~ | (`this`: `Browser`, `matcher`: `string` \| `RegExp`) => `Promise`\<`string`\> | - | `BrowserCommandsType.switchWindow` | testplane/node\_modules/webdriverio/build/commands/browser/switchWindow.d.ts:29 | +| ~~`throttle`~~ | (`this`: `Browser`, `params`: `ThrottleOptions`) => `Promise`\<`void`\> | - | `BrowserCommandsType.throttle` | testplane/node\_modules/webdriverio/build/commands/browser/throttle.d.ts:5 | +| ~~`throttleNetwork`~~ | (`this`: `Browser`, `params`: `ThrottleOptions`) => `Promise`\<`null`\> | - | `BrowserCommandsType.throttleNetwork` | testplane/node\_modules/webdriverio/build/commands/browser/throttleNetwork.d.ts:2 | +| ~~`touchAction`~~ | (`this`: `Browser`, `actions`: `TouchActions`) => `Promise`\<`void`\> | - | `BrowserCommandsType.touchAction` | testplane/node\_modules/webdriverio/build/commands/browser/touchAction.d.ts:73 | +| ~~`uploadFile`~~ | (`this`: `Browser`, `localPath`: `string`) => `Promise`\<`string`\> | - | `BrowserCommandsType.uploadFile` | testplane/node\_modules/webdriverio/build/commands/browser/uploadFile.d.ts:31 | +| ~~`url`~~ | (`this`: `Browser`, `path`: `string`) => `Promise`\<`string`\> | - | `BrowserCommandsType.url` | testplane/node\_modules/webdriverio/build/commands/browser/url.d.ts:37 | +| ~~`waitUntil`~~ | \<`ReturnValue`\>(`this`: `Browser` \| `Element`, `condition`: () => `ReturnValue` \| `Promise`\<`ReturnValue`\>, `__namedParameters`?: `Partial`\<`WaitUntilOptions`\>) => `Promise`\<`Exclude`\<`ReturnValue`, `boolean`\>\> | - | `BrowserCommandsType.waitUntil` | testplane/node\_modules/webdriverio/build/commands/browser/waitUntil.d.ts:21 | + +## Accessors + +### ~~isConnected~~ + +```ts +get isConnected(): boolean +``` + +#### Returns + +`boolean` + +#### Inherited from + +`BidiHandler.isConnected` + +#### Defined in + +testplane/node\_modules/webdriver/build/bidi/core.d.ts:12 + +*** + +### ~~socket~~ + +```ts +get socket(): WebSocket +``` + +#### Returns + +`WebSocket` + +#### Inherited from + +`BidiHandler.socket` + +#### Defined in + +testplane/node\_modules/webdriver/build/bidi/core.d.ts:11 + +## Methods + +### ~~\[captureRejectionSymbol\]()?~~ + +```ts +optional [captureRejectionSymbol]( + error, + event, ... + args): void +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `error` | `Error` | +| `event` | `string` | +| ...`args` | `any`[] | + +#### Returns + +`void` + +#### Inherited from + +`Omit.[captureRejectionSymbol]` + +#### Defined in + +testplane/node\_modules/@types/node/events.d.ts:115 + +*** + +### ~~\_getWindowSize()~~ + +```ts +_getWindowSize(): Promise +``` + +Jsonwp Protocol Command + +Get the size of the current focused window. + +#### Returns + +`Promise`\<`ProtocolCommandResponse`\> + +#### Ref + +https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#get-sessionsessionidwindowwindowhandlesize + +#### Deprecated + +This command is deprecated and likely not supported by any browser. + +#### Inherited from + +`ProtocolCommands._getWindowSize` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/jsonwp.d.ts:193 + +*** + +### ~~\_setWindowSize()~~ + +```ts +_setWindowSize(width, height): Promise +``` + +Jsonwp Protocol Command + +Change the size of the current focused window. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `width` | `number` | +| `height` | `number` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#post-sessionsessionidwindowwindowhandlesize + +#### Deprecated + +This command is deprecated and likely not supported by any browser. + +#### Inherited from + +`ProtocolCommands._setWindowSize` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/jsonwp.d.ts:202 + +*** + +### ~~acceptAlert()~~ + +```ts +acceptAlert(): Promise +``` + +Webdriver Protocol Command + +The Accept Alert command accepts a simple dialog if present, otherwise error. + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://w3c.github.io/webdriver/#dfn-accept-alert + +#### Inherited from + +`ProtocolCommands.acceptAlert` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:450 + +*** + +### ~~activateApp()~~ + +```ts +activateApp(appId): Promise +``` + +Appium Protocol Command + +Activate the given app onto the device + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `appId` | `string` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://appium.github.io/appium.io/docs/en/commands/device/app/activate-app/ + +#### Inherited from + +`ProtocolCommands.activateApp` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/appium.d.ts:154 + +*** + +### ~~activateIME()~~ + +```ts +activateIME(engine): Promise +``` + +Jsonwp Protocol Command + +No description available, please see reference link. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `engine` | `string` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidimeactivate + +#### Deprecated + +This command is deprecated and likely not supported by any browser. + +#### Inherited from + +`ProtocolCommands.activateIME` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/jsonwp.d.ts:525 + +*** + +### ~~addCommand()~~ + +```ts +addCommand( + name, + func, + attachToElement?, + proto?, + instances?): void +``` + +add command to `browser` or `element` scope + +#### Type Parameters + +| Type Parameter | Default type | +| ------ | ------ | +| `IsElement` *extends* `boolean` | `false` | + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `name` | `string` | +| `func` | `AddCommandFn` \| `AddCommandFnScoped`\<[`WdioBrowser`](WdioBrowser.mdx), `IsElement`\> | +| `attachToElement`? | `IsElement` | +| `proto`? | `Record`\<`string`, `any`\> | +| `instances`? | `Record`\<`string`, `Browser` \| `MultiRemoteBrowser`\> | + +#### Returns + +`void` + +#### Inherited from + +`Omit.addCommand` + +#### Defined in + +testplane/node\_modules/webdriverio/build/types.d.ts:135 + +*** + +### ~~addCookie()~~ + +```ts +addCookie(cookie): Promise +``` + +Webdriver Protocol Command + +The Add Cookie command adds a single cookie to the cookie store associated with the active document's address. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `cookie` | `object` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://w3c.github.io/webdriver/#dfn-adding-a-cookie + +#### Inherited from + +`ProtocolCommands.addCookie` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:394 + +*** + +### ~~addCredential()~~ + +```ts +addCredential( + authenticatorId, + credentialId, + isResidentCredential, + rpId, + privateKey, + userHandle, + signCount, +largeBlob?): Promise +``` + +Webdriver Protocol Command + +Injects a Public Key Credential Source into an existing Virtual Authenticator. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `authenticatorId` | `string` | +| `credentialId` | `string` | +| `isResidentCredential` | `boolean` | +| `rpId` | `string` | +| `privateKey` | `string` | +| `userHandle` | `string` | +| `signCount` | `number` | +| `largeBlob`? | `string` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://www.w3.org/TR/webauthn-2/#sctn-automation-add-credential + +#### Inherited from + +`ProtocolCommands.addCredential` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:593 + +*** + +### ~~addListener()~~ + +```ts +addListener(eventName, listener): this +``` + +Alias for `emitter.on(eventName, listener)`. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `eventName` | `string` \| `symbol` | +| `listener` | (...`args`) => `void` | + +#### Returns + +`this` + +#### Since + +v0.1.26 + +#### Inherited from + +`Omit.addListener` + +#### Defined in + +testplane/node\_modules/@types/node/events.d.ts:475 + +*** + +### ~~addLocatorStrategy()~~ + +```ts +addLocatorStrategy(name, func): void +``` + +create custom selector + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `name` | `string` | +| `func` | (`selector`, `root`) => `CustomLocatorReturnValue` \| (`selector`) => `CustomLocatorReturnValue` | + +#### Returns + +`void` + +#### Inherited from + +`Omit.addLocatorStrategy` + +#### Defined in + +testplane/node\_modules/webdriverio/build/types.d.ts:143 + +*** + +### ~~addVirtualAuthenticator()~~ + +```ts +addVirtualAuthenticator( + protocol?, + transport?, + hasResidentKey?, + hasUserVerification?, + isUserConsenting?, + isUserVerified?, + extensions?, +uvm?): Promise +``` + +Webdriver Protocol Command + +Creates a software [Virtual Authenticator](https://www.w3.org/TR/webauthn-2/#virtual-authenticators). + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `protocol`? | `string` | +| `transport`? | `string` | +| `hasResidentKey`? | `boolean` | +| `hasUserVerification`? | `boolean` | +| `isUserConsenting`? | `boolean` | +| `isUserVerified`? | `boolean` | +| `extensions`? | `string`[] | +| `uvm`? | `object`[] | + +#### Returns + +`Promise`\<`string`\> + +#### Ref + +https://www.w3.org/TR/webauthn-2/#sctn-automation-add-virtual-authenticator + +#### Inherited from + +`ProtocolCommands.addVirtualAuthenticator` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:577 + +*** + +### ~~assertPerformance()~~ + +```ts +assertPerformance(name, metrics?): Promise +``` + +Saucelabs Protocol Command + +Assert against the performance baseline of your app. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `name` | `string` | +| `metrics`? | `string`[] | + +#### Returns + +`Promise`\<`ProtocolCommandResponse`\> + +#### Ref + +https://wiki.saucelabs.com/display/DOCS/Custom+Sauce+Labs+WebDriver+Extensions+for+Network+and+Log+Commands + +#### Example + +```js +// test performance for a page +browser.url('https://webdriver.io') +const hasRegression = browser.assertPerformance({ + name: 'my performance test', // make sure that the name is also set in the sauce options in your capabilities + metrics: ['score', 'firstPaint'] +}) +``` + +#### Inherited from + +`ProtocolCommands.assertPerformance` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/saucelabs.d.ts:147 + +*** + +### ~~back()~~ + +```ts +back(): Promise +``` + +Webdriver Protocol Command + +The Back command causes the browser to traverse one step backward in the joint session history of the current top-level browsing context. This is equivalent to pressing the back button in the browser chrome or calling `window.history.back`. + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://w3c.github.io/webdriver/#dfn-back + +#### Inherited from + +`ProtocolCommands.back` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:66 + +*** + +### ~~background()~~ + +```ts +background(seconds): Promise +``` + +Appium Protocol Command + +Send the currently running app for this session to the background. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `seconds` | `null` \| `number` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://appium.github.io/appium.io/docs/en/commands/device/app/background-app/ + +#### Deprecated + +Use `driver.execute('mobile: backgroundApp', { ... })` instead + +#### Inherited from + +`ProtocolCommands.background` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/appium.d.ts:349 + +*** + +### ~~browserClose()~~ + +```ts +browserClose(params): Promise +``` + +WebDriver Bidi command to send command method "browser.close" with parameters. + +#### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `params` | `EmptyParams` | WebDriver Bidi command to send command method "browser.close" with parameters. | + +#### Returns + +`Promise`\<`EmptyResult`\> + +`Promise` + +#### Url + +https://w3c.github.io/webdriver-bidi/#command-browser-close + +#### Inherited from + +`BidiHandler.browserClose` + +#### Defined in + +testplane/node\_modules/webdriver/build/bidi/handler.d.ts:60 + +*** + +### ~~browsingContextActivate()~~ + +```ts +browsingContextActivate(params): Promise +``` + +WebDriver Bidi command to send command method "browsingContext.activate" with parameters. + +#### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `params` | `BrowsingContextActivateParameters` | WebDriver Bidi command to send command method "browsingContext.activate" with parameters. | + +#### Returns + +`Promise`\<`EmptyResult`\> + +`Promise` + +#### Url + +https://w3c.github.io/webdriver-bidi/#command-browsingContext-activate + +#### Inherited from + +`BidiHandler.browsingContextActivate` + +#### Defined in + +testplane/node\_modules/webdriver/build/bidi/handler.d.ts:67 + +*** + +### ~~browsingContextCaptureScreenshot()~~ + +```ts +browsingContextCaptureScreenshot(params): Promise +``` + +WebDriver Bidi command to send command method "browsingContext.captureScreenshot" with parameters. + +#### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `params` | `BrowsingContextCaptureScreenshotParameters` | WebDriver Bidi command to send command method "browsingContext.captureScreenshot" with parameters. | + +#### Returns + +`Promise`\<`BrowsingContextCaptureScreenshotResult`\> + +`Promise` + +#### Url + +https://w3c.github.io/webdriver-bidi/#command-browsingContext-captureScreenshot + +#### Inherited from + +`BidiHandler.browsingContextCaptureScreenshot` + +#### Defined in + +testplane/node\_modules/webdriver/build/bidi/handler.d.ts:74 + +*** + +### ~~browsingContextClose()~~ + +```ts +browsingContextClose(params): Promise +``` + +WebDriver Bidi command to send command method "browsingContext.close" with parameters. + +#### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `params` | `BrowsingContextCloseParameters` | WebDriver Bidi command to send command method "browsingContext.close" with parameters. | + +#### Returns + +`Promise`\<`EmptyResult`\> + +`Promise` + +#### Url + +https://w3c.github.io/webdriver-bidi/#command-browsingContext-close + +#### Inherited from + +`BidiHandler.browsingContextClose` + +#### Defined in + +testplane/node\_modules/webdriver/build/bidi/handler.d.ts:81 + +*** + +### ~~browsingContextCreate()~~ + +```ts +browsingContextCreate(params): Promise +``` + +WebDriver Bidi command to send command method "browsingContext.create" with parameters. + +#### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `params` | `BrowsingContextCreateParameters` | WebDriver Bidi command to send command method "browsingContext.create" with parameters. | + +#### Returns + +`Promise`\<`BrowsingContextCreateResult`\> + +`Promise` + +#### Url + +https://w3c.github.io/webdriver-bidi/#command-browsingContext-create + +#### Inherited from + +`BidiHandler.browsingContextCreate` + +#### Defined in + +testplane/node\_modules/webdriver/build/bidi/handler.d.ts:88 + +*** + +### ~~browsingContextGetTree()~~ + +```ts +browsingContextGetTree(params): Promise +``` + +WebDriver Bidi command to send command method "browsingContext.getTree" with parameters. + +#### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `params` | `BrowsingContextGetTreeParameters` | WebDriver Bidi command to send command method "browsingContext.getTree" with parameters. | + +#### Returns + +`Promise`\<`BrowsingContextGetTreeResult`\> + +`Promise` + +#### Url + +https://w3c.github.io/webdriver-bidi/#command-browsingContext-getTree + +#### Inherited from + +`BidiHandler.browsingContextGetTree` + +#### Defined in + +testplane/node\_modules/webdriver/build/bidi/handler.d.ts:95 + +*** + +### ~~browsingContextHandleUserPrompt()~~ + +```ts +browsingContextHandleUserPrompt(params): Promise +``` + +WebDriver Bidi command to send command method "browsingContext.handleUserPrompt" with parameters. + +#### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `params` | `BrowsingContextHandleUserPromptParameters` | WebDriver Bidi command to send command method "browsingContext.handleUserPrompt" with parameters. | + +#### Returns + +`Promise`\<`EmptyResult`\> + +`Promise` + +#### Url + +https://w3c.github.io/webdriver-bidi/#command-browsingContext-handleUserPrompt + +#### Inherited from + +`BidiHandler.browsingContextHandleUserPrompt` + +#### Defined in + +testplane/node\_modules/webdriver/build/bidi/handler.d.ts:102 + +*** + +### ~~browsingContextLocateNodes()~~ + +```ts +browsingContextLocateNodes(params): Promise +``` + +WebDriver Bidi command to send command method "browsingContext.locateNodes" with parameters. + +#### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `params` | `BrowsingContextLocateNodesParameters` | WebDriver Bidi command to send command method "browsingContext.locateNodes" with parameters. | + +#### Returns + +`Promise`\<`BrowsingContextLocateNodesResult`\> + +`Promise` + +#### Url + +https://w3c.github.io/webdriver-bidi/#command-browsingContext-locateNodes + +#### Inherited from + +`BidiHandler.browsingContextLocateNodes` + +#### Defined in + +testplane/node\_modules/webdriver/build/bidi/handler.d.ts:109 + +*** + +### ~~browsingContextNavigate()~~ + +```ts +browsingContextNavigate(params): Promise +``` + +WebDriver Bidi command to send command method "browsingContext.navigate" with parameters. + +#### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `params` | `BrowsingContextNavigateParameters` | WebDriver Bidi command to send command method "browsingContext.navigate" with parameters. | + +#### Returns + +`Promise`\<`BrowsingContextNavigateResult`\> + +`Promise` + +#### Url + +https://w3c.github.io/webdriver-bidi/#command-browsingContext-navigate + +#### Inherited from + +`BidiHandler.browsingContextNavigate` + +#### Defined in + +testplane/node\_modules/webdriver/build/bidi/handler.d.ts:116 + +*** + +### ~~browsingContextPrint()~~ + +```ts +browsingContextPrint(params): Promise +``` + +WebDriver Bidi command to send command method "browsingContext.print" with parameters. + +#### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `params` | `BrowsingContextPrintParameters` | WebDriver Bidi command to send command method "browsingContext.print" with parameters. | + +#### Returns + +`Promise`\<`BrowsingContextPrintResult`\> + +`Promise` + +#### Url + +https://w3c.github.io/webdriver-bidi/#command-browsingContext-print + +#### Inherited from + +`BidiHandler.browsingContextPrint` + +#### Defined in + +testplane/node\_modules/webdriver/build/bidi/handler.d.ts:123 + +*** + +### ~~browsingContextReload()~~ + +```ts +browsingContextReload(params): Promise +``` + +WebDriver Bidi command to send command method "browsingContext.reload" with parameters. + +#### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `params` | `BrowsingContextReloadParameters` | WebDriver Bidi command to send command method "browsingContext.reload" with parameters. | + +#### Returns + +`Promise`\<`EmptyResult`\> + +`Promise` + +#### Url + +https://w3c.github.io/webdriver-bidi/#command-browsingContext-reload + +#### Inherited from + +`BidiHandler.browsingContextReload` + +#### Defined in + +testplane/node\_modules/webdriver/build/bidi/handler.d.ts:130 + +*** + +### ~~browsingContextSetViewport()~~ + +```ts +browsingContextSetViewport(params): Promise +``` + +WebDriver Bidi command to send command method "browsingContext.setViewport" with parameters. + +#### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `params` | `BrowsingContextSetViewportParameters` | WebDriver Bidi command to send command method "browsingContext.setViewport" with parameters. | + +#### Returns + +`Promise`\<`EmptyResult`\> + +`Promise` + +#### Url + +https://w3c.github.io/webdriver-bidi/#command-browsingContext-setViewport + +#### Inherited from + +`BidiHandler.browsingContextSetViewport` + +#### Defined in + +testplane/node\_modules/webdriver/build/bidi/handler.d.ts:137 + +*** + +### ~~browsingContextTraverseHistory()~~ + +```ts +browsingContextTraverseHistory(params): Promise +``` + +WebDriver Bidi command to send command method "browsingContext.traverseHistory" with parameters. + +#### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `params` | `BrowsingContextTraverseHistoryParameters` | WebDriver Bidi command to send command method "browsingContext.traverseHistory" with parameters. | + +#### Returns + +`Promise`\<`BrowsingContextTraverseHistoryResult`\> + +`Promise` + +#### Url + +https://w3c.github.io/webdriver-bidi/#command-browsingContext-traverseHistory + +#### Inherited from + +`BidiHandler.browsingContextTraverseHistory` + +#### Defined in + +testplane/node\_modules/webdriver/build/bidi/handler.d.ts:144 + +*** + +### ~~buttonDown()~~ + +```ts +buttonDown(button?): Promise +``` + +Jsonwp Protocol Command + +Click and hold the left mouse button (at the coordinates set by the last moveto command). Note that the next mouse-related command that should follow is buttonup . Any other mouse command (such as click or another call to buttondown) will yield undefined behaviour. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `button`? | `number` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidbuttondown + +#### Deprecated + +This command is deprecated and likely not supported by any browser. Use the "action" command instead to execute a click gesture! + +#### Inherited from + +`ProtocolCommands.buttonDown` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/jsonwp.d.ts:561 + +*** + +### ~~buttonUp()~~ + +```ts +buttonUp(button?): Promise +``` + +Jsonwp Protocol Command + +Releases the mouse button previously held (where the mouse is currently at). Must be called once for every buttondown command issued. See the note in click and buttondown about implications of out-of-order commands. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `button`? | `number` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidbuttonup + +#### Deprecated + +This command is deprecated and likely not supported by any browser. Use the "action" command instead to execute a click gesture! + +#### Inherited from + +`ProtocolCommands.buttonUp` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/jsonwp.d.ts:570 + +*** + +### ~~clearLocalStorage()~~ + +```ts +clearLocalStorage(): Promise +``` + +Jsonwp Protocol Command + +Clear the storage. + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#get-sessionsessionidlocal_storage + +#### Deprecated + +This command is deprecated and likely not supported by any browser. Use the "execute" command instead to interact with the session storage interface! + +#### Inherited from + +`ProtocolCommands.clearLocalStorage` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/jsonwp.d.ts:669 + +*** + +### ~~clearMockCalls()~~ + +```ts +clearMockCalls(mockId, restore?): Promise +``` + +Saucelabs Protocol Command + +Clear list of mock calls. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `mockId` | `string` | +| `restore`? | `boolean` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://wiki.saucelabs.com/display/DOCS/Custom+Sauce+Labs+WebDriver+Extensions+for+Network+and+Log+Commands + +#### Inherited from + +`ProtocolCommands.clearMockCalls` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/saucelabs.d.ts:185 + +*** + +### ~~clearSessionStorage()~~ + +```ts +clearSessionStorage(): Promise +``` + +Jsonwp Protocol Command + +Clear the storage. + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#delete-sessionsessionidsession_storage + +#### Deprecated + +This command is deprecated and likely not supported by any browser. Use the "execute" command instead to interact with the session storage interface! + +#### Inherited from + +`ProtocolCommands.clearSessionStorage` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/jsonwp.d.ts:723 + +*** + +### ~~closeApp()~~ + +```ts +closeApp(): Promise +``` + +Appium Protocol Command + +Close an app on device. + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://appium.github.io/appium.io/docs/en/commands/device/app/close-app/ + +#### Deprecated + +Use `driver.execute('mobile: terminateApp', { ... })` instead + +#### Inherited from + +`ProtocolCommands.closeApp` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/appium.d.ts:340 + +*** + +### ~~closeWindow()~~ + +```ts +closeWindow(): Promise +``` + +Webdriver Protocol Command + +The Close Window command closes the current top-level browsing context. Once done, if there are no more top-level browsing contexts open, the WebDriver session itself is closed. + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://w3c.github.io/webdriver/#dfn-close-window + +#### Inherited from + +`ProtocolCommands.closeWindow` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:106 + +*** + +### ~~compareImages()~~ + +```ts +compareImages( + mode, + firstImage, + secondImage, +options): Promise +``` + +Appium Protocol Command + +This feature conducts image comparisons utilizing the capabilities of the OpenCV framework. Please note that for this functionality to work, both the OpenCV framework and the opencv4nodejs module must be installed on the machine where the Appium server is operational. ***Furthermore, you'll need to have the [`images-plugin`](https://github.com/appium/appium/tree/master/packages/images-plugin) plugin installed to use this feature with Appium 2.0.*** + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `mode` | `string` | +| `firstImage` | `string` | +| `secondImage` | `string` | +| `options` | `object` | + +#### Returns + +`Promise`\<`ProtocolCommandResponse`\> + +#### Ref + +https://appium.github.io/appium.io/docs/en/writing-running-appium/image-comparison/ + +#### Inherited from + +`ProtocolCommands.compareImages` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/appium.d.ts:563 + +*** + +### ~~connect()~~ + +```ts +connect(): Promise +``` + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +`BidiHandler.connect` + +#### Defined in + +testplane/node\_modules/webdriver/build/bidi/core.d.ts:10 + +*** + +### ~~createMockSensor()~~ + +```ts +createMockSensor( + mockSensorType, + maxSamplingFrequency, +minSamplingFrequency): Promise +``` + +Webdriver Protocol Command + +Creates a mock sensor to emulate sensors like Ambient Light Sensor. __Note:__ this feature has not landed in all browsers yet. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `mockSensorType` | `string` | +| `maxSamplingFrequency` | `number` | +| `minSamplingFrequency` | `number` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://w3c.github.io/sensors/#create-mock-sensor-command + +#### Inherited from + +`ProtocolCommands.createMockSensor` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:537 + +*** + +### ~~createWindow()~~ + +```ts +createWindow(type): Promise +``` + +Webdriver Protocol Command + +Create a new top-level browsing context. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `type` | `"tab"` \| `"window"` | + +#### Returns + +`Promise`\<`WindowHandle`\> + +#### Ref + +https://w3c.github.io/webdriver/#new-window + +#### Inherited from + +`ProtocolCommands.createWindow` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:122 + +*** + +### ~~deactivateIME()~~ + +```ts +deactivateIME(): Promise +``` + +Jsonwp Protocol Command + +No description available, please see reference link. + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidimedeactivate + +#### Deprecated + +This command is deprecated and likely not supported by any browser. + +#### Inherited from + +`ProtocolCommands.deactivateIME` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/jsonwp.d.ts:516 + +*** + +### ~~deleteAllCookies()~~ + +```ts +deleteAllCookies(): Promise +``` + +Webdriver Protocol Command + +The Delete All Cookies command allows deletion of all cookies associated with the active document's address. + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://w3c.github.io/webdriver/#dfn-delete-all-cookies + +#### Inherited from + +`ProtocolCommands.deleteAllCookies` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:402 + +*** + +### ~~deleteCookie()~~ + +```ts +deleteCookie(name): Promise +``` + +Webdriver Protocol Command + +The Delete Cookie command allows you to delete either a single cookie by parameter name, or all the cookies associated with the active document's address if name is undefined. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `name` | `string` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://w3c.github.io/webdriver/#dfn-delete-cookie + +#### Inherited from + +`ProtocolCommands.deleteCookie` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:418 + +*** + +### ~~deleteDownloadableFiles()~~ + +```ts +deleteDownloadableFiles(): Promise +``` + +Selenium Protocol Command + +Remove all downloadable files from remote machine on which the browser is running. + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://www.seleniumhq.org/ + +#### Inherited from + +`ProtocolCommands.deleteDownloadableFiles` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/selenium.d.ts:34 + +*** + +### ~~deleteLocalStorageItem()~~ + +```ts +deleteLocalStorageItem(key): Promise +``` + +Jsonwp Protocol Command + +No description available, please see reference link. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `key` | `string` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#delete-sessionsessionidlocal_storagekeykey + +#### Deprecated + +This command is deprecated and likely not supported by any browser. Use the "execute" command instead to interact with the session storage interface! + +#### Inherited from + +`ProtocolCommands.deleteLocalStorageItem` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/jsonwp.d.ts:687 + +*** + +### ~~deleteMockSensor()~~ + +```ts +deleteMockSensor(type): Promise +``` + +Webdriver Protocol Command + +The Delete Session command closes any top-level browsing contexts associated with the current session, terminates the connection, and finally closes the current session. __Note:__ this feature has not landed in all browsers yet. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `type` | `string` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://w3c.github.io/sensors/#delete-mock-sensor-command + +#### Inherited from + +`ProtocolCommands.deleteMockSensor` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:561 + +*** + +### ~~deleteNetworkConditions()~~ + +```ts +deleteNetworkConditions(): Promise +``` + +Chromium Protocol Command + +Disable any network throttling which might have been set. Equivalent of setting the `No throttling` preset. + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://github.com/bayandin/chromedriver/blob/v2.45/window_commands.cc#L1724-L1745 + +#### Inherited from + +`ProtocolCommands.deleteNetworkConditions` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/chromium.d.ts:155 + +*** + +### ~~deleteSession()~~ + +```ts +deleteSession(deleteSessionOpts?): Promise +``` + +Webdriver Protocol Command + +The Delete Session command closes any top-level browsing contexts associated with the current session, terminates the connection, and finally closes the current session. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `deleteSessionOpts`? | `DeleteSessionOpts` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://w3c.github.io/webdriver/#dfn-delete-session + +#### Inherited from + +`ProtocolCommands.deleteSession` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:18 + +*** + +### ~~deleteSessionStorageItem()~~ + +```ts +deleteSessionStorageItem(key): Promise +``` + +Jsonwp Protocol Command + +Remove the storage item for the given key. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `key` | `string` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#delete-sessionsessionidsession_storagekeykey + +#### Deprecated + +This command is deprecated and likely not supported by any browser. Use the "execute" command instead to interact with the session storage interface! + +#### Inherited from + +`ProtocolCommands.deleteSessionStorageItem` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/jsonwp.d.ts:741 + +*** + +### ~~dismissAlert()~~ + +```ts +dismissAlert(): Promise +``` + +Webdriver Protocol Command + +The Dismiss Alert command dismisses a simple dialog if present, otherwise error. A request to dismiss an alert user prompt, which may not necessarily have a dismiss button, has the same effect as accepting it. + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://w3c.github.io/webdriver/#dfn-dismiss-alert + +#### Inherited from + +`ProtocolCommands.dismissAlert` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:442 + +*** + +### ~~download()~~ + +```ts +download(name): Promise +``` + +Selenium Protocol Command + +Download a file from remote machine on which the browser is running. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `name` | `string` | + +#### Returns + +`Promise`\<`ProtocolCommandResponse`\> + +#### Ref + +https://www.seleniumhq.org/ + +#### Inherited from + +`ProtocolCommands.download` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/selenium.d.ts:26 + +*** + +### ~~elementClear()~~ + +```ts +elementClear(elementId): Promise +``` + +Webdriver Protocol Command + +The Element Clear command scrolls into view an editable or resettable element and then attempts to clear its selected files or text content. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `elementId` | `string` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://w3c.github.io/webdriver/#dfn-element-clear + +#### Inherited from + +`ProtocolCommands.elementClear` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:346 + +*** + +### ~~elementClick()~~ + +```ts +elementClick(elementId): Promise +``` + +Webdriver Protocol Command + +The Element Click command scrolls into view the element if it is not already pointer-interactable, and clicks its in-view center point. If the element's center point is obscured by another element, an element click intercepted error is returned. If the element is outside the viewport, an element not interactable error is returned. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `elementId` | `string` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://w3c.github.io/webdriver/#dfn-element-click + +#### Inherited from + +`ProtocolCommands.elementClick` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:338 + +*** + +### ~~elementEquals()~~ + +```ts +elementEquals(elementId, otherElementId): Promise +``` + +Jsonwp Protocol Command + +Compare elements with each other. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `elementId` | `string` | +| `otherElementId` | `string` | + +#### Returns + +`Promise`\<`boolean`\> + +#### Ref + +https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidelementidequalsother + +#### Deprecated + +This command is deprecated and likely not supported by any browser. + +#### Inherited from + +`ProtocolCommands.elementEquals` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/jsonwp.d.ts:350 + +*** + +### ~~elementHover()~~ + +```ts +elementHover(elementId): Promise +``` + +Chromium Protocol Command + +Enable hover state for an element, which is reset upon next interaction. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `elementId` | `string` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://github.com/bayandin/chromedriver/blob/v2.45/element_commands.cc#L126-L146 + +#### Inherited from + +`ProtocolCommands.elementHover` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/chromium.d.ts:220 + +*** + +### ~~elementSendKeys()~~ + +```ts +elementSendKeys(elementId, text): Promise +``` + +Webdriver Protocol Command + +The Element Send Keys command scrolls into view the form control element and then sends the provided keys to the element. In case the element is not keyboard-interactable, an element not interactable error is returned.

The key input state used for input may be cleared mid-way through "typing" by sending the null key, which is U+E000 (NULL). + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `elementId` | `string` | +| `text` | `string` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://w3c.github.io/webdriver/#dfn-element-send-keys + +#### Inherited from + +`ProtocolCommands.elementSendKeys` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:354 + +*** + +### ~~elementSubmit()~~ + +```ts +elementSubmit(elementId): Promise +``` + +Jsonwp Protocol Command + +No description available, please see reference link. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `elementId` | `string` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidelementidsubmit + +#### Deprecated + +This command is deprecated and likely not supported by any browser. + +#### Inherited from + +`ProtocolCommands.elementSubmit` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/jsonwp.d.ts:359 + +*** + +### ~~emit()~~ + +```ts +emit(eventName, ...args): boolean +``` + +Synchronously calls each of the listeners registered for the event named`eventName`, in the order they were registered, passing the supplied arguments +to each. + +Returns `true` if the event had listeners, `false` otherwise. + +```js +const EventEmitter = require('events'); +const myEmitter = new EventEmitter(); + +// First listener +myEmitter.on('event', function firstListener() { + console.log('Helloooo! first listener'); +}); +// Second listener +myEmitter.on('event', function secondListener(arg1, arg2) { + console.log(`event with parameters ${arg1}, ${arg2} in second listener`); +}); +// Third listener +myEmitter.on('event', function thirdListener(...args) { + const parameters = args.join(', '); + console.log(`event with parameters ${parameters} in third listener`); +}); + +console.log(myEmitter.listeners('event')); + +myEmitter.emit('event', 1, 2, 3, 4, 5); + +// Prints: +// [ +// [Function: firstListener], +// [Function: secondListener], +// [Function: thirdListener] +// ] +// Helloooo! first listener +// event with parameters 1, 2 in second listener +// event with parameters 1, 2, 3, 4, 5 in third listener +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `eventName` | `string` \| `symbol` | +| ...`args` | `any`[] | + +#### Returns + +`boolean` + +#### Since + +v0.1.26 + +#### Inherited from + +`Omit.emit` + +#### Defined in + +testplane/node\_modules/@types/node/events.d.ts:731 + +*** + +### ~~endCoverage()~~ + +```ts +endCoverage(intent, path): Promise +``` + +Appium Protocol Command + +Get test coverage data. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `intent` | `string` | +| `path` | `string` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://appium.github.io/appium.io/docs/en/commands/device/app/end-test-coverage/ + +#### Inherited from + +`ProtocolCommands.endCoverage` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/appium.d.ts:357 + +*** + +### ~~eventNames()~~ + +```ts +eventNames(): (string | symbol)[] +``` + +Returns an array listing the events for which the emitter has registered +listeners. The values in the array are strings or `Symbol`s. + +```js +const EventEmitter = require('events'); +const myEE = new EventEmitter(); +myEE.on('foo', () => {}); +myEE.on('bar', () => {}); + +const sym = Symbol('symbol'); +myEE.on(sym, () => {}); + +console.log(myEE.eventNames()); +// Prints: [ 'foo', 'bar', Symbol(symbol) ] +``` + +#### Returns + +(`string` \| `symbol`)[] + +#### Since + +v6.0.0 + +#### Inherited from + +`Omit.eventNames` + +#### Defined in + +testplane/node\_modules/@types/node/events.d.ts:794 + +*** + +### ~~executeAsyncScript()~~ + +```ts +executeAsyncScript(script, args): Promise +``` + +Webdriver Protocol Command + +The Execute Async Script command causes JavaScript to execute as an anonymous function. Unlike the Execute Script command, the result of the function is ignored. Instead an additional argument is provided as the final argument to the function. This is a function that, when called, returns its first argument as the response. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `script` | `string` | +| `args` | ( \| `undefined` \| `null` \| `string` \| `number` \| `boolean` \| `object`)[] | + +#### Returns + +`Promise`\<`any`\> + +#### Ref + +https://w3c.github.io/webdriver/#dfn-execute-async-script + +#### Inherited from + +`ProtocolCommands.executeAsyncScript` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:378 + +*** + +### ~~executeDriverScript()~~ + +```ts +executeDriverScript( + script, + type?, +timeout?): Promise +``` + +Appium Protocol Command + +This command enables you to specify a WebdriverIO script as a string and transmit it to the Appium server for local execution on the server itself. This approach helps minimize potential latency associated with each command. ***To utilize this command with Appium 2.0, you must have the [`execute-driver-plugin`](https://github.com/appium/appium/tree/master/packages/execute-driver-plugin) plugin installed.*** + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `script` | `string` | +| `type`? | `string` | +| `timeout`? | `number` | + +#### Returns + +`Promise`\<`ProtocolCommandResponse`\> + +#### Ref + +https://github.com/appium/appium/blob/master/docs/en/commands/session/execute-driver.md + +#### Inherited from + +`ProtocolCommands.executeDriverScript` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/appium.d.ts:539 + +*** + +### ~~executeScript()~~ + +```ts +executeScript(script, args): Promise +``` + +Webdriver Protocol Command + +The Execute Script command executes a JavaScript function in the context of the current browsing context and returns the return value of the function. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `script` | `string` | +| `args` | ( \| `undefined` \| `null` \| `string` \| `number` \| `boolean` \| `object`)[] | + +#### Returns + +`Promise`\<`any`\> + +#### Ref + +https://w3c.github.io/webdriver/#dfn-execute-script + +#### Inherited from + +`ProtocolCommands.executeScript` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:370 + +*** + +### ~~file()~~ + +```ts +file(file): Promise +``` + +Chromium Protocol Command + +Upload a file to remote machine on which the browser is running. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `file` | `string` | + +#### Returns + +`Promise`\<`string`\> + +#### Ref + +https://github.com/bayandin/chromedriver/blob/v2.45/session_commands.cc#L1037-L1065 + +#### Inherited from + +`ProtocolCommands.file` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/chromium.d.ts:179 + +*** + +### ~~findElement()~~ + +```ts +findElement(using, value): Promise +``` + +Webdriver Protocol Command + +The Find Element command is used to find an element in the current browsing context that can be used for future commands. This command returns JSON representation of the element that can be passed to $ command to transform the reference to an extended WebdriverIO element. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `using` | `string` | +| `value` | `string` | + +#### Returns + +`Promise`\<`ElementReference`\> + +#### Ref + +https://w3c.github.io/webdriver/#dfn-find-element + +#### Inherited from + +`ProtocolCommands.findElement` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:202 + +*** + +### ~~findElementFromElement()~~ + +```ts +findElementFromElement( + elementId, + using, +value): Promise +``` + +Webdriver Protocol Command + +The Find Element From Element command is used to find an element from a web element in the current browsing context that can be used for future commands. This command returns JSON representation of the element that can be passed to $ command to transform the reference to an extended WebdriverIO element (See findElement). + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `elementId` | `string` | +| `using` | `string` | +| `value` | `string` | + +#### Returns + +`Promise`\<`ElementReference`\> + +#### Ref + +https://w3c.github.io/webdriver/#dfn-find-element-from-element + +#### Inherited from + +`ProtocolCommands.findElementFromElement` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:234 + +*** + +### ~~findElementFromShadowRoot()~~ + +```ts +findElementFromShadowRoot( + shadowId, + using, +value): Promise +``` + +Webdriver Protocol Command + +The Find Element From Shadow Root command is used to find an element within the shadow root of an element that can be used for future commands. This command returns JSON representation of the element that can be passed to $ command to transform the reference to an extended WebdriverIO element. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `shadowId` | `string` | +| `using` | `string` | +| `value` | `string` | + +#### Returns + +`Promise`\<`ElementReference`\> + +#### Ref + +https://w3c.github.io/webdriver/#find-element-from-shadow-root + +#### Inherited from + +`ProtocolCommands.findElementFromShadowRoot` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:210 + +*** + +### ~~findElements()~~ + +```ts +findElements(using, value): Promise +``` + +Webdriver Protocol Command + +The Find Elements command is used to find elements in the current browsing context that can be used for future commands. This command returns array of JSON representation of the elements that can be passed to $ command to transform the reference to an extended WebdriverIO element (See findElement). + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `using` | `string` | +| `value` | `string` | + +#### Returns + +`Promise`\<`ElementReference`[]\> + +#### Ref + +https://w3c.github.io/webdriver/#dfn-find-elements + +#### Inherited from + +`ProtocolCommands.findElements` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:218 + +*** + +### ~~findElementsFromElement()~~ + +```ts +findElementsFromElement( + elementId, + using, +value): Promise +``` + +Webdriver Protocol Command + +The Find Elements From Element command is used to find elements from a web element in the current browsing context that can be used for future commands. This command returns array of JSON representation of the elements that can be passed to $ command to transform the reference to an extended WebdriverIO element (See findElement). + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `elementId` | `string` | +| `using` | `string` | +| `value` | `string` | + +#### Returns + +`Promise`\<`ElementReference`[]\> + +#### Ref + +https://w3c.github.io/webdriver/#dfn-find-elements-from-element + +#### Inherited from + +`ProtocolCommands.findElementsFromElement` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:242 + +*** + +### ~~findElementsFromShadowRoot()~~ + +```ts +findElementsFromShadowRoot( + shadowId, + using, +value): Promise +``` + +Webdriver Protocol Command + +The Find Elements command is used to find elements within the shadow root of an element that can be used for future commands. This command returns array of JSON representation of the elements that can be passed to $ command to transform the reference to an extended WebdriverIO element (See findElement). + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `shadowId` | `string` | +| `using` | `string` | +| `value` | `string` | + +#### Returns + +`Promise`\<`ElementReference`[]\> + +#### Ref + +https://w3c.github.io/webdriver/#find-elements-from-shadow-root + +#### Inherited from + +`ProtocolCommands.findElementsFromShadowRoot` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:226 + +*** + +### ~~fingerPrint()~~ + +```ts +fingerPrint(fingerprintId): Promise +``` + +Appium Protocol Command + +Authenticate users by using their finger print scans on supported emulators. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `fingerprintId` | `number` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://appium.github.io/appium.io/docs/en/commands/device/authentication/finger-print/ + +#### Inherited from + +`ProtocolCommands.fingerPrint` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/appium.d.ts:461 + +*** + +### ~~forward()~~ + +```ts +forward(): Promise +``` + +Webdriver Protocol Command + +The Forward command causes the browser to traverse one step forwards in the joint session history of the current top-level browsing context. + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://w3c.github.io/webdriver/#dfn-forward + +#### Inherited from + +`ProtocolCommands.forward` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:74 + +*** + +### ~~freeze()~~ + +```ts +freeze(): Promise +``` + +Chromium Protocol Command + +Freeze the current page. Extension for [Page Lifecycle API](https://developers.google.com/web/updates/2018/07/page-lifecycle-api). + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://github.com/bayandin/chromedriver/blob/v2.45/window_commands.cc#L625-L633 + +#### Inherited from + +`ProtocolCommands.freeze` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/chromium.d.ts:236 + +*** + +### ~~fullPageScreenshot()~~ + +```ts +fullPageScreenshot(): Promise +``` + +Gecko Protocol Command + +Captures a screenshot of the entire page. + +#### Returns + +`Promise`\<`string`\> + +#### Ref + +https://phabricator.services.mozilla.com/source/mozilla-central/browse/default/testing/geckodriver/src/command.rs$43-46 + +#### Inherited from + +`ProtocolCommands.fullPageScreenshot` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/gecko.d.ts:9 + +*** + +### ~~fullscreenWindow()~~ + +```ts +fullscreenWindow(): Promise +``` + +Webdriver Protocol Command + +The Fullscreen Window command invokes the window manager-specific “full screen” operation, if any, on the window containing the current top-level browsing context. This typically increases the window to the size of the physical display and can hide browser chrome elements such as toolbars. + +#### Returns + +`Promise`\<`RectReturn`\> + +#### Ref + +https://w3c.github.io/webdriver/#dfn-fullscreen-window + +#### Inherited from + +`ProtocolCommands.fullscreenWindow` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:194 + +*** + +### ~~generateTestReport()~~ + +```ts +generateTestReport(message, group): Promise +``` + +Webdriver Protocol Command + +Generates a report for testing. Extension for [Reporting API](https://developers.google.com/web/updates/2018/09/reportingapi). __Note:__ this feature has not landed in all browsers yet. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | +| `group` | `string` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://w3c.github.io/reporting/#automation + +#### Inherited from + +`ProtocolCommands.generateTestReport` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:529 + +*** + +### ~~getActiveElement()~~ + +```ts +getActiveElement(): Promise +``` + +Webdriver Protocol Command + +Get Active Element returns the active element of the current browsing context’s document element. This command returns JSON representation of the element that can be passed to $ command to transform the reference to an extended WebdriverIO element (See findElement). + +#### Returns + +`Promise`\<`string`\> + +#### Ref + +https://w3c.github.io/webdriver/#dfn-get-active-element + +#### Inherited from + +`ProtocolCommands.getActiveElement` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:258 + +*** + +### ~~getActiveEngine()~~ + +```ts +getActiveEngine(): Promise +``` + +Jsonwp Protocol Command + +No description available, please see reference link. + +#### Returns + +`Promise`\<`string`\> + +#### Ref + +https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidimeactive_engine + +#### Deprecated + +This command is deprecated and likely not supported by any browser. + +#### Inherited from + +`ProtocolCommands.getActiveEngine` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/jsonwp.d.ts:498 + +*** + +### ~~getAlertText()~~ + +```ts +getAlertText(): Promise +``` + +Webdriver Protocol Command + +The Get Alert Text command returns the message of the current user prompt. If there is no current user prompt, it returns an error. + +#### Returns + +`Promise`\<`string`\> + +#### Ref + +https://w3c.github.io/webdriver/#dfn-get-alert-text + +#### Inherited from + +`ProtocolCommands.getAlertText` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:458 + +*** + +### ~~getAllCookies()~~ + +```ts +getAllCookies(): Promise +``` + +Webdriver Protocol Command + +The Get All Cookies command returns all cookies associated with the address of the current browsing context’s active document. + +#### Returns + +`Promise`\<`Cookie`[]\> + +#### Ref + +https://w3c.github.io/webdriver/#dfn-get-all-cookies + +#### Inherited from + +`ProtocolCommands.getAllCookies` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:386 + +*** + +### ~~getApplicationCacheStatus()~~ + +```ts +getApplicationCacheStatus(): Promise +``` + +Jsonwp Protocol Command + +Get the status of the html5 application cache. + +#### Returns + +`Promise`\<`number`\> + +#### Ref + +https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidapplication_cachestatus + +#### Deprecated + +This command is deprecated and likely not supported by any browser. + +#### Inherited from + +`ProtocolCommands.getApplicationCacheStatus` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/jsonwp.d.ts:777 + +*** + +### ~~getAvailableEngines()~~ + +```ts +getAvailableEngines(): Promise +``` + +Jsonwp Protocol Command + +No description available, please see reference link. + +#### Returns + +`Promise`\<`string`[]\> + +#### Ref + +https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidimeavailable_engines + +#### Deprecated + +This command is deprecated and likely not supported by any browser. + +#### Inherited from + +`ProtocolCommands.getAvailableEngines` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/jsonwp.d.ts:489 + +*** + +### ~~getCastIssueMessage()~~ + +```ts +getCastIssueMessage(): Promise +``` + +Chromium Protocol Command + +Returns error message if there is any issue in a Cast session. + +#### Returns + +`Promise`\<`string`\> + +#### Ref + +https://chromium.googlesource.com/chromium/src/+/refs/tags/73.0.3683.121/chrome/test/chromedriver/server/http_handler.cc#751 + +#### Inherited from + +`ProtocolCommands.getCastIssueMessage` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/chromium.d.ts:276 + +*** + +### ~~getCastSinks()~~ + +```ts +getCastSinks(): Promise +``` + +Chromium Protocol Command + +Returns the list of cast sinks (Cast devices) available to the Chrome media router. + +#### Returns + +`Promise`\<`string`[]\> + +#### Ref + +https://chromium.googlesource.com/chromium/src/+/refs/tags/73.0.3683.121/chrome/test/chromedriver/server/http_handler.cc#748 + +#### Inherited from + +`ProtocolCommands.getCastSinks` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/chromium.d.ts:252 + +*** + +### ~~getClipboard()~~ + +```ts +getClipboard(contentType?): Promise +``` + +Appium Protocol Command + +Get the content of the system clipboard + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `contentType`? | `string` | + +#### Returns + +`Promise`\<`string`\> + +#### Ref + +https://appium.github.io/appium.io/docs/en/commands/device/clipboard/get-clipboard/ + +#### Inherited from + +`ProtocolCommands.getClipboard` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/appium.d.ts:477 + +*** + +### ~~getContext()~~ + +```ts +getContext(): Promise +``` + +Appium Protocol Command + +No description available, please see reference link. + +#### Returns + +`Promise`\<`Context`\> + +#### Ref + +https://github.com/SeleniumHQ/mobile-spec/blob/master/spec-draft.md#webviews-and-other-contexts + +#### Inherited from + +`ProtocolCommands.getContext` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/appium.d.ts:10 + +*** + +### ~~getContexts()~~ + +```ts +getContexts(): Promise +``` + +Appium Protocol Command + +No description available, please see reference link. + +#### Returns + +`Promise`\<`Context`[]\> + +#### Ref + +https://github.com/SeleniumHQ/mobile-spec/blob/master/spec-draft.md#webviews-and-other-contexts + +#### Inherited from + +`ProtocolCommands.getContexts` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/appium.d.ts:26 + +*** + +### ~~getCredentials()~~ + +```ts +getCredentials(authenticatorId): Promise +``` + +Webdriver Protocol Command + +Returns one Credential Parameters object for every Public Key Credential Source stored in a Virtual Authenticator, regardless of whether they were stored using Add Credential or `navigator.credentials.create()`. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `authenticatorId` | `string` | + +#### Returns + +`Promise`\<`Credential`[]\> + +#### Ref + +https://www.w3.org/TR/webauthn-2/#sctn-automation-get-credentials + +#### Inherited from + +`ProtocolCommands.getCredentials` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:601 + +*** + +### ~~getCurrentActivity()~~ + +```ts +getCurrentActivity(): Promise +``` + +Appium Protocol Command + +Get the name of the current Android activity. + +#### Returns + +`Promise`\<`string`\> + +#### Ref + +https://appium.github.io/appium.io/docs/en/commands/device/activity/current-activity/ + +#### Inherited from + +`ProtocolCommands.getCurrentActivity` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/appium.d.ts:130 + +*** + +### ~~getCurrentPackage()~~ + +```ts +getCurrentPackage(): Promise +``` + +Appium Protocol Command + +Get the name of the current Android package. + +#### Returns + +`Promise`\<`string`\> + +#### Ref + +https://appium.github.io/appium.io/docs/en/commands/device/activity/current-package/ + +#### Inherited from + +`ProtocolCommands.getCurrentPackage` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/appium.d.ts:138 + +*** + +### ~~getDeviceTime()~~ + +```ts +getDeviceTime(): Promise +``` + +Appium Protocol Command + +Get the time on the device. + +#### Returns + +`Promise`\<`string`\> + +#### Ref + +https://appium.github.io/appium.io/docs/en/commands/device/system/system-time/ + +#### Inherited from + +`ProtocolCommands.getDeviceTime` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/appium.d.ts:298 + +*** + +### ~~getDisplayDensity()~~ + +```ts +getDisplayDensity(): Promise +``` + +Appium Protocol Command + +Get display density from device. + +#### Returns + +`Promise`\<`any`\> + +#### Ref + +https://github.com/appium/appium-base-driver/blob/master/docs/mjsonwp/protocol-methods.md#appium-extension-endpoints + +#### Inherited from + +`ProtocolCommands.getDisplayDensity` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/appium.d.ts:306 + +*** + +### ~~getDownloadableFiles()~~ + +```ts +getDownloadableFiles(): Promise +``` + +Selenium Protocol Command + +List files from remote machine available for download. + +#### Returns + +`Promise`\<`ProtocolCommandResponse`\> + +#### Ref + +https://www.seleniumhq.org/ + +#### Inherited from + +`ProtocolCommands.getDownloadableFiles` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/selenium.d.ts:18 + +*** + +### ~~getElementAttribute()~~ + +```ts +getElementAttribute(elementId, name): Promise +``` + +Webdriver Protocol Command + +The Get Element Attribute command will return the attribute of a web element. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `elementId` | `string` | +| `name` | `string` | + +#### Returns + +`Promise`\<`string`\> + +#### Ref + +https://w3c.github.io/webdriver/#dfn-get-element-attribute + +#### Inherited from + +`ProtocolCommands.getElementAttribute` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:282 + +*** + +### ~~getElementCSSValue()~~ + +```ts +getElementCSSValue(elementId, propertyName): Promise +``` + +Webdriver Protocol Command + +The Get Element CSS Value command retrieves the computed value of the given CSS property of the given web element. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `elementId` | `string` | +| `propertyName` | `string` | + +#### Returns + +`Promise`\<`string`\> + +#### Ref + +https://w3c.github.io/webdriver/#dfn-get-element-css-value + +#### Inherited from + +`ProtocolCommands.getElementCSSValue` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:298 + +*** + +### ~~getElementComputedLabel()~~ + +```ts +getElementComputedLabel(elementId): Promise +``` + +Webdriver Protocol Command + +Get the accessible name of the element. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `elementId` | `string` | + +#### Returns + +`Promise`\<`string`\> + +#### Ref + +https://w3c.github.io/webdriver/#get-computed-label + +#### Inherited from + +`ProtocolCommands.getElementComputedLabel` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:498 + +*** + +### ~~getElementComputedRole()~~ + +```ts +getElementComputedRole(elementId): Promise +``` + +Webdriver Protocol Command + +Get the computed WAI-ARIA role of an element. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `elementId` | `string` | + +#### Returns + +`Promise`\<`string`\> + +#### Ref + +https://w3c.github.io/webdriver/#get-computed-role + +#### Inherited from + +`ProtocolCommands.getElementComputedRole` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:490 + +*** + +### ~~getElementLocation()~~ + +```ts +getElementLocation(elementId): Promise +``` + +Jsonwp Protocol Command + +Determine an element's location on the page. The point `(0, 0)` refers to the upper-left corner of the page. The element's coordinates are returned as a JSON object with `x` and `y` properties. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `elementId` | `string` | + +#### Returns + +`Promise`\<`ProtocolCommandResponse`\> + +#### Ref + +https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidelementidlocation + +#### Deprecated + +This command is deprecated and likely not supported by any browser. + +#### Inherited from + +`ProtocolCommands.getElementLocation` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/jsonwp.d.ts:307 + +*** + +### ~~getElementLocationInView()~~ + +```ts +getElementLocationInView(elementId): Promise +``` + +Jsonwp Protocol Command + +Determine an element's location on the screen once it has been scrolled into view.

__Note:__ This is considered an internal command and should only be used to determine an element's location for correctly generating native events. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `elementId` | `string` | + +#### Returns + +`Promise`\<`ProtocolCommandResponse`\> + +#### Ref + +https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidelementidlocation_in_view + +#### Deprecated + +This command is deprecated and likely not supported by any browser. + +#### Inherited from + +`ProtocolCommands.getElementLocationInView` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/jsonwp.d.ts:316 + +*** + +### ~~getElementProperty()~~ + +```ts +getElementProperty(elementId, name): Promise +``` + +Webdriver Protocol Command + +The Get Element Property command will return the result of getting a property of an element. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `elementId` | `string` | +| `name` | `string` | + +#### Returns + +`Promise`\<`string`\> + +#### Ref + +https://w3c.github.io/webdriver/#dfn-get-element-property + +#### Inherited from + +`ProtocolCommands.getElementProperty` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:290 + +*** + +### ~~getElementRect()~~ + +```ts +getElementRect(elementId): Promise +``` + +Webdriver Protocol Command + +The Get Element Rect command returns the dimensions and coordinates of the given web element. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `elementId` | `string` | + +#### Returns + +`Promise`\<`RectReturn`\> + +#### Ref + +https://w3c.github.io/webdriver/#dfn-get-element-rect + +#### Inherited from + +`ProtocolCommands.getElementRect` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:322 + +*** + +### ~~getElementShadowRoot()~~ + +```ts +getElementShadowRoot(elementId): Promise +``` + +Webdriver Protocol Command + +Get the shadow root object of an element. The result object can be used to fetch elements within this shadow root using e.g. findElementFromShadowRoots or findElementsFromShadowRoots. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `elementId` | `string` | + +#### Returns + +`Promise`\<`ShadowElementReference`\> + +#### Ref + +https://w3c.github.io/webdriver/#dfn-get-active-element + +#### Inherited from + +`ProtocolCommands.getElementShadowRoot` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:250 + +*** + +### ~~getElementSize()~~ + +```ts +getElementSize(elementId): Promise +``` + +Jsonwp Protocol Command + +Determine an element's size in pixels. The size will be returned as a JSON object with `width` and `height` properties. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `elementId` | `string` | + +#### Returns + +`Promise`\<`ProtocolCommandResponse`\> + +#### Ref + +https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidelementidsize + +#### Deprecated + +This command is deprecated and likely not supported by any browser. Use the "getElementRect" command instead of "getElementSize"! + +#### Inherited from + +`ProtocolCommands.getElementSize` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/jsonwp.d.ts:325 + +*** + +### ~~getElementTagName()~~ + +```ts +getElementTagName(elementId): Promise +``` + +Webdriver Protocol Command + +The Get Element Tag Name command returns the qualified element name of the given web element. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `elementId` | `string` | + +#### Returns + +`Promise`\<`string`\> + +#### Ref + +https://w3c.github.io/webdriver/#dfn-get-element-tag-name + +#### Inherited from + +`ProtocolCommands.getElementTagName` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:314 + +*** + +### ~~getElementText()~~ + +```ts +getElementText(elementId): Promise +``` + +Webdriver Protocol Command + +The Get Element Text command intends to return an element’s text "as rendered". An element's rendered text is also used for locating a elements by their link text and partial link text. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `elementId` | `string` | + +#### Returns + +`Promise`\<`string`\> + +#### Ref + +https://w3c.github.io/webdriver/#dfn-get-element-text + +#### Inherited from + +`ProtocolCommands.getElementText` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:306 + +*** + +### ~~getElementValue()~~ + +```ts +getElementValue(elementId): Promise +``` + +Chromium Protocol Command + +Retrieves the value of a given form control element. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `elementId` | `string` | + +#### Returns + +`Promise`\<`null` \| `string`\> + +#### Ref + +https://github.com/bayandin/chromedriver/blob/v2.45/element_commands.cc#L431-L443 + +#### Inherited from + +`ProtocolCommands.getElementValue` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/chromium.d.ts:212 + +*** + +### ~~getEvents()~~ + +```ts +getEvents(type): Promise +``` + +Appium Protocol Command + +Get events stored in appium server. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `type` | `string`[] | + +#### Returns + +`Promise`\<`ProtocolCommandResponse`\> + +#### Ref + +https://github.com/appium/appium/blob/master/docs/en/commands/session/events/get-events.md + +#### Inherited from + +`ProtocolCommands.getEvents` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/appium.d.ts:547 + +*** + +### ~~getGeoLocation()~~ + +```ts +getGeoLocation(): Promise +``` + +Jsonwp Protocol Command + +Get the current geo location. + +#### Returns + +`Promise`\<`ProtocolCommandResponse`\> + +#### Ref + +https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#get-sessionsessionidlocation + +#### Deprecated + +This command is deprecated and likely not supported by any browser. + +#### Inherited from + +`ProtocolCommands.getGeoLocation` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/jsonwp.d.ts:633 + +*** + +### ~~getHubConfig()~~ + +```ts +getHubConfig(): Promise +``` + +Selenium Protocol Command + +Receive hub config remotely. + +#### Returns + +`Promise`\<`ProtocolCommandResponse`\> + +#### Ref + +https://github.com/nicegraham/selenium-grid2-api#gridapihub + +#### Inherited from + +`ProtocolCommands.getHubConfig` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/selenium.d.ts:42 + +*** + +### ~~getLocalStorage()~~ + +```ts +getLocalStorage(): Promise +``` + +Jsonwp Protocol Command + +Get all keys of the storage. + +#### Returns + +`Promise`\<`string`[]\> + +#### Ref + +https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#get-sessionsessionidlocal_storage + +#### Deprecated + +This command is deprecated and likely not supported by any browser. Use the "execute" command instead to interact with the session storage interface! + +#### Inherited from + +`ProtocolCommands.getLocalStorage` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/jsonwp.d.ts:651 + +*** + +### ~~getLocalStorageItem()~~ + +```ts +getLocalStorageItem(key): Promise +``` + +Jsonwp Protocol Command + +Get the storage item for the given key. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `key` | `string` | + +#### Returns + +`Promise`\<`string`\> + +#### Ref + +https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#get-sessionsessionidlocal_storagekeykey + +#### Deprecated + +This command is deprecated and likely not supported by any browser. Use the "execute" command instead to interact with the session storage interface! + +#### Inherited from + +`ProtocolCommands.getLocalStorageItem` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/jsonwp.d.ts:678 + +*** + +### ~~getLocalStorageSize()~~ + +```ts +getLocalStorageSize(): Promise +``` + +Jsonwp Protocol Command + +Get the number of items in the storage. + +#### Returns + +`Promise`\<`number`\> + +#### Ref + +https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidlocal_storagesize + +#### Deprecated + +This command is deprecated and likely not supported by any browser. Use the "execute" command instead to interact with the session storage interface! + +#### Inherited from + +`ProtocolCommands.getLocalStorageSize` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/jsonwp.d.ts:696 + +*** + +### ~~getLogTypes()~~ + +```ts +getLogTypes(): Promise +``` + +Jsonwp Protocol Command + +Get available log types. + +#### Returns + +`Promise`\<`string`[]\> + +#### Ref + +https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidlogtypes + +#### Deprecated + +This command is deprecated and likely not supported by any browser. Use the "devtools" instead to get logs! + +#### Inherited from + +`ProtocolCommands.getLogTypes` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/jsonwp.d.ts:768 + +*** + +### ~~getLogs()~~ + +```ts +getLogs(type): Promise +``` + +Jsonwp Protocol Command + +Get the log for a given log type. Log buffer is reset after each request. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `type` | `string` | + +#### Returns + +`Promise`\<`object`[]\> + +#### Ref + +https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidlog + +#### Deprecated + +This command is deprecated and likely not supported by any browser. Use the "devtools" instead to get logs! + +#### Inherited from + +`ProtocolCommands.getLogs` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/jsonwp.d.ts:759 + +*** + +### ~~getMaxListeners()~~ + +```ts +getMaxListeners(): number +``` + +Returns the current max listener value for the `EventEmitter` which is either +set by `emitter.setMaxListeners(n)` or defaults to defaultMaxListeners. + +#### Returns + +`number` + +#### Since + +v1.0.0 + +#### Inherited from + +`Omit.getMaxListeners` + +#### Defined in + +testplane/node\_modules/@types/node/events.d.ts:647 + +*** + +### ~~getMockCalls()~~ + +```ts +getMockCalls(mockId): Promise +``` + +Saucelabs Protocol Command + +Receive request information about requests that match the mocked resource. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `mockId` | `string` | + +#### Returns + +`Promise`\<`ProtocolCommandResponse`\> + +#### Ref + +https://wiki.saucelabs.com/display/DOCS/Custom+Sauce+Labs+WebDriver+Extensions+for+Network+and+Log+Commands + +#### Inherited from + +`ProtocolCommands.getMockCalls` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/saucelabs.d.ts:177 + +*** + +### ~~getMockSensor()~~ + +```ts +getMockSensor(type): Promise +``` + +Webdriver Protocol Command + +Retrieves information about a given type of mock sensor. __Note:__ this feature has not landed in all browsers yet. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `type` | `string` | + +#### Returns + +`Promise`\<`ProtocolCommandResponse`\> + +#### Ref + +https://w3c.github.io/sensors/#get-mock-sensor-command + +#### Inherited from + +`ProtocolCommands.getMockSensor` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:545 + +*** + +### ~~getMozContext()~~ + +```ts +getMozContext(): Promise +``` + +Gecko Protocol Command + +Get the context that is currently in effect, e.g. `CHROME` or `CONTENT`. + +#### Returns + +`Promise`\<`string`\> + +#### Ref + +https://github.com/SeleniumHQ/selenium/blob/586affe0cf675b1d5c8abc756defa4a46d95391b/javascript/node/selenium-webdriver/firefox.js#L615-L622 + +#### Example + +```js +console.log(await browser.getMozContext()); // outputs: 'CHROME' +``` + +#### Inherited from + +`ProtocolCommands.getMozContext` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/gecko.d.ts:21 + +*** + +### ~~getNamedCookie()~~ + +```ts +getNamedCookie(name): Promise +``` + +Webdriver Protocol Command + +The Get Named Cookie command returns the cookie with the requested name from the associated cookies in the cookie store of the current browsing context's active document. If no cookie is found, a no such cookie error is returned. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `name` | `string` | + +#### Returns + +`Promise`\<`Cookie`\> + +#### Ref + +https://w3c.github.io/webdriver/#dfn-get-named-cookie + +#### Inherited from + +`ProtocolCommands.getNamedCookie` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:410 + +*** + +### ~~getNetworkConditions()~~ + +```ts +getNetworkConditions(): Promise +``` + +Chromium Protocol Command + +Get current network conditions used for emulation. + +#### Returns + +`Promise`\<`ProtocolCommandResponse`\> + +#### Ref + +https://github.com/bayandin/chromedriver/blob/v2.45/session_commands.cc#L839-L859 + +#### Inherited from + +`ProtocolCommands.getNetworkConditions` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/chromium.d.ts:119 + +*** + +### ~~getNetworkConnection()~~ + +```ts +getNetworkConnection(): Promise +``` + +Chromium Protocol Command + +Get the connection type for network emulation. This command is only applicable when remote end replies with `networkConnectionEnabled` capability set to `true`. + +#### Returns + +`Promise`\<`number`\> + +#### Ref + +https://github.com/SeleniumHQ/mobile-spec/blob/master/spec-draft.md#device-modes + +#### Example + +```js +const browser = remote({ + capabilities: { + browserName: 'chrome', + 'goog:chromeOptions': { + // Network emulation requires device mode, which is only enabled when mobile emulation is on + mobileEmulation: { deviceName: 'iPad' }, + }, + } +}); +console.log(browser.getNetworkConnection()); // outputs: 6 (Both Wi-Fi and data) +``` + +#### Inherited from + +`ProtocolCommands.getNetworkConnection` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/chromium.d.ts:90 + +*** + +### ~~getOrientation()~~ + +```ts +getOrientation(): Promise +``` + +Jsonwp Protocol Command + +No description available, please see reference link. + +#### Returns + +`Promise`\<`string`\> + +#### Ref + +https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#get-sessionsessionidorientation + +#### Deprecated + +This command is deprecated and likely not supported by any browser. + +#### Inherited from + +`ProtocolCommands.getOrientation` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/jsonwp.d.ts:534 + +*** + +### ~~getPageIndex()~~ + +```ts +getPageIndex(): Promise +``` + +Mjsonwp Protocol Command + +No description available, please see reference link. + +#### Returns + +`Promise`\<`string`\> + +#### Ref + +https://github.com/appium/appium-base-driver/blob/master/docs/mjsonwp/protocol-methods.md#mobile-json-wire-protocol-endpoints + +#### Deprecated + +In Appium 2.0, this method is marked as deprecated and currently has no available alternatives. + +#### Inherited from + +`ProtocolCommands.getPageIndex` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/mjsonwp.d.ts:10 + +*** + +### ~~getPageLogs()~~ + +```ts +getPageLogs(type): Promise +``` + +Saucelabs Protocol Command + +Get webpage specific log information based on the last page load. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `type` | `string` | + +#### Returns + +`Promise`\<`ProtocolCommandResponse`\> + +#### Ref + +https://wiki.saucelabs.com/display/DOCS/Custom+Sauce+Labs+WebDriver+Extensions+for+Network+and+Log+Commands#CustomSauceLabsWebDriverExtensionsforNetworkandLogCommands-ExtendedDebuggingTools + +#### Examples + +```js +// Get Network Logs +console.log(browser.getPageLogs('sauce:network')); +// +// outputs: +// [{ +// "url": "https://app.saucelabs.com/dashboard", +// "statusCode": 200, +// "method": "GET", +// "requestHeaders": { +// ... +// }, +// "responseHeaders": { +// ... +// }, +// "timing": { +// ... +// } +// }, {, +// ... +// }] +// +```* + +```js +// Get Performance Logs (needs capturePerformance capability see: https://wiki.saucelabs.com/display/DOCS/Measure+Page+Load+Performance+Using+Test+Automation#MeasurePageLoadPerformanceUsingTestAutomation-EnableYourScript) +console.log(browser.getPageLogs('sauce:performance')); +// +// outputs: +// { +// "speedIndex": 1472.023, +// "timeToFirstInteractive": 1243.214, +// "firstMeaningfulPaint": 892.643, +// ... +// } +// +``` + +#### Inherited from + +`ProtocolCommands.getPageLogs` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/saucelabs.d.ts:48 + +*** + +### ~~getPageSource()~~ + +```ts +getPageSource(): Promise +``` + +Webdriver Protocol Command + +The Get Page Source command returns a string serialization of the DOM of the current browsing context active document. + +#### Returns + +`Promise`\<`string`\> + +#### Ref + +https://w3c.github.io/webdriver/#dfn-get-page-source + +#### Inherited from + +`ProtocolCommands.getPageSource` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:362 + +*** + +### ~~getPerformanceData()~~ + +```ts +getPerformanceData( + packageName, + dataType, +dataReadTimeout?): Promise +``` + +Appium Protocol Command + +Returns the information of the system state which is supported to read as like cpu, memory, network traffic, and battery. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `packageName` | `string` | +| `dataType` | `string` | +| `dataReadTimeout`? | `number` | + +#### Returns + +`Promise`\<`string`[]\> + +#### Ref + +https://appium.github.io/appium.io/docs/en/commands/device/performance-data/get-performance-data/ + +#### Inherited from + +`ProtocolCommands.getPerformanceData` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/appium.d.ts:90 + +*** + +### ~~getPerformanceDataTypes()~~ + +```ts +getPerformanceDataTypes(): Promise +``` + +Appium Protocol Command + +Returns the information types of the system state which is supported to read as like cpu, memory, network traffic, and battery. + +#### Returns + +`Promise`\<`string`[]\> + +#### Ref + +https://appium.github.io/appium.io/docs/en/commands/device/performance-data/performance-data-types/ + +#### Inherited from + +`ProtocolCommands.getPerformanceDataTypes` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/appium.d.ts:82 + +*** + +### ~~getSession()~~ + +```ts +getSession(): Promise +``` + +Jsonwp Protocol Command + +Retrieve the capabilities of the specified session. + +#### Returns + +`Promise`\<`ProtocolCommandResponse`\> + +#### Ref + +https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#get-sessionsessionid + +#### Deprecated + +This command is deprecated and likely not supported by any browser. + +#### Inherited from + +`ProtocolCommands.getSession` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/jsonwp.d.ts:36 + +*** + +### ~~getSessionStorage()~~ + +```ts +getSessionStorage(): Promise +``` + +Jsonwp Protocol Command + +Get all keys of the storage. + +#### Returns + +`Promise`\<`string`[]\> + +#### Ref + +https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#get-sessionsessionidsession_storage + +#### Deprecated + +This command is deprecated and likely not supported by any browser. Use the "execute" command instead to interact with the session storage interface! + +#### Inherited from + +`ProtocolCommands.getSessionStorage` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/jsonwp.d.ts:705 + +*** + +### ~~getSessionStorageItem()~~ + +```ts +getSessionStorageItem(key): Promise +``` + +Jsonwp Protocol Command + +Get the storage item for the given key. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `key` | `string` | + +#### Returns + +`Promise`\<`string`\> + +#### Ref + +https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#get-sessionsessionidsession_storagekeykey + +#### Deprecated + +This command is deprecated and likely not supported by any browser. Use the "execute" command instead to interact with the session storage interface! + +#### Inherited from + +`ProtocolCommands.getSessionStorageItem` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/jsonwp.d.ts:732 + +*** + +### ~~getSessionStorageSize()~~ + +```ts +getSessionStorageSize(): Promise +``` + +Jsonwp Protocol Command + +Get the number of items in the storage. + +#### Returns + +`Promise`\<`number`\> + +#### Ref + +https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidsession_storagesize + +#### Deprecated + +This command is deprecated and likely not supported by any browser. Use the "execute" command instead to interact with the session storage interface! + +#### Inherited from + +`ProtocolCommands.getSessionStorageSize` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/jsonwp.d.ts:750 + +*** + +### ~~getSessions()~~ + +```ts +getSessions(): Promise +``` + +Jsonwp Protocol Command + +Returns a list of the currently active sessions. Each session will be returned as a list of JSON objects containing `id` and `capabilities`. + +#### Returns + +`Promise`\<`object`[]\> + +#### Ref + +https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessions + +#### Deprecated + +This command is deprecated and likely not supported by any browser. + +#### Inherited from + +`ProtocolCommands.getSessions` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/jsonwp.d.ts:27 + +*** + +### ~~getSettings()~~ + +```ts +getSettings(): Promise +``` + +Appium Protocol Command + +Retrieve the current settings on the device. + +#### Returns + +`Promise`\<`SettingsReturn`\> + +#### Ref + +https://appium.github.io/appium.io/docs/en/commands/session/settings/get-settings/ + +#### Inherited from + +`ProtocolCommands.getSettings` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/appium.d.ts:389 + +*** + +### ~~getStrings()~~ + +```ts +getStrings(language?, stringFile?): Promise +``` + +Appium Protocol Command + +Get app strings. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `language`? | `string` | +| `stringFile`? | `string` | + +#### Returns + +`Promise`\<`StringsReturn`\> + +#### Ref + +https://appium.github.io/appium.io/docs/en/commands/device/app/get-app-strings/ + +#### Inherited from + +`ProtocolCommands.getStrings` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/appium.d.ts:365 + +*** + +### ~~getSystemBars()~~ + +```ts +getSystemBars(): Promise +``` + +Appium Protocol Command + +Retrieve visibility and bounds information of the status and navigation bars. + +#### Returns + +`Promise`\<`object`[]\> + +#### Ref + +https://appium.github.io/appium.io/docs/en/commands/device/system/system-bars/ + +#### Inherited from + +`ProtocolCommands.getSystemBars` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/appium.d.ts:290 + +*** + +### ~~getTimeouts()~~ + +```ts +getTimeouts(): Promise +``` + +Webdriver Protocol Command + +The Get Timeouts command gets timeout durations associated with the current session. + +#### Returns + +`Promise`\<`Timeouts`\> + +#### Ref + +https://w3c.github.io/webdriver/#dfn-get-timeouts + +#### Inherited from + +`ProtocolCommands.getTimeouts` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:34 + +*** + +### ~~getTitle()~~ + +```ts +getTitle(): Promise +``` + +Webdriver Protocol Command + +The Get Title command returns the document title of the current top-level browsing context, equivalent to calling `document.title`. + +#### Returns + +`Promise`\<`string`\> + +#### Ref + +https://w3c.github.io/webdriver/#dfn-get-title + +#### Inherited from + +`ProtocolCommands.getTitle` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:90 + +*** + +### ~~getUrl()~~ + +```ts +getUrl(): Promise +``` + +Webdriver Protocol Command + +The Get Current URL command returns the URL of the current top-level browsing context. + +#### Returns + +`Promise`\<`string`\> + +#### Ref + +https://w3c.github.io/webdriver/#dfn-get-current-url + +#### Inherited from + +`ProtocolCommands.getUrl` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:50 + +*** + +### ~~getWindowHandle()~~ + +```ts +getWindowHandle(): Promise +``` + +Webdriver Protocol Command + +The Get Window Handle command returns the window handle for the current top-level browsing context. It can be used as an argument to Switch To Window. + +#### Returns + +`Promise`\<`string`\> + +#### Ref + +https://w3c.github.io/webdriver/#dfn-get-window-handle + +#### Inherited from + +`ProtocolCommands.getWindowHandle` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:98 + +*** + +### ~~getWindowHandles()~~ + +```ts +getWindowHandles(): Promise +``` + +Webdriver Protocol Command + +The Get Window Handles command returns a list of window handles for every open top-level browsing context. The order in which the window handles are returned is arbitrary. + +#### Returns + +`Promise`\<`string`[]\> + +#### Ref + +https://w3c.github.io/webdriver/#dfn-get-window-handles + +#### Inherited from + +`ProtocolCommands.getWindowHandles` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:130 + +*** + +### ~~getWindowPosition()~~ + +```ts +getWindowPosition(): Promise +``` + +Jsonwp Protocol Command + +Get the position of the current focussed window. + +#### Returns + +`Promise`\<`ProtocolCommandResponse`\> + +#### Ref + +https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#get-sessionsessionidwindowwindowhandleposition + +#### Deprecated + +This command is deprecated and likely not supported by any browser. + +#### Inherited from + +`ProtocolCommands.getWindowPosition` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/jsonwp.d.ts:175 + +*** + +### ~~getWindowRect()~~ + +```ts +getWindowRect(): Promise +``` + +Webdriver Protocol Command + +The Get Window Rect command returns the size and position on the screen of the operating system window corresponding to the current top-level browsing context. + +#### Returns + +`Promise`\<`RectReturn`\> + +#### Ref + +https://w3c.github.io/webdriver/#dfn-get-window-rect + +#### Inherited from + +`ProtocolCommands.getWindowRect` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:162 + +*** + +### ~~gridProxyDetails()~~ + +```ts +gridProxyDetails(id): Promise +``` + +Selenium Protocol Command + +Get proxy details. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `id` | `string` | + +#### Returns + +`Promise`\<`ProtocolCommandResponse`\> + +#### Ref + +https://github.com/nicegraham/selenium-grid2-api#gridapiproxy + +#### Inherited from + +`ProtocolCommands.gridProxyDetails` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/selenium.d.ts:58 + +*** + +### ~~gridTestSession()~~ + +```ts +gridTestSession(session): Promise +``` + +Selenium Protocol Command + +Get the details of the Selenium Grid node running a session. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `session` | `string` | + +#### Returns + +`Promise`\<`ProtocolCommandResponse`\> + +#### Ref + +https://github.com/nicegraham/selenium-grid2-api#gridapitestsession + +#### Inherited from + +`ProtocolCommands.gridTestSession` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/selenium.d.ts:50 + +*** + +### ~~gsmCall()~~ + +```ts +gsmCall(phoneNumber, action): Promise +``` + +Appium Protocol Command + +Make GSM call (Emulator only). + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `phoneNumber` | `string` | +| `action` | `string` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://appium.github.io/appium.io/docs/en/commands/device/network/gsm-call/ + +#### Inherited from + +`ProtocolCommands.gsmCall` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/appium.d.ts:413 + +*** + +### ~~gsmSignal()~~ + +```ts +gsmSignal(signalStrength, signalStrengh?): Promise +``` + +Appium Protocol Command + +Set GSM signal strength (Emulator only). + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `signalStrength` | `string` | +| `signalStrengh`? | `string` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://appium.github.io/appium.io/docs/en/commands/device/network/gsm-signal/ + +#### Inherited from + +`ProtocolCommands.gsmSignal` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/appium.d.ts:421 + +*** + +### ~~gsmVoice()~~ + +```ts +gsmVoice(state): Promise +``` + +Appium Protocol Command + +Set GSM voice state (Emulator only). + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `state` | `string` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://appium.github.io/appium.io/docs/en/commands/device/network/gsm-voice/ + +#### Inherited from + +`ProtocolCommands.gsmVoice` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/appium.d.ts:445 + +*** + +### ~~hideKeyboard()~~ + +```ts +hideKeyboard( + strategy?, + key?, + keyCode?, +keyName?): Promise +``` + +Appium Protocol Command + +Hide soft keyboard. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `strategy`? | `string` | +| `key`? | `string` | +| `keyCode`? | `string` | +| `keyName`? | `string` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://appium.github.io/appium.io/docs/en/commands/device/keys/hide-keyboard/ + +#### Inherited from + +`ProtocolCommands.hideKeyboard` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/appium.d.ts:194 + +*** + +### ~~inputPerformActions()~~ + +```ts +inputPerformActions(params): Promise +``` + +WebDriver Bidi command to send command method "input.performActions" with parameters. + +#### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `params` | `InputPerformActionsParameters` | WebDriver Bidi command to send command method "input.performActions" with parameters. | + +#### Returns + +`Promise`\<`EmptyResult`\> + +`Promise` + +#### Url + +https://w3c.github.io/webdriver-bidi/#command-input-performActions + +#### Inherited from + +`BidiHandler.inputPerformActions` + +#### Defined in + +testplane/node\_modules/webdriver/build/bidi/handler.d.ts:242 + +*** + +### ~~inputReleaseActions()~~ + +```ts +inputReleaseActions(params): Promise +``` + +WebDriver Bidi command to send command method "input.releaseActions" with parameters. + +#### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `params` | `InputReleaseActionsParameters` | WebDriver Bidi command to send command method "input.releaseActions" with parameters. | + +#### Returns + +`Promise`\<`EmptyResult`\> + +`Promise` + +#### Url + +https://w3c.github.io/webdriver-bidi/#command-input-releaseActions + +#### Inherited from + +`BidiHandler.inputReleaseActions` + +#### Defined in + +testplane/node\_modules/webdriver/build/bidi/handler.d.ts:249 + +*** + +### ~~installAddOn()~~ + +```ts +installAddOn(addon, temporary): Promise +``` + +Gecko Protocol Command + +Installs a new addon with the current session. This function will return an ID that may later be used to uninstall the addon using `uninstallAddon`. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `addon` | `string` | +| `temporary` | `boolean` | + +#### Returns + +`Promise`\<`string`\> + +#### Ref + +https://github.com/SeleniumHQ/selenium/blob/586affe0cf675b1d5c8abc756defa4a46d95391b/javascript/node/selenium-webdriver/firefox.js#L647-L668 + +#### Example + +```js +// Create a buffer of the add on .zip file +const extension = await fs.promises.readFile('/path/to/extension.zip') +// Load extension in Firefox +const id = await browser.installAddOn(extension.toString('base64'), false); +``` + +#### Inherited from + +`ProtocolCommands.installAddOn` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/gecko.d.ts:50 + +*** + +### ~~installApp()~~ + +```ts +installApp(appPath): Promise +``` + +Appium Protocol Command + +Install the given app onto the device. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `appPath` | `string` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://appium.github.io/appium.io/docs/en/commands/device/app/install-app/ + +#### Inherited from + +`ProtocolCommands.installApp` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/appium.d.ts:146 + +*** + +### ~~interceptRequest()~~ + +```ts +interceptRequest(rule): Promise +``` + +Saucelabs Protocol Command + +Allows modifying any request made by the browser. You can blacklist, modify, or redirect these as required for your tests. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `rule` | `object` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://wiki.saucelabs.com/display/DOCS/Custom+Sauce+Labs+WebDriver+Extensions+for+Network+and+Log+Commands#CustomSauceLabsWebDriverExtensionsforNetworkandLogCommands-InterceptNetworkRequests + +#### Examples + +```js +// redirect a request +browser.interceptRequest({ + url: 'https://saucelabs.com', + redirect: 'https://google.com' +}) +```* + +```js +// Blacklist requests to 3rd party vendors +browser.interceptRequest({ + url: 'https://api.segment.io/v1/p', + error: 'Failed' +}) +```* + +```js +// Modify requests to REST API (Mock REST API response) +browser.interceptRequest({ + url: 'http://sampleapp.appspot.com/api/todos', + response: { + headers: { + 'x-custom-headers': 'foobar' + }, + body: [{ + title: 'My custom todo', + order: 1, + completed: false, + url: 'http://todo-backend-express.herokuapp.com/15727' + }] + } +}) +``` + +#### Inherited from + +`ProtocolCommands.interceptRequest` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/saucelabs.d.ts:130 + +*** + +### ~~isAlertOpen()~~ + +```ts +isAlertOpen(): Promise +``` + +Chromium Protocol Command + +Whether a simple dialog is currently open. + +#### Returns + +`Promise`\<`boolean`\> + +#### Ref + +https://github.com/bayandin/chromedriver/blob/v2.45/alert_commands.cc#L42-L49 + +#### Example + +```js +console.log(browser.isAlertOpen()); // outputs: false +browser.execute('window.alert()'); +console.log(browser.isAlertOpen()); // outputs: true +``` + +#### Inherited from + +`ProtocolCommands.isAlertOpen` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/chromium.d.ts:16 + +*** + +### ~~isAppInstalled()~~ + +```ts +isAppInstalled(appId): Promise +``` + +Appium Protocol Command + +Check whether the specified app is installed on the device. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `appId` | `string` | + +#### Returns + +`Promise`\<`boolean`\> + +#### Ref + +https://appium.github.io/appium.io/docs/en/commands/device/app/is-app-installed/ + +#### Inherited from + +`ProtocolCommands.isAppInstalled` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/appium.d.ts:178 + +*** + +### ~~isAutoReporting()~~ + +```ts +isAutoReporting(): Promise +``` + +Chromium Protocol Command + +Whether it should automatically raises errors on browser logs. + +#### Returns + +`Promise`\<`boolean`\> + +#### Ref + +https://codereview.chromium.org/101203012 + +#### Inherited from + +`ProtocolCommands.isAutoReporting` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/chromium.d.ts:24 + +*** + +### ~~isElementDisplayed()~~ + +```ts +isElementDisplayed(elementId): Promise +``` + +Webdriver Protocol Command + +Is Element Displayed determines the visibility of an element which is guided by what is perceptually visible to the human eye. In this context, an element's displayedness does not relate to the `visibility` or `display` style properties. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `elementId` | `string` | + +#### Returns + +`Promise`\<`boolean`\> + +#### Ref + +https://w3c.github.io/webdriver/#element-displayedness + +#### Inherited from + +`ProtocolCommands.isElementDisplayed` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:274 + +*** + +### ~~isElementEnabled()~~ + +```ts +isElementEnabled(elementId): Promise +``` + +Webdriver Protocol Command + +Is Element Enabled determines if the referenced element is enabled or not. This operation only makes sense on form controls. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `elementId` | `string` | + +#### Returns + +`Promise`\<`boolean`\> + +#### Ref + +https://w3c.github.io/webdriver/#dfn-is-element-enabled + +#### Inherited from + +`ProtocolCommands.isElementEnabled` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:330 + +*** + +### ~~isElementSelected()~~ + +```ts +isElementSelected(elementId): Promise +``` + +Webdriver Protocol Command + +Is Element Selected determines if the referenced element is selected or not. This operation only makes sense on input elements of the Checkbox- and Radio Button states, or option elements. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `elementId` | `string` | + +#### Returns + +`Promise`\<`boolean`\> + +#### Ref + +https://w3c.github.io/webdriver/#dfn-is-element-selected + +#### Inherited from + +`ProtocolCommands.isElementSelected` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:266 + +*** + +### ~~isIMEActivated()~~ + +```ts +isIMEActivated(): Promise +``` + +Jsonwp Protocol Command + +No description available, please see reference link. + +#### Returns + +`Promise`\<`boolean`\> + +#### Ref + +https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidimeactivated + +#### Deprecated + +This command is deprecated and likely not supported by any browser. + +#### Inherited from + +`ProtocolCommands.isIMEActivated` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/jsonwp.d.ts:507 + +*** + +### ~~isKeyboardShown()~~ + +```ts +isKeyboardShown(): Promise +``` + +Appium Protocol Command + +Whether or not the soft keyboard is shown. + +#### Returns + +`Promise`\<`boolean`\> + +#### Ref + +https://appium.github.io/appium.io/docs/en/commands/device/keys/is-keyboard-shown/ + +#### Inherited from + +`ProtocolCommands.isKeyboardShown` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/appium.d.ts:202 + +*** + +### ~~isLoading()~~ + +```ts +isLoading(): Promise +``` + +Chromium Protocol Command + +Determines load status for active window handle. + +#### Returns + +`Promise`\<`boolean`\> + +#### Ref + +https://github.com/bayandin/chromedriver/blob/v2.45/session_commands.cc#L783-L802 + +#### Example + +```js +console.log(browser.isLoading()); // outputs: false +browser.newWindow('https://webdriver.io'); +console.log(browser.isLoading()); // outputs: true +``` + +#### Inherited from + +`ProtocolCommands.isLoading` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/chromium.d.ts:61 + +*** + +### ~~isLocked()~~ + +```ts +isLocked(): Promise +``` + +Appium Protocol Command + +Check whether the device is locked or not. + +#### Returns + +`Promise`\<`boolean`\> + +#### Ref + +https://appium.github.io/appium.io/docs/en/commands/device/interactions/is-locked/ + +#### Inherited from + +`ProtocolCommands.isLocked` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/appium.d.ts:58 + +*** + +### ~~jankinessCheck()~~ + +```ts +jankinessCheck(): Promise +``` + +Saucelabs Protocol Command + +Perform a scroll test that evaluates the jankiness of the application. + +#### Returns + +`Promise`\<`ProtocolCommandResponse`\> + +#### Ref + +https://wiki.saucelabs.com/display/DOCS/Custom+Sauce+Labs+WebDriver+Extensions+for+Network+and+Log+Commands + +#### Example + +```js +// test performance for a page +browser.url('https://webdriver.io') +browser.jankinessCheck() +``` + +#### Inherited from + +`ProtocolCommands.jankinessCheck` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/saucelabs.d.ts:161 + +*** + +### ~~launchApp()~~ + +```ts +launchApp(): Promise +``` + +Appium Protocol Command + +Launch an app on device. + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://appium.github.io/appium.io/docs/en/commands/device/app/launch-app/ + +#### Deprecated + +For iOS, utilize `driver.execute('mobile: launchApp', { ... })`, and for Android, make use of `driver.execute('mobile: activateApp', { ... })`. + +#### Inherited from + +`ProtocolCommands.launchApp` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/appium.d.ts:331 + +*** + +### ~~launchChromeApp()~~ + +```ts +launchChromeApp(id): Promise +``` + +Chromium Protocol Command + +Launches a Chrome app by specified id. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `id` | `string` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://github.com/bayandin/chromedriver/blob/v2.45/session_commands.cc#L521-L539 + +#### Example + +```js +import fs from 'fs' +const browser = remote({ + capabilities: { + browserName: 'chrome', + 'goog:chromeOptions': { + // Install upon starting browser in order to launch it + extensions: [ + // Entry should be a base64-encoded packed Chrome app (.crx) + fs.readFileSync('/absolute/path/app.crx').toString('base64') + ] + } + } +}); +browser.launchChromeApp('aohghmighlieiainnegkcijnfilokake')); // Google Docs (https://chrome.google.com/webstore/detail/docs/aohghmighlieiainnegkcijnfilokake) +``` + +#### Inherited from + +`ProtocolCommands.launchChromeApp` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/chromium.d.ts:204 + +*** + +### ~~listenerCount()~~ + +```ts +listenerCount(eventName, listener?): number +``` + +Returns the number of listeners listening to the event named `eventName`. + +If `listener` is provided, it will return how many times the listener +is found in the list of the listeners of the event. + +#### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `eventName` | `string` \| `symbol` | Returns the number of listeners listening to the event named `eventName`. If `listener` is provided, it will return how many times the listener is found in the list of the listeners of the event. | +| `listener`? | `Function` | Returns the number of listeners listening to the event named `eventName`. If `listener` is provided, it will return how many times the listener is found in the list of the listeners of the event. | + +#### Returns + +`number` + +#### Since + +v3.2.0 + +#### Inherited from + +`Omit.listenerCount` + +#### Defined in + +testplane/node\_modules/@types/node/events.d.ts:741 + +*** + +### ~~listeners()~~ + +```ts +listeners(eventName): Function[] +``` + +Returns a copy of the array of listeners for the event named `eventName`. + +```js +server.on('connection', (stream) => { + console.log('someone connected!'); +}); +console.log(util.inspect(server.listeners('connection'))); +// Prints: [ [Function] ] +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `eventName` | `string` \| `symbol` | + +#### Returns + +`Function`[] + +#### Since + +v0.1.26 + +#### Inherited from + +`Omit.listeners` + +#### Defined in + +testplane/node\_modules/@types/node/events.d.ts:660 + +*** + +### ~~lock()~~ + +```ts +lock(seconds?): Promise +``` + +Appium Protocol Command + +Lock the device. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `seconds`? | `number` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://appium.github.io/appium.io/docs/en/commands/device/interactions/lock/ + +#### Inherited from + +`ProtocolCommands.lock` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/appium.d.ts:42 + +*** + +### ~~logEvent()~~ + +```ts +logEvent(vendor, event): Promise +``` + +Appium Protocol Command + +Store a custom event. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `vendor` | `string` | +| `event` | `string` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://github.com/appium/appium/blob/master/docs/en/commands/session/events/log-event.md + +#### Inherited from + +`ProtocolCommands.logEvent` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/appium.d.ts:555 + +*** + +### ~~longPressKeyCode()~~ + +```ts +longPressKeyCode( + keycode, + metastate?, +flags?): Promise +``` + +Appium Protocol Command + +Press and hold a particular key code on the device. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `keycode` | `number` | +| `metastate`? | `number` | +| `flags`? | `number` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://appium.github.io/appium.io/docs/en/commands/device/keys/long-press-keycode/ + +#### Inherited from + +`ProtocolCommands.longPressKeyCode` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/appium.d.ts:106 + +*** + +### ~~manageSeleniumHubLifecycle()~~ + +```ts +manageSeleniumHubLifecycle(action): Promise +``` + +Selenium Protocol Command + +Manage lifecycle of hub node. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `action` | `string` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://github.com/nicegraham/selenium-grid2-api#lifecycle-manager + +#### Inherited from + +`ProtocolCommands.manageSeleniumHubLifecycle` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/selenium.d.ts:66 + +*** + +### ~~maximizeWindow()~~ + +```ts +maximizeWindow(): Promise +``` + +Webdriver Protocol Command + +The Maximize Window command invokes the window manager-specific "maximize" operation, if any, on the window containing the current top-level browsing context. This typically increases the window to the maximum available size without going full-screen. + +#### Returns + +`Promise`\<`RectReturn`\> + +#### Ref + +https://w3c.github.io/webdriver/#dfn-maximize-window + +#### Inherited from + +`ProtocolCommands.maximizeWindow` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:178 + +*** + +### ~~minimizeWindow()~~ + +```ts +minimizeWindow(): Promise +``` + +Webdriver Protocol Command + +The Minimize Window command invokes the window manager-specific "minimize" operation, if any, on the window containing the current top-level browsing context. This typically hides the window in the system tray. + +#### Returns + +`Promise`\<`RectReturn`\> + +#### Ref + +https://w3c.github.io/webdriver/#dfn-minimize-window + +#### Inherited from + +`ProtocolCommands.minimizeWindow` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:186 + +*** + +### ~~mockRequest()~~ + +```ts +mockRequest(url, filterOptions?): Promise +``` + +Saucelabs Protocol Command + +Mocks a network resource. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `url` | `string` | +| `filterOptions`? | `object` | + +#### Returns + +`Promise`\<`ProtocolCommandResponse`\> + +#### Ref + +https://wiki.saucelabs.com/display/DOCS/Custom+Sauce+Labs+WebDriver+Extensions+for+Network+and+Log+Commands + +#### Inherited from + +`ProtocolCommands.mockRequest` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/saucelabs.d.ts:169 + +*** + +### ~~moveToElement()~~ + +```ts +moveToElement( + element?, + xoffset?, +yoffset?): Promise +``` + +Jsonwp Protocol Command + +No description available, please see reference link. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `element`? | `null` \| `string` | +| `xoffset`? | `number` | +| `yoffset`? | `number` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidmoveto + +#### Deprecated + +This command is deprecated and likely not supported by any browser. Use the "action" command instead to execute a "move to" gesture! + +#### Inherited from + +`ProtocolCommands.moveToElement` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/jsonwp.d.ts:552 + +*** + +### ~~multiTouchPerform()~~ + +```ts +multiTouchPerform(actions): Promise +``` + +Appium Protocol Command + +This functionality is only available from within a native context. Perform a multi touch action sequence. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `actions` | `object`[] | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://appium.github.io/appium.io/docs/en/commands/interactions/touch/multi-touch-perform/ + +#### Inherited from + +`ProtocolCommands.multiTouchPerform` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/appium.d.ts:531 + +*** + +### ~~navigateTo()~~ + +```ts +navigateTo(url): Promise +``` + +Webdriver Protocol Command + +The navigateTo (go) command is used to cause the user agent to navigate the current top-level browsing context a new location. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `url` | `string` | + +#### Returns + +`Promise`\<`string`\> + +#### Ref + +https://w3c.github.io/webdriver/#dfn-navigate-to + +#### Inherited from + +`ProtocolCommands.navigateTo` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:58 + +*** + +### ~~networkAddIntercept()~~ + +```ts +networkAddIntercept(params): Promise +``` + +WebDriver Bidi command to send command method "network.addIntercept" with parameters. + +#### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `params` | `NetworkAddInterceptParameters` | WebDriver Bidi command to send command method "network.addIntercept" with parameters. | + +#### Returns + +`Promise`\<`NetworkAddInterceptResult`\> + +`Promise` + +#### Url + +https://w3c.github.io/webdriver-bidi/#command-network-addIntercept + +#### Inherited from + +`BidiHandler.networkAddIntercept` + +#### Defined in + +testplane/node\_modules/webdriver/build/bidi/handler.d.ts:151 + +*** + +### ~~networkContinueRequest()~~ + +```ts +networkContinueRequest(params): Promise +``` + +WebDriver Bidi command to send command method "network.continueRequest" with parameters. + +#### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `params` | `NetworkContinueRequestParameters` | WebDriver Bidi command to send command method "network.continueRequest" with parameters. | + +#### Returns + +`Promise`\<`EmptyResult`\> + +`Promise` + +#### Url + +https://w3c.github.io/webdriver-bidi/#command-network-continueRequest + +#### Inherited from + +`BidiHandler.networkContinueRequest` + +#### Defined in + +testplane/node\_modules/webdriver/build/bidi/handler.d.ts:158 + +*** + +### ~~networkContinueResponse()~~ + +```ts +networkContinueResponse(params): Promise +``` + +WebDriver Bidi command to send command method "network.continueResponse" with parameters. + +#### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `params` | `NetworkContinueResponseParameters` | WebDriver Bidi command to send command method "network.continueResponse" with parameters. | + +#### Returns + +`Promise`\<`EmptyResult`\> + +`Promise` + +#### Url + +https://w3c.github.io/webdriver-bidi/#command-network-continueResponse + +#### Inherited from + +`BidiHandler.networkContinueResponse` + +#### Defined in + +testplane/node\_modules/webdriver/build/bidi/handler.d.ts:165 + +*** + +### ~~networkContinueWithAuth()~~ + +```ts +networkContinueWithAuth(params): Promise +``` + +WebDriver Bidi command to send command method "network.continueWithAuth" with parameters. + +#### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `params` | `NetworkContinueWithAuthParameters` | WebDriver Bidi command to send command method "network.continueWithAuth" with parameters. | + +#### Returns + +`Promise`\<`EmptyResult`\> + +`Promise` + +#### Url + +https://w3c.github.io/webdriver-bidi/#command-network-continueWithAuth + +#### Inherited from + +`BidiHandler.networkContinueWithAuth` + +#### Defined in + +testplane/node\_modules/webdriver/build/bidi/handler.d.ts:172 + +*** + +### ~~networkFailRequest()~~ + +```ts +networkFailRequest(params): Promise +``` + +WebDriver Bidi command to send command method "network.failRequest" with parameters. + +#### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `params` | `NetworkFailRequestParameters` | WebDriver Bidi command to send command method "network.failRequest" with parameters. | + +#### Returns + +`Promise`\<`EmptyResult`\> + +`Promise` + +#### Url + +https://w3c.github.io/webdriver-bidi/#command-network-failRequest + +#### Inherited from + +`BidiHandler.networkFailRequest` + +#### Defined in + +testplane/node\_modules/webdriver/build/bidi/handler.d.ts:179 + +*** + +### ~~networkProvideResponse()~~ + +```ts +networkProvideResponse(params): Promise +``` + +WebDriver Bidi command to send command method "network.provideResponse" with parameters. + +#### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `params` | `NetworkProvideResponseParameters` | WebDriver Bidi command to send command method "network.provideResponse" with parameters. | + +#### Returns + +`Promise`\<`EmptyResult`\> + +`Promise` + +#### Url + +https://w3c.github.io/webdriver-bidi/#command-network-provideResponse + +#### Inherited from + +`BidiHandler.networkProvideResponse` + +#### Defined in + +testplane/node\_modules/webdriver/build/bidi/handler.d.ts:186 + +*** + +### ~~networkRemoveIntercept()~~ + +```ts +networkRemoveIntercept(params): Promise +``` + +WebDriver Bidi command to send command method "network.removeIntercept" with parameters. + +#### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `params` | `NetworkRemoveInterceptParameters` | WebDriver Bidi command to send command method "network.removeIntercept" with parameters. | + +#### Returns + +`Promise`\<`EmptyResult`\> + +`Promise` + +#### Url + +https://w3c.github.io/webdriver-bidi/#command-network-removeIntercept + +#### Inherited from + +`BidiHandler.networkRemoveIntercept` + +#### Defined in + +testplane/node\_modules/webdriver/build/bidi/handler.d.ts:193 + +*** + +### ~~newSession()~~ + +```ts +newSession(capabilities): Promise +``` + +Webdriver Protocol Command + +The New Session command creates a new WebDriver session with the endpoint node. If the creation fails, a session not created error is returned. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `capabilities` | `object` | + +#### Returns + +`Promise`\<`SessionReturn`\> + +#### Ref + +https://w3c.github.io/webdriver/#dfn-new-sessions + +#### Inherited from + +`ProtocolCommands.newSession` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:10 + +*** + +### ~~off()~~ + +```ts +off(eventName, listener): this +``` + +Alias for `emitter.removeListener()`. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `eventName` | `string` \| `symbol` | +| `listener` | (...`args`) => `void` | + +#### Returns + +`this` + +#### Since + +v10.0.0 + +#### Inherited from + +`Omit.off` + +#### Defined in + +testplane/node\_modules/@types/node/events.d.ts:620 + +*** + +### ~~on()~~ + +```ts +on(event, listener): this +``` + +#### Type Parameters + +| Type Parameter | +| ------ | +| `K` *extends* \| `"browsingContext.contextCreated"` \| `"browsingContext.contextDestroyed"` \| `"browsingContext.domContentLoaded"` \| `"browsingContext.downloadWillBegin"` \| `"browsingContext.fragmentNavigated"` \| `"browsingContext.load"` \| `"browsingContext.navigationAborted"` \| `"browsingContext.navigationFailed"` \| `"browsingContext.navigationStarted"` \| `"browsingContext.userPromptClosed"` \| `"browsingContext.userPromptOpened"` \| `"log.entryAdded"` \| `"network.authRequired"` \| `"network.beforeRequestSent"` \| `"network.fetchError"` \| `"network.responseCompleted"` \| `"network.responseStarted"` \| `"script.message"` \| `"script.realmCreated"` \| `"script.realmDestroyed"` \| keyof WebDriverClassicEvents | + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `event` | `K` | +| `listener` | (`this`, `param`) => `void` | + +#### Returns + +`this` + +#### Inherited from + +`BidiEventHandler.on` + +#### Defined in + +testplane/node\_modules/webdriver/build/types.d.ts:66 + +*** + +### ~~once()~~ + +```ts +once(event, listener): this +``` + +#### Type Parameters + +| Type Parameter | +| ------ | +| `K` *extends* \| `"browsingContext.contextCreated"` \| `"browsingContext.contextDestroyed"` \| `"browsingContext.domContentLoaded"` \| `"browsingContext.downloadWillBegin"` \| `"browsingContext.fragmentNavigated"` \| `"browsingContext.load"` \| `"browsingContext.navigationAborted"` \| `"browsingContext.navigationFailed"` \| `"browsingContext.navigationStarted"` \| `"browsingContext.userPromptClosed"` \| `"browsingContext.userPromptOpened"` \| `"log.entryAdded"` \| `"network.authRequired"` \| `"network.beforeRequestSent"` \| `"network.fetchError"` \| `"network.responseCompleted"` \| `"network.responseStarted"` \| `"script.message"` \| `"script.realmCreated"` \| `"script.realmDestroyed"` \| keyof WebDriverClassicEvents | + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `event` | `K` | +| `listener` | (`this`, `param`) => `void` | + +#### Returns + +`this` + +#### Inherited from + +`BidiEventHandler.once` + +#### Defined in + +testplane/node\_modules/webdriver/build/types.d.ts:67 + +*** + +### ~~openNotifications()~~ + +```ts +openNotifications(): Promise +``` + +Appium Protocol Command + +Open Android notifications (Emulator only). + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://appium.github.io/appium.io/docs/en/commands/device/system/open-notifications/ + +#### Inherited from + +`ProtocolCommands.openNotifications` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/appium.d.ts:274 + +*** + +### ~~overwriteCommand()~~ + +```ts +overwriteCommand( + name, + func, + attachToElement?, + proto?, + instances?): void +``` + +overwrite `browser` or `element` command + +#### Type Parameters + +| Type Parameter | Default type | +| ------ | ------ | +| `ElementKey` *extends* \| `"$"` \| `"custom$"` \| `"shadow$"` \| `"react$"` \| `"$$"` \| `"custom$$"` \| `"shadow$$"` \| `"react$$"` \| `"saveScreenshot"` \| `"touchAction"` \| `"waitUntil"` \| `"addValue"` \| `"clearValue"` \| `"click"` \| `"doubleClick"` \| `"dragAndDrop"` \| `"getAttribute"` \| `"getCSSProperty"` \| `"getComputedLabel"` \| `"getComputedRole"` \| `"getHTML"` \| `"getLocation"` \| `"getProperty"` \| `"getSize"` \| `"getTagName"` \| `"getText"` \| `"getValue"` \| `"isClickable"` \| `"isDisplayed"` \| `"isDisplayedInViewport"` \| `"isEnabled"` \| `"isEqual"` \| `"isExisting"` \| `"isFocused"` \| `"isSelected"` \| `"moveTo"` \| `"nextElement"` \| `"parentElement"` \| `"previousElement"` \| `"scrollIntoView"` \| `"selectByAttribute"` \| `"selectByIndex"` \| `"selectByVisibleText"` \| `"setValue"` \| `"waitForClickable"` \| `"waitForDisplayed"` \| `"waitForEnabled"` \| `"waitForExist"` \| `"isStable"` \| `"waitForStable"` | - | +| `BrowserKey` *extends* \| `"keys"` \| `"$"` \| `"custom$"` \| `"react$"` \| `"$$"` \| `"custom$$"` \| `"react$$"` \| `"action"` \| `"actions"` \| `"call"` \| `"debug"` \| `"deleteCookies"` \| `"downloadFile"` \| `"emulate"` \| `"execute"` \| `"executeAsync"` \| `"getCookies"` \| `"getPuppeteer"` \| `"getWindowSize"` \| `"mock"` \| `"SESSION_MOCKS"` \| `"CDP_SESSIONS"` \| `"mockClearAll"` \| `"mockRestoreAll"` \| `"newWindow"` \| `"pause"` \| `"reloadSession"` \| `"savePDF"` \| `"saveRecordingScreen"` \| `"saveScreenshot"` \| `"scroll"` \| `"setCookies"` \| `"setTimeout"` \| `"setWindowSize"` \| `"switchWindow"` \| `"throttle"` \| `"throttleCPU"` \| `"throttleNetwork"` \| `"touchAction"` \| `"uploadFile"` \| `"url"` \| `"waitUntil"` | - | +| `IsElement` *extends* `boolean` | `false` | + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `name` | `IsElement` *extends* `true` ? `ElementKey` : `BrowserKey` | +| `func` | `OverwriteCommandFn`\<`ElementKey`, `BrowserKey`, `IsElement`\> \| `OverwriteCommandFnScoped`\<`ElementKey`, `BrowserKey`, `IsElement`\> | +| `attachToElement`? | `IsElement` | +| `proto`? | `Record`\<`string`, `any`\> | +| `instances`? | `Record`\<`string`, `Browser` \| `MultiRemoteBrowser`\> | + +#### Returns + +`void` + +#### Inherited from + +`Omit.overwriteCommand` + +#### Defined in + +testplane/node\_modules/webdriverio/build/types.d.ts:139 + +*** + +### ~~performActions()~~ + +```ts +performActions(actions): Promise +``` + +Webdriver Protocol Command + +The Perform Actions command is used to execute complex user actions. See [spec](https://github.com/jlipps/simple-wd-spec#perform-actions) for more details. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `actions` | `object`[] | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://w3c.github.io/webdriver/#dfn-perform-actions + +#### Inherited from + +`ProtocolCommands.performActions` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:426 + +*** + +### ~~positionClick()~~ + +```ts +positionClick(button?): Promise +``` + +Jsonwp Protocol Command + +Clicks at the current mouse coordinates (set by moveto). + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `button`? | `number` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidclick + +#### Deprecated + +This command is deprecated and likely not supported by any browser. Use the "action" command instead of "positionClick"! + +#### Inherited from + +`ProtocolCommands.positionClick` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/jsonwp.d.ts:579 + +*** + +### ~~positionDoubleClick()~~ + +```ts +positionDoubleClick(): Promise +``` + +Jsonwp Protocol Command + +Double-clicks at the current mouse coordinates (set by moveto). + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessioniddoubleclick + +#### Deprecated + +This command is deprecated and likely not supported by any browser. Use the "action" command instead to execute a click gesture! + +#### Inherited from + +`ProtocolCommands.positionDoubleClick` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/jsonwp.d.ts:588 + +*** + +### ~~powerAC()~~ + +```ts +powerAC(state): Promise +``` + +Appium Protocol Command + +Set the state of the battery charger to connected or not (Emulator only). + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `state` | `string` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://appium.github.io/appium.io/docs/en/commands/device/emulator/power_ac/ + +#### Inherited from + +`ProtocolCommands.powerAC` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/appium.d.ts:437 + +*** + +### ~~powerCapacity()~~ + +```ts +powerCapacity(percent): Promise +``` + +Appium Protocol Command + +Set the battery percentage (Emulator only). + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `percent` | `number` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://appium.github.io/appium.io/docs/en/commands/device/emulator/power_capacity/ + +#### Inherited from + +`ProtocolCommands.powerCapacity` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/appium.d.ts:429 + +*** + +### ~~prependListener()~~ + +```ts +prependListener(eventName, listener): this +``` + +Adds the `listener` function to the _beginning_ of the listeners array for the +event named `eventName`. No checks are made to see if the `listener` has +already been added. Multiple calls passing the same combination of `eventName`and `listener` will result in the `listener` being added, and called, multiple +times. + +```js +server.prependListener('connection', (stream) => { + console.log('someone connected!'); +}); +``` + +Returns a reference to the `EventEmitter`, so that calls can be chained. + +#### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `eventName` | `string` \| `symbol` | Adds the `listener` function to the _beginning_ of the listeners array for the event named `eventName`. No checks are made to see if the `listener` has already been added. Multiple calls passing the same combination of `eventName`and `listener` will result in the `listener` being added, and called, multiple times. `server.prependListener('connection', (stream) => { console.log('someone connected!'); });` Returns a reference to the `EventEmitter`, so that calls can be chained. | +| `listener` | (...`args`) => `void` | Adds the `listener` function to the _beginning_ of the listeners array for the event named `eventName`. No checks are made to see if the `listener` has already been added. Multiple calls passing the same combination of `eventName`and `listener` will result in the `listener` being added, and called, multiple times. `server.prependListener('connection', (stream) => { console.log('someone connected!'); });` Returns a reference to the `EventEmitter`, so that calls can be chained. | + +#### Returns + +`this` + +#### Since + +v6.0.0 + +#### Inherited from + +`Omit.prependListener` + +#### Defined in + +testplane/node\_modules/@types/node/events.d.ts:759 + +*** + +### ~~prependOnceListener()~~ + +```ts +prependOnceListener(eventName, listener): this +``` + +Adds a **one-time**`listener` function for the event named `eventName` to the _beginning_ of the listeners array. The next time `eventName` is triggered, this +listener is removed, and then invoked. + +```js +server.prependOnceListener('connection', (stream) => { + console.log('Ah, we have our first user!'); +}); +``` + +Returns a reference to the `EventEmitter`, so that calls can be chained. + +#### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `eventName` | `string` \| `symbol` | Adds a **one-time**`listener` function for the event named `eventName` to the _beginning_ of the listeners array. The next time `eventName` is triggered, this listener is removed, and then invoked. `server.prependOnceListener('connection', (stream) => { console.log('Ah, we have our first user!'); });` Returns a reference to the `EventEmitter`, so that calls can be chained. | +| `listener` | (...`args`) => `void` | Adds a **one-time**`listener` function for the event named `eventName` to the _beginning_ of the listeners array. The next time `eventName` is triggered, this listener is removed, and then invoked. `server.prependOnceListener('connection', (stream) => { console.log('Ah, we have our first user!'); });` Returns a reference to the `EventEmitter`, so that calls can be chained. | + +#### Returns + +`this` + +#### Since + +v6.0.0 + +#### Inherited from + +`Omit.prependOnceListener` + +#### Defined in + +testplane/node\_modules/@types/node/events.d.ts:775 + +*** + +### ~~pressKeyCode()~~ + +```ts +pressKeyCode( + keycode, + metastate?, +flags?): Promise +``` + +Appium Protocol Command + +Press a particular key on the device. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `keycode` | `number` | +| `metastate`? | `number` | +| `flags`? | `number` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://appium.github.io/appium.io/docs/en/commands/device/keys/press-keycode/ + +#### Inherited from + +`ProtocolCommands.pressKeyCode` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/appium.d.ts:98 + +*** + +### ~~printPage()~~ + +```ts +printPage( + orientation?, + scale?, + background?, + width?, + height?, + top?, + bottom?, + left?, + right?, + shrinkToFit?, +pageRanges?): Promise +``` + +Webdriver Protocol Command + +The Print Page command renders the document to a paginated PDF document. __Note:__ Chrome currently only supports this in [headless mode](https://webdriver.io/docs/capabilities/#run-browser-headless), see [`crbug753118`](https://bugs.chromium.org/p/chromium/issues/detail?id=753118)). + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `orientation`? | `string` | +| `scale`? | `number` | +| `background`? | `boolean` | +| `width`? | `number` | +| `height`? | `number` | +| `top`? | `number` | +| `bottom`? | `number` | +| `left`? | `number` | +| `right`? | `number` | +| `shrinkToFit`? | `boolean` | +| `pageRanges`? | `object`[] | + +#### Returns + +`Promise`\<`string`\> + +#### Ref + +https://w3c.github.io/webdriver/#print-page + +#### Inherited from + +`ProtocolCommands.printPage` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:138 + +*** + +### ~~pullFile()~~ + +```ts +pullFile(path): Promise +``` + +Appium Protocol Command + +Retrieve a file from the device's file system. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `path` | `string` | + +#### Returns + +`Promise`\<`string`\> + +#### Ref + +https://appium.github.io/appium.io/docs/en/commands/device/files/pull-file/ + +#### Inherited from + +`ProtocolCommands.pullFile` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/appium.d.ts:218 + +*** + +### ~~pullFolder()~~ + +```ts +pullFolder(path): Promise +``` + +Appium Protocol Command + +Retrieve a folder from the device's file system. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `path` | `string` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://appium.github.io/appium.io/docs/en/commands/device/files/pull-folder/ + +#### Inherited from + +`ProtocolCommands.pullFolder` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/appium.d.ts:226 + +*** + +### ~~pushFile()~~ + +```ts +pushFile(path, data): Promise +``` + +Appium Protocol Command + +Place a file onto the device in a particular place. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `path` | `string` | +| `data` | `string` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://appium.github.io/appium.io/docs/en/commands/device/files/push-file/ + +#### Inherited from + +`ProtocolCommands.pushFile` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/appium.d.ts:210 + +*** + +### ~~queryAppState()~~ + +```ts +queryAppState(appId): Promise +``` + +Appium Protocol Command + +Get the given app status on the device + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `appId` | `string` | + +#### Returns + +`Promise`\<`number`\> + +#### Ref + +https://appium.github.io/appium.io/docs/en/commands/device/app/app-state/ + +#### Inherited from + +`ProtocolCommands.queryAppState` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/appium.d.ts:186 + +*** + +### ~~queryGrid()~~ + +```ts +queryGrid(query): Promise +``` + +Selenium Protocol Command + +Send GraphQL queries to the Selenium (hub or node) server to fetch data. (Only supported with Selenium v4 Server) + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `query` | `string` | + +#### Returns + +`Promise`\<`ProtocolCommandResponse`\> + +#### Ref + +https://www.selenium.dev/documentation/grid/advanced_features/graphql_support/ + +#### Example + +```js +const result = await browser.queryGrid('{ nodesInfo { nodes { status, uri } } }'); +console.log(JSON.stringify(result, null, 4)) +// +// outputs: +// { +// "data": { +// "nodesInfo": { +// "nodes": [{ +// "status": "UP", +// "uri": "http://192.168.0.39:4444" +// }] +// } +// } +// } +// +``` + +#### Inherited from + +`ProtocolCommands.queryGrid` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/selenium.d.ts:92 + +*** + +### ~~rawListeners()~~ + +```ts +rawListeners(eventName): Function[] +``` + +Returns a copy of the array of listeners for the event named `eventName`, +including any wrappers (such as those created by `.once()`). + +```js +const emitter = new EventEmitter(); +emitter.once('log', () => console.log('log once')); + +// Returns a new Array with a function `onceWrapper` which has a property +// `listener` which contains the original listener bound above +const listeners = emitter.rawListeners('log'); +const logFnWrapper = listeners[0]; + +// Logs "log once" to the console and does not unbind the `once` event +logFnWrapper.listener(); + +// Logs "log once" to the console and removes the listener +logFnWrapper(); + +emitter.on('log', () => console.log('log persistently')); +// Will return a new Array with a single function bound by `.on()` above +const newListeners = emitter.rawListeners('log'); + +// Logs "log persistently" twice +newListeners[0](); +emitter.emit('log'); +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `eventName` | `string` \| `symbol` | + +#### Returns + +`Function`[] + +#### Since + +v9.4.0 + +#### Inherited from + +`Omit.rawListeners` + +#### Defined in + +testplane/node\_modules/@types/node/events.d.ts:690 + +*** + +### ~~receiveAsyncResponse()~~ + +```ts +receiveAsyncResponse(response): Promise +``` + +Appium Protocol Command + +Callback url for asynchronous execution of JavaScript. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `response` | `object` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://github.com/appium/appium-base-driver/blob/master/docs/mjsonwp/protocol-methods.md#appium-extension-endpoints + +#### Inherited from + +`ProtocolCommands.receiveAsyncResponse` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/appium.d.ts:405 + +*** + +### ~~refresh()~~ + +```ts +refresh(): Promise +``` + +Webdriver Protocol Command + +The Refresh command causes the browser to reload the page in current top-level browsing context. + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://w3c.github.io/webdriver/#dfn-refresh + +#### Inherited from + +`ProtocolCommands.refresh` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:82 + +*** + +### ~~releaseActions()~~ + +```ts +releaseActions(): Promise +``` + +Webdriver Protocol Command + +The Release Actions command is used to release all the keys and pointer buttons that are currently depressed. This causes events to be fired as if the state was released by an explicit series of actions. It also clears all the internal state of the virtual devices. + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://w3c.github.io/webdriver/#dfn-release-actions + +#### Inherited from + +`ProtocolCommands.releaseActions` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:434 + +*** + +### ~~removeAllCredentials()~~ + +```ts +removeAllCredentials(authenticatorId): Promise +``` + +Webdriver Protocol Command + +Removes all Public Key Credential Sources stored on a Virtual Authenticator. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `authenticatorId` | `string` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://www.w3.org/TR/webauthn-2/#sctn-automation-remove-all-credentials + +#### Inherited from + +`ProtocolCommands.removeAllCredentials` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:609 + +*** + +### ~~removeAllListeners()~~ + +```ts +removeAllListeners(event?): this +``` + +Removes all listeners, or those of the specified `eventName`. + +It is bad practice to remove listeners added elsewhere in the code, +particularly when the `EventEmitter` instance was created by some other +component or module (e.g. sockets or file streams). + +Returns a reference to the `EventEmitter`, so that calls can be chained. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `event`? | `string` \| `symbol` | + +#### Returns + +`this` + +#### Since + +v0.1.26 + +#### Inherited from + +`Omit.removeAllListeners` + +#### Defined in + +testplane/node\_modules/@types/node/events.d.ts:631 + +*** + +### ~~removeApp()~~ + +```ts +removeApp(appId): Promise +``` + +Appium Protocol Command + +Remove an app from the device. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `appId` | `string` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://appium.github.io/appium.io/docs/en/commands/device/app/remove-app/ + +#### Inherited from + +`ProtocolCommands.removeApp` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/appium.d.ts:162 + +*** + +### ~~removeCredential()~~ + +```ts +removeCredential(authenticatorId, credentialId): Promise +``` + +Webdriver Protocol Command + +Removes a Public Key Credential Source stored on a Virtual Authenticator. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `authenticatorId` | `string` | +| `credentialId` | `string` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://www.w3.org/TR/webauthn-2/#sctn-automation-remove-credential + +#### Inherited from + +`ProtocolCommands.removeCredential` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:617 + +*** + +### ~~removeListener()~~ + +```ts +removeListener(eventName, listener): this +``` + +Removes the specified `listener` from the listener array for the event named`eventName`. + +```js +const callback = (stream) => { + console.log('someone connected!'); +}; +server.on('connection', callback); +// ... +server.removeListener('connection', callback); +``` + +`removeListener()` will remove, at most, one instance of a listener from the +listener array. If any single listener has been added multiple times to the +listener array for the specified `eventName`, then `removeListener()` must be +called multiple times to remove each instance. + +Once an event is emitted, all listeners attached to it at the +time of emitting are called in order. This implies that any`removeListener()` or `removeAllListeners()` calls _after_ emitting and _before_ the last listener finishes execution +will not remove them from`emit()` in progress. Subsequent events behave as expected. + +```js +const myEmitter = new MyEmitter(); + +const callbackA = () => { + console.log('A'); + myEmitter.removeListener('event', callbackB); +}; + +const callbackB = () => { + console.log('B'); +}; + +myEmitter.on('event', callbackA); + +myEmitter.on('event', callbackB); + +// callbackA removes listener callbackB but it will still be called. +// Internal listener array at time of emit [callbackA, callbackB] +myEmitter.emit('event'); +// Prints: +// A +// B + +// callbackB is now removed. +// Internal listener array [callbackA] +myEmitter.emit('event'); +// Prints: +// A +``` + +Because listeners are managed using an internal array, calling this will +change the position indices of any listener registered _after_ the listener +being removed. This will not impact the order in which listeners are called, +but it means that any copies of the listener array as returned by +the `emitter.listeners()` method will need to be recreated. + +When a single function has been added as a handler multiple times for a single +event (as in the example below), `removeListener()` will remove the most +recently added instance. In the example the `once('ping')`listener is removed: + +```js +const ee = new EventEmitter(); + +function pong() { + console.log('pong'); +} + +ee.on('ping', pong); +ee.once('ping', pong); +ee.removeListener('ping', pong); + +ee.emit('ping'); +ee.emit('ping'); +``` + +Returns a reference to the `EventEmitter`, so that calls can be chained. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `eventName` | `string` \| `symbol` | +| `listener` | (...`args`) => `void` | + +#### Returns + +`this` + +#### Since + +v0.1.26 + +#### Inherited from + +`Omit.removeListener` + +#### Defined in + +testplane/node\_modules/@types/node/events.d.ts:615 + +*** + +### ~~removeVirtualAuthenticator()~~ + +```ts +removeVirtualAuthenticator(authenticatorId): Promise +``` + +Webdriver Protocol Command + +Removes a previously created Virtual Authenticator. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `authenticatorId` | `string` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://www.w3.org/TR/webauthn-2/#sctn-automation-remove-virtual-authenticator + +#### Inherited from + +`ProtocolCommands.removeVirtualAuthenticator` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:585 + +*** + +### ~~replaceValue()~~ + +```ts +replaceValue(elementId, value): Promise +``` + +Appium Protocol Command + +Replace the value to element directly. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `elementId` | `string` | +| `value` | `string` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://github.com/appium/appium-base-driver/blob/master/docs/mjsonwp/protocol-methods.md#appium-extension-endpoints + +#### Inherited from + +`ProtocolCommands.replaceValue` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/appium.d.ts:381 + +*** + +### ~~respondMock()~~ + +```ts +respondMock(mockId, payload): Promise +``` + +Saucelabs Protocol Command + +Respond if mock matches a specific resource. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `mockId` | `string` | +| `payload` | `object` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://wiki.saucelabs.com/display/DOCS/Custom+Sauce+Labs+WebDriver+Extensions+for+Network+and+Log+Commands + +#### Inherited from + +`ProtocolCommands.respondMock` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/saucelabs.d.ts:193 + +*** + +### ~~resume()~~ + +```ts +resume(): Promise +``` + +Chromium Protocol Command + +Resume the current page. Extension for [Page Lifecycle API](https://developers.google.com/web/updates/2018/07/page-lifecycle-api). + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://github.com/bayandin/chromedriver/blob/v2.45/window_commands.cc#L635-L645 + +#### Inherited from + +`ProtocolCommands.resume` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/chromium.d.ts:244 + +*** + +### ~~rotateDevice()~~ + +```ts +rotateDevice( + x, + y, +z): Promise +``` + +Appium Protocol Command + +Rotate the device in three dimensions. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `x` | `number` | +| `y` | `number` | +| `z` | `number` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://github.com/SeleniumHQ/mobile-spec/blob/master/spec-draft.md#device-rotation + +#### Inherited from + +`ProtocolCommands.rotateDevice` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/appium.d.ts:122 + +*** + +### ~~sauceThrottleNetwork()~~ + +```ts +sauceThrottleNetwork(condition): Promise +``` + +Saucelabs Protocol Command + +With network conditioning you can test your site on a variety of network connections, including Edge, 3G, and even offline. You can throttle the data throughput, including the maximum download and upload throughput, and use latency manipulation to enforce a minimum delay in connection round-trip time (RTT). + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `condition` | `string` \| `object` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://wiki.saucelabs.com/display/DOCS/Custom+Sauce+Labs+WebDriver+Extensions+for+Network+and+Log+Commands#CustomSauceLabsWebDriverExtensionsforNetworkandLogCommands-ThrottleNetworkCapabilities + +#### Examples + +```js +// predefined network condition +browser.sauceThrottleNetwork('offline') +```* + +```js +// custom network condition +browser.sauceThrottleNetwork({ + download: 1000, + upload: 500, + latency: 40' +}) +``` + +#### Inherited from + +`ProtocolCommands.sauceThrottleNetwork` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/saucelabs.d.ts:70 + +*** + +### ~~scriptAddPreloadScript()~~ + +```ts +scriptAddPreloadScript(params): Promise +``` + +WebDriver Bidi command to send command method "script.addPreloadScript" with parameters. + +#### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `params` | `ScriptAddPreloadScriptParameters` | WebDriver Bidi command to send command method "script.addPreloadScript" with parameters. | + +#### Returns + +`Promise`\<`ScriptAddPreloadScriptResult`\> + +`Promise` + +#### Url + +https://w3c.github.io/webdriver-bidi/#command-script-addPreloadScript + +#### Inherited from + +`BidiHandler.scriptAddPreloadScript` + +#### Defined in + +testplane/node\_modules/webdriver/build/bidi/handler.d.ts:200 + +*** + +### ~~scriptCallFunction()~~ + +```ts +scriptCallFunction(params): Promise +``` + +WebDriver Bidi command to send command method "script.callFunction" with parameters. + +#### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `params` | `ScriptCallFunctionParameters` | WebDriver Bidi command to send command method "script.callFunction" with parameters. | + +#### Returns + +`Promise`\<`EmptyResult`\> + +`Promise` + +#### Url + +https://w3c.github.io/webdriver-bidi/#command-script-callFunction + +#### Inherited from + +`BidiHandler.scriptCallFunction` + +#### Defined in + +testplane/node\_modules/webdriver/build/bidi/handler.d.ts:214 + +*** + +### ~~scriptDisown()~~ + +```ts +scriptDisown(params): Promise +``` + +WebDriver Bidi command to send command method "script.disown" with parameters. + +#### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `params` | `ScriptDisownParameters` | WebDriver Bidi command to send command method "script.disown" with parameters. | + +#### Returns + +`Promise`\<`EmptyResult`\> + +`Promise` + +#### Url + +https://w3c.github.io/webdriver-bidi/#command-script-disown + +#### Inherited from + +`BidiHandler.scriptDisown` + +#### Defined in + +testplane/node\_modules/webdriver/build/bidi/handler.d.ts:207 + +*** + +### ~~scriptEvaluate()~~ + +```ts +scriptEvaluate(params): Promise +``` + +WebDriver Bidi command to send command method "script.evaluate" with parameters. + +#### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `params` | `ScriptEvaluateParameters` | WebDriver Bidi command to send command method "script.evaluate" with parameters. | + +#### Returns + +`Promise`\<`ScriptEvaluateResult`\> + +`Promise` + +#### Url + +https://w3c.github.io/webdriver-bidi/#command-script-evaluate + +#### Inherited from + +`BidiHandler.scriptEvaluate` + +#### Defined in + +testplane/node\_modules/webdriver/build/bidi/handler.d.ts:221 + +*** + +### ~~scriptGetRealms()~~ + +```ts +scriptGetRealms(params): Promise +``` + +WebDriver Bidi command to send command method "script.getRealms" with parameters. + +#### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `params` | `ScriptGetRealmsParameters` | WebDriver Bidi command to send command method "script.getRealms" with parameters. | + +#### Returns + +`Promise`\<`ScriptGetRealmsResult`\> + +`Promise` + +#### Url + +https://w3c.github.io/webdriver-bidi/#command-script-getRealms + +#### Inherited from + +`BidiHandler.scriptGetRealms` + +#### Defined in + +testplane/node\_modules/webdriver/build/bidi/handler.d.ts:228 + +*** + +### ~~scriptRemovePreloadScript()~~ + +```ts +scriptRemovePreloadScript(params): Promise +``` + +WebDriver Bidi command to send command method "script.removePreloadScript" with parameters. + +#### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `params` | `ScriptRemovePreloadScriptParameters` | WebDriver Bidi command to send command method "script.removePreloadScript" with parameters. | + +#### Returns + +`Promise`\<`EmptyResult`\> + +`Promise` + +#### Url + +https://w3c.github.io/webdriver-bidi/#command-script-removePreloadScript + +#### Inherited from + +`BidiHandler.scriptRemovePreloadScript` + +#### Defined in + +testplane/node\_modules/webdriver/build/bidi/handler.d.ts:235 + +*** + +### ~~selectCastSink()~~ + +```ts +selectCastSink(sinkName): Promise +``` + +Chromium Protocol Command + +Selects a cast sink (Cast device) as the recipient of media router intents (connect or play). + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `sinkName` | `string` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://chromium.googlesource.com/chromium/src/+/refs/tags/73.0.3683.121/chrome/test/chromedriver/server/http_handler.cc#737 + +#### Inherited from + +`ProtocolCommands.selectCastSink` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/chromium.d.ts:260 + +*** + +### ~~send()~~ + +```ts +send(params): Promise +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `params` | `Omit`\<`CommandData`, `"id"`\> | + +#### Returns + +`Promise`\<`CommandResponse`\> + +#### Inherited from + +`BidiHandler.send` + +#### Defined in + +testplane/node\_modules/webdriver/build/bidi/core.d.ts:13 + +*** + +### ~~sendAlertText()~~ + +```ts +sendAlertText(text): Promise +``` + +Webdriver Protocol Command + +The Send Alert Text command sets the text field of a window.prompt user prompt to the given value. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `text` | `string` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://w3c.github.io/webdriver/#dfn-send-alert-text + +#### Inherited from + +`ProtocolCommands.sendAlertText` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:466 + +*** + +### ~~sendAsync()~~ + +```ts +sendAsync(params): number +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `params` | `Omit`\<`CommandData`, `"id"`\> | + +#### Returns + +`number` + +#### Inherited from + +`BidiHandler.sendAsync` + +#### Defined in + +testplane/node\_modules/webdriver/build/bidi/core.d.ts:14 + +*** + +### ~~sendCommand()~~ + +```ts +sendCommand(cmd, params): Promise +``` + +Chromium Protocol Command + +Send a command to the DevTools debugger.
For a list of available commands and their parameters refer to the [Chrome DevTools Protocol Viewer](https://chromedevtools.github.io/devtools-protocol/). + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `cmd` | `string` | +| `params` | `object` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://github.com/bayandin/chromedriver/blob/v2.45/window_commands.cc#L1290-L1304 + +#### Inherited from + +`ProtocolCommands.sendCommand` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/chromium.d.ts:163 + +*** + +### ~~sendCommandAndGetResult()~~ + +```ts +sendCommandAndGetResult(cmd, params): Promise +``` + +Chromium Protocol Command + +Send a command to the DevTools debugger and wait for the result.
For a list of available commands and their parameters refer to the [Chrome DevTools Protocol Viewer](https://chromedevtools.github.io/devtools-protocol/). + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `cmd` | `string` | +| `params` | `object` | + +#### Returns + +`Promise`\<`any`\> + +#### Ref + +https://github.com/bayandin/chromedriver/blob/v2.45/window_commands.cc#L1306-L1320 + +#### Inherited from + +`ProtocolCommands.sendCommandAndGetResult` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/chromium.d.ts:171 + +*** + +### ~~sendKeyEvent()~~ + +```ts +sendKeyEvent(keycode, metastate?): Promise +``` + +Appium Protocol Command + +Send a key code to the device. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `keycode` | `string` | +| `metastate`? | `string` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://github.com/appium/appium-base-driver/blob/master/docs/mjsonwp/protocol-methods.md#appium-extension-endpoints + +#### Inherited from + +`ProtocolCommands.sendKeyEvent` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/appium.d.ts:114 + +*** + +### ~~sendKeys()~~ + +```ts +sendKeys(value): Promise +``` + +Jsonwp Protocol Command + +No description available, please see reference link. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `value` | `string`[] | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidkeys + +#### Deprecated + +This command is deprecated and likely not supported by any browser. + +#### Inherited from + +`ProtocolCommands.sendKeys` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/jsonwp.d.ts:384 + +*** + +### ~~sendSms()~~ + +```ts +sendSms(phoneNumber, message): Promise +``` + +Appium Protocol Command + +Simulate an SMS message (Emulator only). + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `phoneNumber` | `string` | +| `message` | `string` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://appium.github.io/appium.io/docs/en/commands/device/network/send-sms/ + +#### Inherited from + +`ProtocolCommands.sendSms` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/appium.d.ts:453 + +*** + +### ~~sessionEnd()~~ + +```ts +sessionEnd(params): Promise +``` + +WebDriver Bidi command to send command method "session.end" with parameters. + +#### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `params` | `EmptyParams` | WebDriver Bidi command to send command method "session.end" with parameters. | + +#### Returns + +`Promise`\<`EmptyResult`\> + +`Promise` + +#### Url + +https://w3c.github.io/webdriver-bidi/#command-session-end + +#### Inherited from + +`BidiHandler.sessionEnd` + +#### Defined in + +testplane/node\_modules/webdriver/build/bidi/handler.d.ts:39 + +*** + +### ~~sessionNew()~~ + +```ts +sessionNew(params): Promise +``` + +WebDriver Bidi command to send command method "session.new" with parameters. + +#### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `params` | `SessionNewParameters` | WebDriver Bidi command to send command method "session.new" with parameters. | + +#### Returns + +`Promise`\<`SessionNewResult`\> + +`Promise` + +#### Url + +https://w3c.github.io/webdriver-bidi/#command-session-new + +#### Inherited from + +`BidiHandler.sessionNew` + +#### Defined in + +testplane/node\_modules/webdriver/build/bidi/handler.d.ts:32 + +*** + +### ~~sessionStatus()~~ + +```ts +sessionStatus(params): Promise +``` + +WebDriver Bidi command to send command method "session.status" with parameters. + +#### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `params` | `EmptyParams` | WebDriver Bidi command to send command method "session.status" with parameters. | + +#### Returns + +`Promise`\<`SessionStatusResult`\> + +`Promise` + +#### Url + +https://w3c.github.io/webdriver-bidi/#command-session-status + +#### Inherited from + +`BidiHandler.sessionStatus` + +#### Defined in + +testplane/node\_modules/webdriver/build/bidi/handler.d.ts:25 + +*** + +### ~~sessionSubscribe()~~ + +```ts +sessionSubscribe(params): Promise +``` + +WebDriver Bidi command to send command method "session.subscribe" with parameters. + +#### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `params` | `SessionSubscriptionRequest` | WebDriver Bidi command to send command method "session.subscribe" with parameters. | + +#### Returns + +`Promise`\<`EmptyResult`\> + +`Promise` + +#### Url + +https://w3c.github.io/webdriver-bidi/#command-session-subscribe + +#### Inherited from + +`BidiHandler.sessionSubscribe` + +#### Defined in + +testplane/node\_modules/webdriver/build/bidi/handler.d.ts:46 + +*** + +### ~~sessionUnsubscribe()~~ + +```ts +sessionUnsubscribe(params): Promise +``` + +WebDriver Bidi command to send command method "session.unsubscribe" with parameters. + +#### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `params` | `SessionSubscriptionRequest` | WebDriver Bidi command to send command method "session.unsubscribe" with parameters. | + +#### Returns + +`Promise`\<`EmptyResult`\> + +`Promise` + +#### Url + +https://w3c.github.io/webdriver-bidi/#command-session-unsubscribe + +#### Inherited from + +`BidiHandler.sessionUnsubscribe` + +#### Defined in + +testplane/node\_modules/webdriver/build/bidi/handler.d.ts:53 + +*** + +### ~~setAsyncTimeout()~~ + +```ts +setAsyncTimeout(ms): Promise +``` + +Jsonwp Protocol Command + +Set the amount of time, in milliseconds, that asynchronous scripts executed by `/session/:sessionId/execute_async` are permitted to run before they are aborted and a `Timeout` error is returned to the client. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `ms` | `number` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidtimeoutsasync_script + +#### Deprecated + +This command is deprecated and likely not supported by any browser. Use the "setTimeouts" command instead! + +#### Inherited from + +`ProtocolCommands.setAsyncTimeout` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/jsonwp.d.ts:61 + +*** + +### ~~setAutoReporting()~~ + +```ts +setAutoReporting(enabled): Promise +``` + +Chromium Protocol Command + +Toggle whether to return response with unknown error with first browser error (e.g. failed to load resource due to 403/404 response) for all subsequent commands (once enabled). + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `enabled` | `boolean` | + +#### Returns + +`Promise`\<`null` \| `object`\> + +#### Ref + +https://codereview.chromium.org/101203012 + +#### Examples + +```js +// Enable auto reporting first thing after session was initiated with empty browser logs +console.log(browser.setAutoReporting(true)); // outputs: null +// Upon requesting an non-existing resource it will abort execution due to thrown unknown error +browser.url('https://webdriver.io/img/404-does-not-exist.png'); +```* + +```js +// During the session do some operations which populate the browser logs +browser.url('https://webdriver.io/img/404-does-not-exist.png'); +browser.url('https://webdriver.io/403/no-access'); +// Enable auto reporting which throws an unknown error for first browser log (404 response) +browser.setAutoReporting(true); +``` + +#### Inherited from + +`ProtocolCommands.setAutoReporting` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/chromium.d.ts:47 + +*** + +### ~~setClipboard()~~ + +```ts +setClipboard( + content, + contentType?, +label?): Promise +``` + +Appium Protocol Command + +Set the content of the system clipboard + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `content` | `string` | +| `contentType`? | `string` | +| `label`? | `string` | + +#### Returns + +`Promise`\<`string`\> + +#### Ref + +https://appium.github.io/appium.io/docs/en/commands/device/clipboard/set-clipboard/ + +#### Inherited from + +`ProtocolCommands.setClipboard` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/appium.d.ts:469 + +*** + +### ~~setGeoLocation()~~ + +```ts +setGeoLocation(location): Promise +``` + +Jsonwp Protocol Command + +Set the current geo location. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `location` | `object` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#post-sessionsessionidlocation + +#### Deprecated + +This command is deprecated and likely not supported by any browser. + +#### Inherited from + +`ProtocolCommands.setGeoLocation` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/jsonwp.d.ts:642 + +*** + +### ~~setImplicitTimeout()~~ + +```ts +setImplicitTimeout(ms): Promise +``` + +Jsonwp Protocol Command + +Set the amount of time the driver should wait when searching for elements. When searching for a single element, the driver should poll the page until an element is found or the timeout expires, whichever occurs first. When searching for multiple elements, the driver should poll the page until at least one element is found or the timeout expires, at which point it should return an empty list. If this command is never sent, the driver should default to an implicit wait of 0ms. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `ms` | `number` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidtimeoutsimplicit_wait + +#### Deprecated + +This command is deprecated and likely not supported by any browser. Use the "setTimeouts" command instead! + +#### Inherited from + +`ProtocolCommands.setImplicitTimeout` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/jsonwp.d.ts:70 + +*** + +### ~~setLocalStorage()~~ + +```ts +setLocalStorage(key, value): Promise +``` + +Jsonwp Protocol Command + +Set the storage item for the given key. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `key` | `string` | +| `value` | `string` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#post-sessionsessionidlocal_storage + +#### Deprecated + +This command is deprecated and likely not supported by any browser. Use the "execute" command instead to interact with the session storage interface! + +#### Inherited from + +`ProtocolCommands.setLocalStorage` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/jsonwp.d.ts:660 + +*** + +### ~~setMaxListeners()~~ + +```ts +setMaxListeners(n): this +``` + +By default `EventEmitter`s will print a warning if more than `10` listeners are +added for a particular event. This is a useful default that helps finding +memory leaks. The `emitter.setMaxListeners()` method allows the limit to be +modified for this specific `EventEmitter` instance. The value can be set to`Infinity` (or `0`) to indicate an unlimited number of listeners. + +Returns a reference to the `EventEmitter`, so that calls can be chained. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `n` | `number` | + +#### Returns + +`this` + +#### Since + +v0.3.5 + +#### Inherited from + +`Omit.setMaxListeners` + +#### Defined in + +testplane/node\_modules/@types/node/events.d.ts:641 + +*** + +### ~~setMozContext()~~ + +```ts +setMozContext(context): Promise +``` + +Gecko Protocol Command + +Changes target context for commands between chrome- and content.

Changing the current context has a stateful impact on all subsequent commands. The `CONTENT` context has normal web platform document permissions, as if you would evaluate arbitrary JavaScript. The `CHROME` context gets elevated permissions that lets you manipulate the browser chrome itself, with full access to the XUL toolkit. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `context` | `string` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://github.com/SeleniumHQ/selenium/blob/586affe0cf675b1d5c8abc756defa4a46d95391b/javascript/node/selenium-webdriver/firefox.js#L615-L645 + +#### Example + +```js +console.log(await browser.getMozContext()); // outputs: 'CHROME' +browser.setMozContext('CONTENT'); +console.log(await browser.getMozContext()); // outputs: 'CONTENT' +``` + +#### Inherited from + +`ProtocolCommands.setMozContext` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/gecko.d.ts:35 + +*** + +### ~~setNetworkConditions()~~ + +```ts +setNetworkConditions(networkConditions, networkName?): Promise +``` + +Chromium Protocol Command + +Set network conditions used for emulation by throttling connection. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `networkConditions` | `object` | +| `networkName`? | `string` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://github.com/bayandin/chromedriver/blob/v2.45/window_commands.cc#L1663-L1722 + +#### Examples + +```js +// Use different download (25kb/s) and upload (50kb/s) throughput values for throttling with a latency of 1000ms +browser.setNetworkConditions({ latency: 1000, download_throughput: 25600, upload_throughput: 51200 }); +```* + +```js +// Force disconnected from network by setting 'offline' to true +browser.setNetworkConditions({ latency: 0, throughput: 0, offline: true }); +```* + +```js +// When preset name (e.g. 'DSL') is specified it does not respect values in object (e.g. 'offline') +browser.setNetworkConditions({ latency: 0, throughput: 0, offline: true }, 'DSL'); +```* + +```js +// Best practice for specifying network throttling preset is to use an empty object +browser.setNetworkConditions({}, 'Good 3G'); +``` + +#### Inherited from + +`ProtocolCommands.setNetworkConditions` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/chromium.d.ts:147 + +*** + +### ~~setNetworkConnection()~~ + +```ts +setNetworkConnection(parameters): Promise +``` + +Chromium Protocol Command + +Change connection type for network connection. This command is only applicable when remote end replies with `networkConnectionEnabled` capability set to `true`. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `parameters` | `object` | + +#### Returns + +`Promise`\<`number`\> + +#### Ref + +https://github.com/SeleniumHQ/mobile-spec/blob/master/spec-draft.md#device-modes + +#### Example + +```js +const browser = remote({ + capabilities: { + browserName: 'chrome', + 'goog:chromeOptions': { + // Network emulation requires device mode, which is only enabled when mobile emulation is on + mobileEmulation: { deviceName: 'iPad' }, + }, + } +}); +console.log(browser.setNetworkConnection({ type: 1 })); // outputs: 1 (Airplane Mode) +``` + +#### Inherited from + +`ProtocolCommands.setNetworkConnection` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/chromium.d.ts:111 + +*** + +### ~~setOrientation()~~ + +```ts +setOrientation(orientation): Promise +``` + +Jsonwp Protocol Command + +No description available, please see reference link. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `orientation` | `string` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#post-sessionsessionidorientation + +#### Deprecated + +This command is deprecated and likely not supported by any browser. + +#### Inherited from + +`ProtocolCommands.setOrientation` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/jsonwp.d.ts:543 + +*** + +### ~~setPermissions()~~ + +```ts +setPermissions( + descriptor, + state, +oneRealm?): Promise +``` + +Webdriver Protocol Command + +Simulates user modification of a PermissionDescriptor's permission state. __Note:__ this feature has not landed in all browsers yet. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `descriptor` | `object` | +| `state` | `string` | +| `oneRealm`? | `boolean` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://w3c.github.io/permissions/#set-permission-command + +#### Examples + +```js +// set midi permissions +browser.setPermissions( + { name: 'midi', sysex: true }, + 'granted' // can be also "denied" or "prompt" +); +```* + +```js +// set clipboard permissions +browser.setPermissions({ name: 'clipboard-read' }, 'granted'); +// now you can read the clipboard via, e.g. +const clipboardText = await browser.execute(() => navigator.clipboard.readText()); +``` + +#### Inherited from + +`ProtocolCommands.setPermissions` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:521 + +*** + +### ~~setSessionStorage()~~ + +```ts +setSessionStorage(key, value): Promise +``` + +Jsonwp Protocol Command + +Set the storage item for the given key. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `key` | `string` | +| `value` | `string` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#post-sessionsessionidsession_storage + +#### Deprecated + +This command is deprecated and likely not supported by any browser. Use the "execute" command instead to interact with the session storage interface! + +#### Inherited from + +`ProtocolCommands.setSessionStorage` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/jsonwp.d.ts:714 + +*** + +### ~~setTimeZone()~~ + +```ts +setTimeZone(timeZone): Promise +``` + +Webdriver Protocol Command + +Simulates the changing of a time zone for the purposes of testing. __Note:__ this feature has not landed in all browsers yet. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `timeZone` | `string` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://w3c.github.io/sensors/#create-mock-sensor-command + +#### Inherited from + +`ProtocolCommands.setTimeZone` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:569 + +*** + +### ~~setTimeouts()~~ + +```ts +setTimeouts( + implicit?, + pageLoad?, +script?): Promise +``` + +Webdriver Protocol Command + +The Set Timeouts command sets timeout durations associated with the current session. The timeouts that can be controlled are listed in the table of session timeouts below. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `implicit`? | `number` | +| `pageLoad`? | `number` | +| `script`? | `number` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://w3c.github.io/webdriver/#dfn-set-timeouts + +#### Inherited from + +`ProtocolCommands.setTimeouts` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:42 + +*** + +### ~~setUserVerified()~~ + +```ts +setUserVerified(authenticatorId): Promise +``` + +Webdriver Protocol Command + +The Set User Verified extension command sets the isUserVerified property on the Virtual Authenticator. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `authenticatorId` | `string` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://www.w3.org/TR/webauthn-2/#sctn-automation-set-user-verified + +#### Inherited from + +`ProtocolCommands.setUserVerified` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:625 + +*** + +### ~~setValueImmediate()~~ + +```ts +setValueImmediate(elementId, text): Promise +``` + +Appium Protocol Command + +No description available, please see reference link. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `elementId` | `string` | +| `text` | `string` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://github.com/appium/appium-base-driver/blob/master/docs/mjsonwp/protocol-methods.md#appium-extension-endpoints + +#### Inherited from + +`ProtocolCommands.setValueImmediate` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/appium.d.ts:373 + +*** + +### ~~setWindowPosition()~~ + +```ts +setWindowPosition(x, y): Promise +``` + +Jsonwp Protocol Command + +Change the position of the current focussed window. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `x` | `number` | +| `y` | `number` | + +#### Returns + +`Promise`\<`ProtocolCommandResponse`\> + +#### Ref + +https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#post-sessionsessionidwindowwindowhandleposition + +#### Deprecated + +This command is deprecated and likely not supported by any browser. + +#### Inherited from + +`ProtocolCommands.setWindowPosition` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/jsonwp.d.ts:184 + +*** + +### ~~setWindowRect()~~ + +```ts +setWindowRect( + x, + y, + width, +height): Promise +``` + +Webdriver Protocol Command + +The Set Window Rect command alters the size and the position of the operating system window corresponding to the current top-level browsing context. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `x` | `null` \| `number` | +| `y` | `null` \| `number` | +| `width` | `null` \| `number` | +| `height` | `null` \| `number` | + +#### Returns + +`Promise`\<`RectReturn`\> + +#### Ref + +https://w3c.github.io/webdriver/#dfn-set-window-rect + +#### Inherited from + +`ProtocolCommands.setWindowRect` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:170 + +*** + +### ~~shake()~~ + +```ts +shake(): Promise +``` + +Appium Protocol Command + +Perform a shake action on the device. + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://appium.github.io/appium.io/docs/en/commands/device/interactions/shake/ + +#### Inherited from + +`ProtocolCommands.shake` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/appium.d.ts:34 + +*** + +### ~~shutdown()~~ + +```ts +shutdown(): Promise +``` + +Chromium Protocol Command + +Shutdown ChromeDriver process and consequently terminating all active sessions. + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://github.com/bayandin/chromedriver/blob/v2.45/session_commands.cc#L489-L498 + +#### Inherited from + +`ProtocolCommands.shutdown` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/chromium.d.ts:292 + +*** + +### ~~startActivity()~~ + +```ts +startActivity( + appPackage, + appActivity, + appWaitPackage?, + appWaitActivity?, + intentAction?, + intentCategory?, + intentFlags?, + optionalIntentArguments?, +dontStopAppOnReset?): Promise +``` + +Appium Protocol Command + +Start an Android activity by providing package name and activity name. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `appPackage` | `string` | +| `appActivity` | `string` | +| `appWaitPackage`? | `string` | +| `appWaitActivity`? | `string` | +| `intentAction`? | `string` | +| `intentCategory`? | `string` | +| `intentFlags`? | `string` | +| `optionalIntentArguments`? | `string` | +| `dontStopAppOnReset`? | `string` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://appium.github.io/appium.io/docs/en/commands/device/activity/start-activity/ + +#### Inherited from + +`ProtocolCommands.startActivity` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/appium.d.ts:282 + +*** + +### ~~startCastTabMirroring()~~ + +```ts +startCastTabMirroring(sinkName): Promise +``` + +Chromium Protocol Command + +Initiates tab mirroring for the current browser tab on the specified device. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `sinkName` | `string` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://chromium.googlesource.com/chromium/src/+/refs/tags/73.0.3683.121/chrome/test/chromedriver/server/http_handler.cc#741 + +#### Inherited from + +`ProtocolCommands.startCastTabMirroring` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/chromium.d.ts:268 + +*** + +### ~~startRecordingScreen()~~ + +```ts +startRecordingScreen(options?): Promise +``` + +Appium Protocol Command + +Start recording the screen. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `options`? | `object` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://appium.github.io/appium.io/docs/en/commands/device/recording-screen/start-recording-screen/ + +#### Inherited from + +`ProtocolCommands.startRecordingScreen` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/appium.d.ts:66 + +*** + +### ~~status()~~ + +```ts +status(): Promise +``` + +Webdriver Protocol Command + +The Status command returns information about whether a remote end is in a state in which it can create new sessions and can additionally include arbitrary meta information that is specific to the implementation. + +#### Returns + +`Promise`\<`StatusReturn`\> + +#### Ref + +https://w3c.github.io/webdriver/#dfn-status + +#### Inherited from + +`ProtocolCommands.status` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:26 + +*** + +### ~~stopCasting()~~ + +```ts +stopCasting(sinkName): Promise +``` + +Chromium Protocol Command + +Stops casting from media router to the specified device, if connected. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `sinkName` | `string` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://chromium.googlesource.com/chromium/src/+/refs/tags/73.0.3683.121/chrome/test/chromedriver/server/http_handler.cc#744 + +#### Inherited from + +`ProtocolCommands.stopCasting` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/chromium.d.ts:284 + +*** + +### ~~stopRecordingScreen()~~ + +```ts +stopRecordingScreen( + remotePath?, + username?, + password?, +method?): Promise +``` + +Appium Protocol Command + +Stop recording screen + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `remotePath`? | `string` | +| `username`? | `string` | +| `password`? | `string` | +| `method`? | `string` | + +#### Returns + +`Promise`\<`string`\> + +#### Ref + +https://appium.github.io/appium.io/docs/en/commands/device/recording-screen/stop-recording-screen/ + +#### Inherited from + +`ProtocolCommands.stopRecordingScreen` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/appium.d.ts:74 + +*** + +### ~~switchContext()~~ + +```ts +switchContext(name): Promise +``` + +Appium Protocol Command + +No description available, please see reference link. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `name` | `string` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://github.com/SeleniumHQ/mobile-spec/blob/master/spec-draft.md#webviews-and-other-contexts + +#### Inherited from + +`ProtocolCommands.switchContext` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/appium.d.ts:18 + +*** + +### ~~switchToFrame()~~ + +```ts +switchToFrame(id): Promise +``` + +Webdriver Protocol Command + +The Switch To Frame command is used to select the current top-level browsing context or a child browsing context of the current browsing context to use as the current browsing context for subsequent commands. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `id` | `null` \| `number` \| `object` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://w3c.github.io/webdriver/#dfn-switch-to-frame + +#### Inherited from + +`ProtocolCommands.switchToFrame` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:146 + +*** + +### ~~switchToParentFrame()~~ + +```ts +switchToParentFrame(): Promise +``` + +Webdriver Protocol Command + +The Switch to Parent Frame command sets the current browsing context for future commands to the parent of the current browsing context. + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://w3c.github.io/webdriver/#dfn-switch-to-parent-frame + +#### Inherited from + +`ProtocolCommands.switchToParentFrame` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:154 + +*** + +### ~~switchToWindow()~~ + +```ts +switchToWindow(handle): Promise +``` + +Webdriver Protocol Command + +The Switch To Window command is used to select the current top-level browsing context for the current session, i.e. the one that will be used for processing commands. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `handle` | `string` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://w3c.github.io/webdriver/#dfn-switch-to-window + +#### Inherited from + +`ProtocolCommands.switchToWindow` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:114 + +*** + +### ~~takeElementScreenshot()~~ + +```ts +takeElementScreenshot(elementId, scroll?): Promise +``` + +Webdriver Protocol Command + +The Take Element Screenshot command takes a screenshot of the visible region encompassed by the bounding rectangle of an element. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `elementId` | `string` | +| `scroll`? | `boolean` | + +#### Returns + +`Promise`\<`string`\> + +#### Ref + +https://w3c.github.io/webdriver/#dfn-take-element-screenshot + +#### Inherited from + +`ProtocolCommands.takeElementScreenshot` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:482 + +*** + +### ~~takeHeapSnapshot()~~ + +```ts +takeHeapSnapshot(): Promise +``` + +Chromium Protocol Command + +Takes a heap snapshot of the current execution context. + +#### Returns + +`Promise`\<`ProtocolCommandResponse`\> + +#### Ref + +https://github.com/bayandin/chromedriver/blob/v2.45/chrome/web_view.h#L198-L202 + +#### Inherited from + +`ProtocolCommands.takeHeapSnapshot` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/chromium.d.ts:69 + +*** + +### ~~takeScreenshot()~~ + +```ts +takeScreenshot(): Promise +``` + +Webdriver Protocol Command + +The Take Screenshot command takes a screenshot of the top-level browsing context's viewport. + +#### Returns + +`Promise`\<`string`\> + +#### Ref + +https://w3c.github.io/webdriver/#dfn-take-screenshot + +#### Inherited from + +`ProtocolCommands.takeScreenshot` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:474 + +*** + +### ~~terminateApp()~~ + +```ts +terminateApp(appId): Promise +``` + +Appium Protocol Command + +Terminate the given app on the device + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `appId` | `string` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://appium.github.io/appium.io/docs/en/commands/device/app/terminate-app/ + +#### Inherited from + +`ProtocolCommands.terminateApp` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/appium.d.ts:170 + +*** + +### ~~throttleCPU()~~ + +```ts +throttleCPU(rate): Promise +``` + +Saucelabs Protocol Command + +You can throttle the CPU in DevTools to understand how your page performs under that constraint. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `rate` | `number` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://wiki.saucelabs.com/display/DOCS/Custom+Sauce+Labs+WebDriver+Extensions+for+Network+and+Log+Commands#CustomSauceLabsWebDriverExtensionsforNetworkandLogCommands-ThrottleCPUCapabilities + +#### Examples + +```js +// throttle CPU and make it run 4x slower +browser.throttleCPU(4) +```* + +```js +// reset CPU throttling +browser.throttleCPU(0) +``` + +#### Inherited from + +`ProtocolCommands.throttleCPU` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/saucelabs.d.ts:88 + +*** + +### ~~toggleAirplaneMode()~~ + +```ts +toggleAirplaneMode(): Promise +``` + +Appium Protocol Command + +Toggle airplane mode on device. + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://appium.github.io/appium.io/docs/en/commands/device/network/toggle-airplane-mode/ + +#### Inherited from + +`ProtocolCommands.toggleAirplaneMode` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/appium.d.ts:234 + +*** + +### ~~toggleData()~~ + +```ts +toggleData(): Promise +``` + +Appium Protocol Command + +Switch the state of data service. + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://appium.github.io/appium.io/docs/en/commands/device/network/toggle-data/ + +#### Inherited from + +`ProtocolCommands.toggleData` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/appium.d.ts:242 + +*** + +### ~~toggleEnrollTouchId()~~ + +```ts +toggleEnrollTouchId(enabled?): Promise +``` + +Appium Protocol Command + +Toggle the simulator being [enrolled](https://support.apple.com/en-ca/ht201371) to accept touchId (iOS Simulator only). To enable this feature, the `allowTouchIdEnroll` desired capability must be set to true. When `allowTouchIdEnroll` is set to true the Simulator will be enrolled by default, and the 'Toggle Touch ID Enrollment' changes the enrollment state. This call will only work if the Appium process or its parent application (e.g., Terminal.app or Appium.app) has access to Mac OS accessibility in System Preferences > Security & Privacy > Privacy > Accessibility list. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `enabled`? | `boolean` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://appium.github.io/appium.io/docs/en/commands/device/simulator/toggle-touch-id-enrollment/ + +#### Inherited from + +`ProtocolCommands.toggleEnrollTouchId` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/appium.d.ts:322 + +*** + +### ~~toggleLocationServices()~~ + +```ts +toggleLocationServices(): Promise +``` + +Appium Protocol Command + +Switch the state of the location service. + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://appium.github.io/appium.io/docs/en/commands/device/network/toggle-location-services/ + +#### Inherited from + +`ProtocolCommands.toggleLocationServices` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/appium.d.ts:258 + +*** + +### ~~toggleNetworkSpeed()~~ + +```ts +toggleNetworkSpeed(netspeed): Promise +``` + +Appium Protocol Command + +Set network speed (Emulator only) + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `netspeed` | `string` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://appium.github.io/appium.io/docs/en/commands/device/network/network-speed/ + +#### Inherited from + +`ProtocolCommands.toggleNetworkSpeed` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/appium.d.ts:266 + +*** + +### ~~toggleWiFi()~~ + +```ts +toggleWiFi(): Promise +``` + +Appium Protocol Command + +Switch the state of the wifi service. + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://appium.github.io/appium.io/docs/en/commands/device/network/toggle-wifi/ + +#### Inherited from + +`ProtocolCommands.toggleWiFi` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/appium.d.ts:250 + +*** + +### ~~touchClick()~~ + +```ts +touchClick(element): Promise +``` + +Jsonwp Protocol Command + +Single tap on the touch enabled device. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `element` | `string` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidtouchclick + +#### Deprecated + +This command is deprecated and likely not supported by any browser. Use the "action" command instead to execute a touch gesture! + +#### Inherited from + +`ProtocolCommands.touchClick` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/jsonwp.d.ts:597 + +*** + +### ~~touchDoubleClick()~~ + +```ts +touchDoubleClick(element): Promise +``` + +Jsonwp Protocol Command + +Double tap on the touch screen using finger motion events. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `element` | `string` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidtouchdoubleclick + +#### Deprecated + +This command is deprecated and likely not supported by any browser. Use the "action" command instead to execute a touch gesture! + +#### Inherited from + +`ProtocolCommands.touchDoubleClick` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/jsonwp.d.ts:615 + +*** + +### ~~touchFlick()~~ + +```ts +touchFlick( + xoffset?, + yoffset?, + element?, + speed?, + xspeed?, +yspeed?): Promise +``` + +Jsonwp Protocol Command + +Flick on the touch screen using finger motion events. This flickcommand starts at a particulat screen location. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `xoffset`? | `number` | +| `yoffset`? | `number` | +| `element`? | `string` | +| `speed`? | `number` | +| `xspeed`? | `number` | +| `yspeed`? | `number` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidtouchflick + +#### Deprecated + +This command is deprecated and likely not supported by any browser. Use the "action" command instead to execute a touch gesture! + +#### Inherited from + +`ProtocolCommands.touchFlick` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/jsonwp.d.ts:624 + +*** + +### ~~touchId()~~ + +```ts +touchId(match): Promise +``` + +Appium Protocol Command + +Simulate a [touch id](https://support.apple.com/en-ca/ht201371) event (iOS Simulator only). To enable this feature, the `allowTouchIdEnroll` desired capability must be set to true and the Simulator must be [enrolled](https://support.apple.com/en-ca/ht201371). When you set allowTouchIdEnroll to true, it will set the Simulator to be enrolled by default. The enrollment state can be [toggled](https://appium.github.io/appium.io/docs/en/commands/device/simulator/toggle-touch-id-enrollment/index.html). This call will only work if Appium process or its parent application (e.g. Terminal.app or Appium.app) has access to Mac OS accessibility in System Preferences > Security & Privacy > Privacy > Accessibility list. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `match` | `boolean` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://appium.github.io/appium.io/docs/en/commands/device/simulator/touch-id/ + +#### Inherited from + +`ProtocolCommands.touchId` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/appium.d.ts:314 + +*** + +### ~~touchPerform()~~ + +```ts +touchPerform(actions): Promise +``` + +Appium Protocol Command + +This functionality is only available from within a native context. 'Touch Perform' works similarly to the other singular touch interactions, except that this allows you to chain together more than one touch action as one command. This is useful because Appium commands are sent over the network and there's latency between commands. This latency can make certain touch interactions impossible because some interactions need to be performed in one sequence. Vertical, for example, requires pressing down, moving to a different y coordinate, and then releasing. For it to work, there can't be a delay between the interactions. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `actions` | `object`[] | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://appium.github.io/appium.io/docs/en/commands/interactions/touch/touch-perform/ + +#### Example + +```js +// do a horizontal swipe by percentage +const startPercentage = 10; +const endPercentage = 90; +const anchorPercentage = 50; + +const { width, height } = driver.getWindowSize(); +const anchor = height// anchorPercentage / 100; +const startPoint = width// startPercentage / 100; +const endPoint = width// endPercentage / 100; +driver.touchPerform([ + { + action: 'press', + options: { + x: startPoint, + y: anchor, + }, + }, + { + action: 'wait', + options: { + ms: 100, + }, + }, + { + action: 'moveTo', + options: { + x: endPoint, + y: anchor, + }, + }, + { + action: 'release', + options: {}, + }, +]); +``` + +#### Inherited from + +`ProtocolCommands.touchPerform` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/appium.d.ts:523 + +*** + +### ~~touchPinch()~~ + +```ts +touchPinch( + x, + y, +scale): Promise +``` + +Chromium Protocol Command + +Trigger a pinch zoom effect. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `x` | `number` | +| `y` | `number` | +| `scale` | `number` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://github.com/bayandin/chromedriver/blob/v2.45/window_commands.cc#L813-L827 + +#### Inherited from + +`ProtocolCommands.touchPinch` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/chromium.d.ts:228 + +*** + +### ~~touchScroll()~~ + +```ts +touchScroll( + xoffset, + yoffset, +element?): Promise +``` + +Jsonwp Protocol Command + +Finger move on the screen. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `xoffset` | `number` | +| `yoffset` | `number` | +| `element`? | `string` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidtouchscroll + +#### Deprecated + +This command is deprecated and likely not supported by any browser. Use the "action" command instead to execute a touch gesture! + +#### Inherited from + +`ProtocolCommands.touchScroll` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/jsonwp.d.ts:606 + +*** + +### ~~uninstallAddOn()~~ + +```ts +uninstallAddOn(id): Promise +``` + +Gecko Protocol Command + +Uninstalls an addon from the current browser session's profile. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `id` | `string` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://github.com/SeleniumHQ/selenium/blob/586affe0cf675b1d5c8abc756defa4a46d95391b/javascript/node/selenium-webdriver/firefox.js#L670-L687 + +#### Example + +```js +// Create a buffer of the add on .zip file +const extension = await fs.promises.readFile('/path/to/extension.zip') +// Load extension in Firefox +const id = await browser.installAddOn(extension.toString('base64'), false); +// ... +await browser.uninstallAddOn(id) +``` + +#### Inherited from + +`ProtocolCommands.uninstallAddOn` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/gecko.d.ts:67 + +*** + +### ~~unlock()~~ + +```ts +unlock(): Promise +``` + +Appium Protocol Command + +Unlock the device. + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://appium.github.io/appium.io/docs/en/commands/device/interactions/unlock/ + +#### Inherited from + +`ProtocolCommands.unlock` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/appium.d.ts:50 + +*** + +### ~~updateMockSensor()~~ + +```ts +updateMockSensor( + type, + mockSensorType, + maxSamplingFrequency, +minSamplingFrequency): Promise +``` + +Webdriver Protocol Command + +Updates the mock sensor type. __Note:__ this feature has not landed in all browsers yet. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `type` | `string` | +| `mockSensorType` | `string` | +| `maxSamplingFrequency` | `number` | +| `minSamplingFrequency` | `number` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://w3c.github.io/sensors/#update-mock-sensor-reading-command + +#### Inherited from + +`ProtocolCommands.updateMockSensor` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:553 + +*** + +### ~~updateSettings()~~ + +```ts +updateSettings(settings): Promise +``` + +Appium Protocol Command + +Update the current setting on the device. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `settings` | `object` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://appium.github.io/appium.io/docs/en/commands/session/settings/update-settings/ + +#### Inherited from + +`ProtocolCommands.updateSettings` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/appium.d.ts:397 diff --git a/docs/api-reference/type-aliases/AssertViewResult.mdx b/docs/api-reference/type-aliases/AssertViewResult.mdx new file mode 100644 index 0000000..edd17d1 --- /dev/null +++ b/docs/api-reference/type-aliases/AssertViewResult.mdx @@ -0,0 +1,11 @@ +[testplane](../README.mdx) / AssertViewResult + +# Type Alias: AssertViewResult + +```ts +type AssertViewResult: AssertViewResultSuccess | AssertViewResultDiff | AssertViewResultNoRefImage; +``` + +## Defined in + +testplane-docs/.testplane/src/types/index.ts:105 diff --git a/docs/api-reference/type-aliases/AsyncSessionEventCallback.mdx b/docs/api-reference/type-aliases/AsyncSessionEventCallback.mdx new file mode 100644 index 0000000..2159c70 --- /dev/null +++ b/docs/api-reference/type-aliases/AsyncSessionEventCallback.mdx @@ -0,0 +1,22 @@ +[testplane](../README.mdx) / AsyncSessionEventCallback + +# Type Alias: AsyncSessionEventCallback() + +```ts +type AsyncSessionEventCallback: (browser, browserInfo) => Promise | void; +``` + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `browser` | `WebdriverIO.Browser` | +| `browserInfo` | [`BrowserInfo`](../interfaces/BrowserInfo.mdx) | + +## Returns + +`Promise`\<`void`\> \| `void` + +## Defined in + +testplane-docs/.testplane/src/types/index.ts:36 diff --git a/docs/api-reference/type-aliases/ConfigInput.mdx b/docs/api-reference/type-aliases/ConfigInput.mdx new file mode 100644 index 0000000..3b96785 --- /dev/null +++ b/docs/api-reference/type-aliases/ConfigInput.mdx @@ -0,0 +1,27 @@ +[testplane](../README.mdx) / ConfigInput + +# Type Alias: ConfigInput + +```ts +type ConfigInput: Partial & { + browsers: Record & { + desiredCapabilities: WebdriverIO.Capabilities; + }>; + plugins: Record; + prepareEnvironment: () => void | null; + sets: Record; +}; +``` + +## Type declaration + +| Name | Type | Defined in | +| ------ | ------ | ------ | +| `browsers` | `Record`\<`string`, `Partial`\<[`CommonConfig`](../interfaces/CommonConfig.mdx)\> & \{ `desiredCapabilities`: `WebdriverIO.Capabilities`; \}\> | testplane-docs/.testplane/src/config/types.ts:197 | +| `plugins` | `Record`\<`string`, `unknown`\> | testplane-docs/.testplane/src/config/types.ts:198 | +| `prepareEnvironment` | () => `void` \| `null` | testplane-docs/.testplane/src/config/types.ts:200 | +| `sets` | `Record`\<`string`, [`SetsConfig`](../interfaces/SetsConfig.mdx)\> | testplane-docs/.testplane/src/config/types.ts:199 | + +## Defined in + +testplane-docs/.testplane/src/config/types.ts:196 diff --git a/docs/api-reference/type-aliases/InterceptHandler.mdx b/docs/api-reference/type-aliases/InterceptHandler.mdx new file mode 100644 index 0000000..c64b1e7 --- /dev/null +++ b/docs/api-reference/type-aliases/InterceptHandler.mdx @@ -0,0 +1,21 @@ +[testplane](../README.mdx) / InterceptHandler + +# Type Alias: InterceptHandler() + +```ts +type InterceptHandler: (arg) => InterceptData | void; +``` + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `arg` | [`InterceptData`](../interfaces/InterceptData.mdx) | + +## Returns + +[`InterceptData`](../interfaces/InterceptData.mdx) \| `void` + +## Defined in + +testplane-docs/.testplane/src/events/types.ts:9 diff --git a/docs/api-reference/type-aliases/InterceptedEvent.mdx b/docs/api-reference/type-aliases/InterceptedEvent.mdx new file mode 100644 index 0000000..d13c5de --- /dev/null +++ b/docs/api-reference/type-aliases/InterceptedEvent.mdx @@ -0,0 +1,19 @@ +[testplane](../README.mdx) / InterceptedEvent + +# Type Alias: InterceptedEvent + +```ts +type InterceptedEvent: ValueOf>; +``` + +## Defined in + +testplane-docs/.testplane/src/events/index.ts:105 diff --git a/docs/api-reference/type-aliases/MasterEventHandler.mdx b/docs/api-reference/type-aliases/MasterEventHandler.mdx new file mode 100644 index 0000000..98ed4f8 --- /dev/null +++ b/docs/api-reference/type-aliases/MasterEventHandler.mdx @@ -0,0 +1,303 @@ +[testplane](../README.mdx) / MasterEventHandler + +# Type Alias: MasterEventHandler()\ + +```ts +type MasterEventHandler: (event, callback) => T(event, callback) => T(event, callback) => T(event, callback) => T(event, callback) => T(event, callback) => T(event, callback) => T(event, callback) => T(event, callback) => T(event, callback) => T(event, callback) => T(event, callback) => T(event, callback) => T(event, callback) => T(event, callback) => T(event, callback) => T(event, callback) => T(event, callback) => T(event, callback) => T(event, callback) => T(event, callback) => T(event, callback) => T(event, callback) => T(event, callback) => T(event, callback) => T(event, callback) => T; +``` + +## Type Parameters + +| Type Parameter | +| ------ | +| `T` *extends* `BaseTestplane` | + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `event` | `"init"` | +| `callback` | () => `void` \| `Promise`\<`void`\> | + +## Returns + +`T` + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `event` | `"startRunner"` | +| `callback` | (`runner`) => `void` \| `Promise`\<`void`\> | + +## Returns + +`T` + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `event` | `"endRunner"` | +| `callback` | (`result`) => `void` \| `Promise`\<`void`\> | + +## Returns + +`T` + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `event` | `"startSession"` | +| `callback` | [`AsyncSessionEventCallback`](AsyncSessionEventCallback.mdx) | + +## Returns + +`T` + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `event` | `"endSession"` | +| `callback` | [`AsyncSessionEventCallback`](AsyncSessionEventCallback.mdx) | + +## Returns + +`T` + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `event` | `"exit"` | +| `callback` | () => `void` \| `Promise`\<`void`\> | + +## Returns + +`T` + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `event` | `"newWorkerProcess"` | +| `callback` | (`suite`) => `void` | + +## Returns + +`T` + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `event` | `"beginSuite"` | +| `callback` | (`suite`) => `void` | + +## Returns + +`T` + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `event` | `"endSuite"` | +| `callback` | (`suite`) => `void` | + +## Returns + +`T` + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `event` | `"beginTest"` | +| `callback` | (`test`) => `void` | + +## Returns + +`T` + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `event` | `"endTest"` | +| `callback` | (`test`) => `void` | + +## Returns + +`T` + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `event` | `"passTest"` | +| `callback` | (`test`) => `void` | + +## Returns + +`T` + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `event` | `"failTest"` | +| `callback` | (`test`) => `void` | + +## Returns + +`T` + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `event` | `"pendingTest"` | +| `callback` | (`test`) => `void` | + +## Returns + +`T` + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `event` | `"retry"` | +| `callback` | (`test`) => `void` | + +## Returns + +`T` + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `event` | `"cli"` | +| `callback` | (`commander`) => `void` | + +## Returns + +`T` + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `event` | `"begin"` | +| `callback` | () => `void` | + +## Returns + +`T` + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `event` | `"end"` | +| `callback` | () => `void` | + +## Returns + +`T` + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `event` | `"beforeFileRead"` | +| `callback` | (`data`) => `void` | + +## Returns + +`T` + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `event` | `"afterFileRead"` | +| `callback` | (`data`) => `void` | + +## Returns + +`T` + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `event` | `"afterTestsRead"` | +| `callback` | (`collection`) => `void` | + +## Returns + +`T` + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `event` | `"info"` | +| `callback` | () => `void` | + +## Returns + +`T` + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `event` | `"warning"` | +| `callback` | () => `void` | + +## Returns + +`T` + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `event` | `"err"` | +| `callback` | (`err`) => `void` | + +## Returns + +`T` + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `event` | `"updateReference"` | +| `callback` | (`data`) => `void` | + +## Returns + +`T` + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `event` | `"newBrowser"` | +| `callback` | [`SyncSessionEventCallback`](SyncSessionEventCallback.mdx) | + +## Returns + +`T` + +## Defined in + +testplane-docs/.testplane/src/types/index.ts:193 diff --git a/docs/api-reference/type-aliases/SyncSessionEventCallback.mdx b/docs/api-reference/type-aliases/SyncSessionEventCallback.mdx new file mode 100644 index 0000000..e1a6093 --- /dev/null +++ b/docs/api-reference/type-aliases/SyncSessionEventCallback.mdx @@ -0,0 +1,24 @@ +[testplane](../README.mdx) / SyncSessionEventCallback + +# Type Alias: SyncSessionEventCallback() + +```ts +type SyncSessionEventCallback: (browser, browserInfo) => void; +``` + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `browser` | `WebdriverIO.Browser` | +| `browserInfo` | `object` | +| `browserInfo.browserId` | `string` | +| `browserInfo.browserVersion` | `string` | + +## Returns + +`void` + +## Defined in + +testplane-docs/.testplane/src/types/index.ts:188 diff --git a/docs/api-reference/type-aliases/WorkerEventHandler.mdx b/docs/api-reference/type-aliases/WorkerEventHandler.mdx new file mode 100644 index 0000000..85b36df --- /dev/null +++ b/docs/api-reference/type-aliases/WorkerEventHandler.mdx @@ -0,0 +1,83 @@ +[testplane](../README.mdx) / WorkerEventHandler + +# Type Alias: WorkerEventHandler()\ + +```ts +type WorkerEventHandler: (event, callback) => T(event, callback) => T(event, callback) => T(event, callback) => T(event, callback) => T(event, callback) => T; +``` + +## Type Parameters + +| Type Parameter | +| ------ | +| `T` *extends* `BaseTestplane` | + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `event` | `"init"` | +| `callback` | () => `void` \| `Promise`\<`void`\> | + +## Returns + +`T` + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `event` | `"beforeFileRead"` | +| `callback` | (`data`) => `void` | + +## Returns + +`T` + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `event` | `"afterFileRead"` | +| `callback` | (`data`) => `void` | + +## Returns + +`T` + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `event` | `"afterTestsRead"` | +| `callback` | (`collection`) => `void` | + +## Returns + +`T` + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `event` | `"updateReference"` | +| `callback` | (`data`) => `void` | + +## Returns + +`T` + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `event` | `"newBrowser"` | +| `callback` | [`SyncSessionEventCallback`](SyncSessionEventCallback.mdx) | + +## Returns + +`T` + +## Defined in + +testplane-docs/.testplane/src/types/index.ts:225 diff --git a/docs/api-reference/variables/Key.mdx b/docs/api-reference/variables/Key.mdx new file mode 100644 index 0000000..3b6c37f --- /dev/null +++ b/docs/api-reference/variables/Key.mdx @@ -0,0 +1,131 @@ +[testplane](../README.mdx) / Key + +# Variable: Key + +```ts +const Key: { + Add: ""; + Alt: ""; + ArrowDown: ""; + ArrowLeft: ""; + ArrowRight: ""; + ArrowUp: ""; + Backspace: ""; + Cancel: ""; + Clear: ""; + Command: ""; + Control: ""; + Ctrl: "WDIO_CONTROL"; + Decimal: ""; + Delete: ""; + Divide: ""; + End: ""; + Enter: ""; + Equals: ""; + Escape: ""; + F1: ""; + F10: ""; + F11: ""; + F12: ""; + F2: ""; + F3: ""; + F4: ""; + F5: ""; + F6: ""; + F7: ""; + F8: ""; + F9: ""; + Help: ""; + Home: ""; + Insert: ""; + Multiply: ""; + NULL: ""; + Numpad0: ""; + Numpad1: ""; + Numpad2: ""; + Numpad3: ""; + Numpad4: ""; + Numpad5: ""; + Numpad6: ""; + Numpad7: ""; + Numpad8: ""; + Numpad9: ""; + PageDown: ""; + PageUp: ""; + Pause: ""; + Return: ""; + Semicolon: ""; + Separator: ""; + Shift: ""; + Space: ""; + Subtract: ""; + Tab: ""; + ZenkakuHankaku: ""; +}; +``` + +## Type declaration + +| Name | Type | Defined in | +| ------ | ------ | ------ | +| `Add` | `""` | testplane/node\_modules/webdriverio/build/index.d.ts:45 | +| `Alt` | `""` | testplane/node\_modules/webdriverio/build/index.d.ts:18 | +| `ArrowDown` | `""` | testplane/node\_modules/webdriverio/build/index.d.ts:29 | +| `ArrowLeft` | `""` | testplane/node\_modules/webdriverio/build/index.d.ts:26 | +| `ArrowRight` | `""` | testplane/node\_modules/webdriverio/build/index.d.ts:28 | +| `ArrowUp` | `""` | testplane/node\_modules/webdriverio/build/index.d.ts:27 | +| `Backspace` | `""` | testplane/node\_modules/webdriverio/build/index.d.ts:11 | +| `Cancel` | `""` | testplane/node\_modules/webdriverio/build/index.d.ts:9 | +| `Clear` | `""` | testplane/node\_modules/webdriverio/build/index.d.ts:13 | +| `Command` | `""` | testplane/node\_modules/webdriverio/build/index.d.ts:62 | +| `Control` | `""` | testplane/node\_modules/webdriverio/build/index.d.ts:17 | +| `Ctrl` | `"WDIO_CONTROL"` | testplane/node\_modules/webdriverio/build/index.d.ts:7 | +| `Decimal` | `""` | testplane/node\_modules/webdriverio/build/index.d.ts:48 | +| `Delete` | `""` | testplane/node\_modules/webdriverio/build/index.d.ts:31 | +| `Divide` | `""` | testplane/node\_modules/webdriverio/build/index.d.ts:49 | +| `End` | `""` | testplane/node\_modules/webdriverio/build/index.d.ts:24 | +| `Enter` | `""` | testplane/node\_modules/webdriverio/build/index.d.ts:15 | +| `Equals` | `""` | testplane/node\_modules/webdriverio/build/index.d.ts:33 | +| `Escape` | `""` | testplane/node\_modules/webdriverio/build/index.d.ts:20 | +| `F1` | `""` | testplane/node\_modules/webdriverio/build/index.d.ts:50 | +| `F10` | `""` | testplane/node\_modules/webdriverio/build/index.d.ts:59 | +| `F11` | `""` | testplane/node\_modules/webdriverio/build/index.d.ts:60 | +| `F12` | `""` | testplane/node\_modules/webdriverio/build/index.d.ts:61 | +| `F2` | `""` | testplane/node\_modules/webdriverio/build/index.d.ts:51 | +| `F3` | `""` | testplane/node\_modules/webdriverio/build/index.d.ts:52 | +| `F4` | `""` | testplane/node\_modules/webdriverio/build/index.d.ts:53 | +| `F5` | `""` | testplane/node\_modules/webdriverio/build/index.d.ts:54 | +| `F6` | `""` | testplane/node\_modules/webdriverio/build/index.d.ts:55 | +| `F7` | `""` | testplane/node\_modules/webdriverio/build/index.d.ts:56 | +| `F8` | `""` | testplane/node\_modules/webdriverio/build/index.d.ts:57 | +| `F9` | `""` | testplane/node\_modules/webdriverio/build/index.d.ts:58 | +| `Help` | `""` | testplane/node\_modules/webdriverio/build/index.d.ts:10 | +| `Home` | `""` | testplane/node\_modules/webdriverio/build/index.d.ts:25 | +| `Insert` | `""` | testplane/node\_modules/webdriverio/build/index.d.ts:30 | +| `Multiply` | `""` | testplane/node\_modules/webdriverio/build/index.d.ts:44 | +| `NULL` | `""` | testplane/node\_modules/webdriverio/build/index.d.ts:8 | +| `Numpad0` | `""` | testplane/node\_modules/webdriverio/build/index.d.ts:34 | +| `Numpad1` | `""` | testplane/node\_modules/webdriverio/build/index.d.ts:35 | +| `Numpad2` | `""` | testplane/node\_modules/webdriverio/build/index.d.ts:36 | +| `Numpad3` | `""` | testplane/node\_modules/webdriverio/build/index.d.ts:37 | +| `Numpad4` | `""` | testplane/node\_modules/webdriverio/build/index.d.ts:38 | +| `Numpad5` | `""` | testplane/node\_modules/webdriverio/build/index.d.ts:39 | +| `Numpad6` | `""` | testplane/node\_modules/webdriverio/build/index.d.ts:40 | +| `Numpad7` | `""` | testplane/node\_modules/webdriverio/build/index.d.ts:41 | +| `Numpad8` | `""` | testplane/node\_modules/webdriverio/build/index.d.ts:42 | +| `Numpad9` | `""` | testplane/node\_modules/webdriverio/build/index.d.ts:43 | +| `PageDown` | `""` | testplane/node\_modules/webdriverio/build/index.d.ts:23 | +| `PageUp` | `""` | testplane/node\_modules/webdriverio/build/index.d.ts:22 | +| `Pause` | `""` | testplane/node\_modules/webdriverio/build/index.d.ts:19 | +| `Return` | `""` | testplane/node\_modules/webdriverio/build/index.d.ts:14 | +| `Semicolon` | `""` | testplane/node\_modules/webdriverio/build/index.d.ts:32 | +| `Separator` | `""` | testplane/node\_modules/webdriverio/build/index.d.ts:46 | +| `Shift` | `""` | testplane/node\_modules/webdriverio/build/index.d.ts:16 | +| `Space` | `""` | testplane/node\_modules/webdriverio/build/index.d.ts:21 | +| `Subtract` | `""` | testplane/node\_modules/webdriverio/build/index.d.ts:47 | +| `Tab` | `""` | testplane/node\_modules/webdriverio/build/index.d.ts:12 | +| `ZenkakuHankaku` | `""` | testplane/node\_modules/webdriverio/build/index.d.ts:63 | + +## Defined in + +testplane/node\_modules/webdriverio/build/index.d.ts:6 diff --git a/docusaurus.config.ts b/docusaurus.config.ts index 9bbe141..f4cf271 100644 --- a/docusaurus.config.ts +++ b/docusaurus.config.ts @@ -10,13 +10,13 @@ const config: Config = { favicon: "img/favicon.ico", // Set the production url of your site here - url: process.env.DOCUSAURUS_URL ?? "https://testplane.example.com", + url: process.env.DOCUSAURUS_URL ?? "https://kabir-ivan.github.io", // Set the // pathname under which your site is served // For GitHub pages deployment, it is often '//' baseUrl: process.env.DOCUSAURUS_BASE_URL ?? "/", // GitHub pages deployment config. - organizationName: "gemini-testing", + // organizationName: "gemini-testing", projectName: "testplane-docs", onBrokenLinks: "throw", diff --git a/exports/globalFunctions.json b/exports/globalFunctions.json new file mode 100644 index 0000000..9e26dfe --- /dev/null +++ b/exports/globalFunctions.json @@ -0,0 +1 @@ +{} \ No newline at end of file diff --git a/exports/testplane/node_modules/webdriverio/build/WdioBrowser.json b/exports/testplane/node_modules/webdriverio/build/WdioBrowser.json new file mode 100644 index 0000000..40fad90 --- /dev/null +++ b/exports/testplane/node_modules/webdriverio/build/WdioBrowser.json @@ -0,0 +1,8617 @@ +{ + "WdioBrowser": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@deprecated", + "content": [ + { + "kind": "text", + "text": "use " + }, + { + "kind": "code", + "text": "`WebdriverIO.Browser`" + }, + { + "kind": "text", + "text": " instead" + } + ] + } + ], + "modifierTags": {}, + "summary": [] + }, + "properties": { + "sessionId": { + "comment": { + "blockTags": [], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Session id for the current running session" + } + ] + } + }, + "capabilities": { + "comment": { + "blockTags": [], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Applied capabilities used in the current session. Note: these can differ from the actual\nrequested capabilities if the remote end couldn't provide an exact match." + } + ] + } + }, + "requestedCapabilities": { + "comment": { + "blockTags": [], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Requested capabilities defined in the config object." + } + ] + } + }, + "options": { + "comment": { + "blockTags": [], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Applied WebdriverIO options (options that aren't officially part of WebdriverIO are stripped\nout of this object)." + } + ] + } + }, + "puppeteer": { + "comment": { + "blockTags": [], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Puppeteer instance" + } + ] + } + } + }, + "methods": { + "addListener": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@since", + "content": [ + { + "kind": "text", + "text": "v0.1.26" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Alias for " + }, + { + "kind": "code", + "text": "`emitter.on(eventName, listener)`" + }, + { + "kind": "text", + "text": "." + } + ] + } + }, + "removeListener": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@since", + "content": [ + { + "kind": "text", + "text": "v0.1.26" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Removes the specified " + }, + { + "kind": "code", + "text": "`listener`" + }, + { + "kind": "text", + "text": " from the listener array for the event named" + }, + { + "kind": "code", + "text": "`eventName`" + }, + { + "kind": "text", + "text": ".\n\n" + }, + { + "kind": "code", + "text": "```js\nconst callback = (stream) => {\n console.log('someone connected!');\n};\nserver.on('connection', callback);\n// ...\nserver.removeListener('connection', callback);\n```" + }, + { + "kind": "text", + "text": "\n\n" + }, + { + "kind": "code", + "text": "`removeListener()`" + }, + { + "kind": "text", + "text": " will remove, at most, one instance of a listener from the\nlistener array. If any single listener has been added multiple times to the\nlistener array for the specified " + }, + { + "kind": "code", + "text": "`eventName`" + }, + { + "kind": "text", + "text": ", then " + }, + { + "kind": "code", + "text": "`removeListener()`" + }, + { + "kind": "text", + "text": " must be\ncalled multiple times to remove each instance.\n\nOnce an event is emitted, all listeners attached to it at the\ntime of emitting are called in order. This implies that any" + }, + { + "kind": "code", + "text": "`removeListener()`" + }, + { + "kind": "text", + "text": " or " + }, + { + "kind": "code", + "text": "`removeAllListeners()`" + }, + { + "kind": "text", + "text": " calls _after_ emitting and _before_ the last listener finishes execution\nwill not remove them from" + }, + { + "kind": "code", + "text": "`emit()`" + }, + { + "kind": "text", + "text": " in progress. Subsequent events behave as expected.\n\n" + }, + { + "kind": "code", + "text": "```js\nconst myEmitter = new MyEmitter();\n\nconst callbackA = () => {\n console.log('A');\n myEmitter.removeListener('event', callbackB);\n};\n\nconst callbackB = () => {\n console.log('B');\n};\n\nmyEmitter.on('event', callbackA);\n\nmyEmitter.on('event', callbackB);\n\n// callbackA removes listener callbackB but it will still be called.\n// Internal listener array at time of emit [callbackA, callbackB]\nmyEmitter.emit('event');\n// Prints:\n// A\n// B\n\n// callbackB is now removed.\n// Internal listener array [callbackA]\nmyEmitter.emit('event');\n// Prints:\n// A\n```" + }, + { + "kind": "text", + "text": "\n\nBecause listeners are managed using an internal array, calling this will\nchange the position indices of any listener registered _after_ the listener\nbeing removed. This will not impact the order in which listeners are called,\nbut it means that any copies of the listener array as returned by\nthe " + }, + { + "kind": "code", + "text": "`emitter.listeners()`" + }, + { + "kind": "text", + "text": " method will need to be recreated.\n\nWhen a single function has been added as a handler multiple times for a single\nevent (as in the example below), " + }, + { + "kind": "code", + "text": "`removeListener()`" + }, + { + "kind": "text", + "text": " will remove the most\nrecently added instance. In the example the " + }, + { + "kind": "code", + "text": "`once('ping')`" + }, + { + "kind": "text", + "text": "listener is removed:\n\n" + }, + { + "kind": "code", + "text": "```js\nconst ee = new EventEmitter();\n\nfunction pong() {\n console.log('pong');\n}\n\nee.on('ping', pong);\nee.once('ping', pong);\nee.removeListener('ping', pong);\n\nee.emit('ping');\nee.emit('ping');\n```" + }, + { + "kind": "text", + "text": "\n\nReturns a reference to the " + }, + { + "kind": "code", + "text": "`EventEmitter`" + }, + { + "kind": "text", + "text": ", so that calls can be chained." + } + ] + } + }, + "off": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@since", + "content": [ + { + "kind": "text", + "text": "v10.0.0" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Alias for " + }, + { + "kind": "code", + "text": "`emitter.removeListener()`" + }, + { + "kind": "text", + "text": "." + } + ] + } + }, + "removeAllListeners": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@since", + "content": [ + { + "kind": "text", + "text": "v0.1.26" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Removes all listeners, or those of the specified " + }, + { + "kind": "code", + "text": "`eventName`" + }, + { + "kind": "text", + "text": ".\n\nIt is bad practice to remove listeners added elsewhere in the code,\nparticularly when the " + }, + { + "kind": "code", + "text": "`EventEmitter`" + }, + { + "kind": "text", + "text": " instance was created by some other\ncomponent or module (e.g. sockets or file streams).\n\nReturns a reference to the " + }, + { + "kind": "code", + "text": "`EventEmitter`" + }, + { + "kind": "text", + "text": ", so that calls can be chained." + } + ] + } + }, + "setMaxListeners": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@since", + "content": [ + { + "kind": "text", + "text": "v0.3.5" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "By default " + }, + { + "kind": "code", + "text": "`EventEmitter`" + }, + { + "kind": "text", + "text": "s will print a warning if more than " + }, + { + "kind": "code", + "text": "`10`" + }, + { + "kind": "text", + "text": " listeners are\nadded for a particular event. This is a useful default that helps finding\nmemory leaks. The " + }, + { + "kind": "code", + "text": "`emitter.setMaxListeners()`" + }, + { + "kind": "text", + "text": " method allows the limit to be\nmodified for this specific " + }, + { + "kind": "code", + "text": "`EventEmitter`" + }, + { + "kind": "text", + "text": " instance. The value can be set to" + }, + { + "kind": "code", + "text": "`Infinity`" + }, + { + "kind": "text", + "text": " (or " + }, + { + "kind": "code", + "text": "`0`" + }, + { + "kind": "text", + "text": ") to indicate an unlimited number of listeners.\n\nReturns a reference to the " + }, + { + "kind": "code", + "text": "`EventEmitter`" + }, + { + "kind": "text", + "text": ", so that calls can be chained." + } + ] + } + }, + "getMaxListeners": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@since", + "content": [ + { + "kind": "text", + "text": "v1.0.0" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Returns the current max listener value for the " + }, + { + "kind": "code", + "text": "`EventEmitter`" + }, + { + "kind": "text", + "text": " which is either\nset by " + }, + { + "kind": "code", + "text": "`emitter.setMaxListeners(n)`" + }, + { + "kind": "text", + "text": " or defaults to " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "defaultMaxListeners" + }, + { + "kind": "text", + "text": "." + } + ] + } + }, + "listeners": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@since", + "content": [ + { + "kind": "text", + "text": "v0.1.26" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Returns a copy of the array of listeners for the event named " + }, + { + "kind": "code", + "text": "`eventName`" + }, + { + "kind": "text", + "text": ".\n\n" + }, + { + "kind": "code", + "text": "```js\nserver.on('connection', (stream) => {\n console.log('someone connected!');\n});\nconsole.log(util.inspect(server.listeners('connection')));\n// Prints: [ [Function] ]\n```" + } + ] + } + }, + "rawListeners": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@since", + "content": [ + { + "kind": "text", + "text": "v9.4.0" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Returns a copy of the array of listeners for the event named " + }, + { + "kind": "code", + "text": "`eventName`" + }, + { + "kind": "text", + "text": ",\nincluding any wrappers (such as those created by " + }, + { + "kind": "code", + "text": "`.once()`" + }, + { + "kind": "text", + "text": ").\n\n" + }, + { + "kind": "code", + "text": "```js\nconst emitter = new EventEmitter();\nemitter.once('log', () => console.log('log once'));\n\n// Returns a new Array with a function `onceWrapper` which has a property\n// `listener` which contains the original listener bound above\nconst listeners = emitter.rawListeners('log');\nconst logFnWrapper = listeners[0];\n\n// Logs \"log once\" to the console and does not unbind the `once` event\nlogFnWrapper.listener();\n\n// Logs \"log once\" to the console and removes the listener\nlogFnWrapper();\n\nemitter.on('log', () => console.log('log persistently'));\n// Will return a new Array with a single function bound by `.on()` above\nconst newListeners = emitter.rawListeners('log');\n\n// Logs \"log persistently\" twice\nnewListeners[0]();\nemitter.emit('log');\n```" + } + ] + } + }, + "emit": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@since", + "content": [ + { + "kind": "text", + "text": "v0.1.26" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Synchronously calls each of the listeners registered for the event named" + }, + { + "kind": "code", + "text": "`eventName`" + }, + { + "kind": "text", + "text": ", in the order they were registered, passing the supplied arguments\nto each.\n\nReturns " + }, + { + "kind": "code", + "text": "`true`" + }, + { + "kind": "text", + "text": " if the event had listeners, " + }, + { + "kind": "code", + "text": "`false`" + }, + { + "kind": "text", + "text": " otherwise.\n\n" + }, + { + "kind": "code", + "text": "```js\nconst EventEmitter = require('events');\nconst myEmitter = new EventEmitter();\n\n// First listener\nmyEmitter.on('event', function firstListener() {\n console.log('Helloooo! first listener');\n});\n// Second listener\nmyEmitter.on('event', function secondListener(arg1, arg2) {\n console.log(`event with parameters ${arg1}, ${arg2} in second listener`);\n});\n// Third listener\nmyEmitter.on('event', function thirdListener(...args) {\n const parameters = args.join(', ');\n console.log(`event with parameters ${parameters} in third listener`);\n});\n\nconsole.log(myEmitter.listeners('event'));\n\nmyEmitter.emit('event', 1, 2, 3, 4, 5);\n\n// Prints:\n// [\n// [Function: firstListener],\n// [Function: secondListener],\n// [Function: thirdListener]\n// ]\n// Helloooo! first listener\n// event with parameters 1, 2 in second listener\n// event with parameters 1, 2, 3, 4, 5 in third listener\n```" + } + ] + } + }, + "listenerCount": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@since", + "content": [ + { + "kind": "text", + "text": "v3.2.0" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Returns the number of listeners listening to the event named " + }, + { + "kind": "code", + "text": "`eventName`" + }, + { + "kind": "text", + "text": ".\n\nIf " + }, + { + "kind": "code", + "text": "`listener`" + }, + { + "kind": "text", + "text": " is provided, it will return how many times the listener\nis found in the list of the listeners of the event." + } + ] + } + }, + "prependListener": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@since", + "content": [ + { + "kind": "text", + "text": "v6.0.0" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Adds the " + }, + { + "kind": "code", + "text": "`listener`" + }, + { + "kind": "text", + "text": " function to the _beginning_ of the listeners array for the\nevent named " + }, + { + "kind": "code", + "text": "`eventName`" + }, + { + "kind": "text", + "text": ". No checks are made to see if the " + }, + { + "kind": "code", + "text": "`listener`" + }, + { + "kind": "text", + "text": " has\nalready been added. Multiple calls passing the same combination of " + }, + { + "kind": "code", + "text": "`eventName`" + }, + { + "kind": "text", + "text": "and " + }, + { + "kind": "code", + "text": "`listener`" + }, + { + "kind": "text", + "text": " will result in the " + }, + { + "kind": "code", + "text": "`listener`" + }, + { + "kind": "text", + "text": " being added, and called, multiple\ntimes.\n\n" + }, + { + "kind": "code", + "text": "```js\nserver.prependListener('connection', (stream) => {\n console.log('someone connected!');\n});\n```" + }, + { + "kind": "text", + "text": "\n\nReturns a reference to the " + }, + { + "kind": "code", + "text": "`EventEmitter`" + }, + { + "kind": "text", + "text": ", so that calls can be chained." + } + ] + } + }, + "prependOnceListener": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@since", + "content": [ + { + "kind": "text", + "text": "v6.0.0" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Adds a **one-time**" + }, + { + "kind": "code", + "text": "`listener`" + }, + { + "kind": "text", + "text": " function for the event named " + }, + { + "kind": "code", + "text": "`eventName`" + }, + { + "kind": "text", + "text": " to the _beginning_ of the listeners array. The next time " + }, + { + "kind": "code", + "text": "`eventName`" + }, + { + "kind": "text", + "text": " is triggered, this\nlistener is removed, and then invoked.\n\n" + }, + { + "kind": "code", + "text": "```js\nserver.prependOnceListener('connection', (stream) => {\n console.log('Ah, we have our first user!');\n});\n```" + }, + { + "kind": "text", + "text": "\n\nReturns a reference to the " + }, + { + "kind": "code", + "text": "`EventEmitter`" + }, + { + "kind": "text", + "text": ", so that calls can be chained." + } + ] + } + }, + "eventNames": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@since", + "content": [ + { + "kind": "text", + "text": "v6.0.0" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Returns an array listing the events for which the emitter has registered\nlisteners. The values in the array are strings or " + }, + { + "kind": "code", + "text": "`Symbol`" + }, + { + "kind": "text", + "text": "s.\n\n" + }, + { + "kind": "code", + "text": "```js\nconst EventEmitter = require('events');\nconst myEE = new EventEmitter();\nmyEE.on('foo', () => {});\nmyEE.on('bar', () => {});\n\nconst sym = Symbol('symbol');\nmyEE.on(sym, () => {});\n\nconsole.log(myEE.eventNames());\n// Prints: [ 'foo', 'bar', Symbol(symbol) ]\n```" + } + ] + } + }, + "addCommand": { + "comment": { + "blockTags": [], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "add command to " + }, + { + "kind": "code", + "text": "`browser`" + }, + { + "kind": "text", + "text": " or " + }, + { + "kind": "code", + "text": "`element`" + }, + { + "kind": "text", + "text": " scope" + } + ] + } + }, + "overwriteCommand": { + "comment": { + "blockTags": [], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "overwrite " + }, + { + "kind": "code", + "text": "`browser`" + }, + { + "kind": "text", + "text": " or " + }, + { + "kind": "code", + "text": "`element`" + }, + { + "kind": "text", + "text": " command" + } + ] + } + }, + "addLocatorStrategy": { + "comment": { + "blockTags": [], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "create custom selector" + } + ] + } + }, + "sessionStatus": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@url", + "content": [ + { + "kind": "text", + "text": "https://w3c.github.io/webdriver-bidi/#command-session-status" + } + ] + }, + { + "skipRendering": false, + "tag": "@returns", + "content": [ + { + "kind": "code", + "text": "`Promise`" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "WebDriver Bidi command to send command method \"session.status\" with parameters." + } + ] + } + }, + "sessionNew": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@url", + "content": [ + { + "kind": "text", + "text": "https://w3c.github.io/webdriver-bidi/#command-session-new" + } + ] + }, + { + "skipRendering": false, + "tag": "@returns", + "content": [ + { + "kind": "code", + "text": "`Promise`" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "WebDriver Bidi command to send command method \"session.new\" with parameters." + } + ] + } + }, + "sessionEnd": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@url", + "content": [ + { + "kind": "text", + "text": "https://w3c.github.io/webdriver-bidi/#command-session-end" + } + ] + }, + { + "skipRendering": false, + "tag": "@returns", + "content": [ + { + "kind": "code", + "text": "`Promise`" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "WebDriver Bidi command to send command method \"session.end\" with parameters." + } + ] + } + }, + "sessionSubscribe": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@url", + "content": [ + { + "kind": "text", + "text": "https://w3c.github.io/webdriver-bidi/#command-session-subscribe" + } + ] + }, + { + "skipRendering": false, + "tag": "@returns", + "content": [ + { + "kind": "code", + "text": "`Promise`" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "WebDriver Bidi command to send command method \"session.subscribe\" with parameters." + } + ] + } + }, + "sessionUnsubscribe": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@url", + "content": [ + { + "kind": "text", + "text": "https://w3c.github.io/webdriver-bidi/#command-session-unsubscribe" + } + ] + }, + { + "skipRendering": false, + "tag": "@returns", + "content": [ + { + "kind": "code", + "text": "`Promise`" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "WebDriver Bidi command to send command method \"session.unsubscribe\" with parameters." + } + ] + } + }, + "browserClose": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@url", + "content": [ + { + "kind": "text", + "text": "https://w3c.github.io/webdriver-bidi/#command-browser-close" + } + ] + }, + { + "skipRendering": false, + "tag": "@returns", + "content": [ + { + "kind": "code", + "text": "`Promise`" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "WebDriver Bidi command to send command method \"browser.close\" with parameters." + } + ] + } + }, + "browsingContextActivate": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@url", + "content": [ + { + "kind": "text", + "text": "https://w3c.github.io/webdriver-bidi/#command-browsingContext-activate" + } + ] + }, + { + "skipRendering": false, + "tag": "@returns", + "content": [ + { + "kind": "code", + "text": "`Promise`" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "WebDriver Bidi command to send command method \"browsingContext.activate\" with parameters." + } + ] + } + }, + "browsingContextCaptureScreenshot": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@url", + "content": [ + { + "kind": "text", + "text": "https://w3c.github.io/webdriver-bidi/#command-browsingContext-captureScreenshot" + } + ] + }, + { + "skipRendering": false, + "tag": "@returns", + "content": [ + { + "kind": "code", + "text": "`Promise`" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "WebDriver Bidi command to send command method \"browsingContext.captureScreenshot\" with parameters." + } + ] + } + }, + "browsingContextClose": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@url", + "content": [ + { + "kind": "text", + "text": "https://w3c.github.io/webdriver-bidi/#command-browsingContext-close" + } + ] + }, + { + "skipRendering": false, + "tag": "@returns", + "content": [ + { + "kind": "code", + "text": "`Promise`" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "WebDriver Bidi command to send command method \"browsingContext.close\" with parameters." + } + ] + } + }, + "browsingContextCreate": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@url", + "content": [ + { + "kind": "text", + "text": "https://w3c.github.io/webdriver-bidi/#command-browsingContext-create" + } + ] + }, + { + "skipRendering": false, + "tag": "@returns", + "content": [ + { + "kind": "code", + "text": "`Promise`" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "WebDriver Bidi command to send command method \"browsingContext.create\" with parameters." + } + ] + } + }, + "browsingContextGetTree": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@url", + "content": [ + { + "kind": "text", + "text": "https://w3c.github.io/webdriver-bidi/#command-browsingContext-getTree" + } + ] + }, + { + "skipRendering": false, + "tag": "@returns", + "content": [ + { + "kind": "code", + "text": "`Promise`" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "WebDriver Bidi command to send command method \"browsingContext.getTree\" with parameters." + } + ] + } + }, + "browsingContextHandleUserPrompt": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@url", + "content": [ + { + "kind": "text", + "text": "https://w3c.github.io/webdriver-bidi/#command-browsingContext-handleUserPrompt" + } + ] + }, + { + "skipRendering": false, + "tag": "@returns", + "content": [ + { + "kind": "code", + "text": "`Promise`" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "WebDriver Bidi command to send command method \"browsingContext.handleUserPrompt\" with parameters." + } + ] + } + }, + "browsingContextLocateNodes": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@url", + "content": [ + { + "kind": "text", + "text": "https://w3c.github.io/webdriver-bidi/#command-browsingContext-locateNodes" + } + ] + }, + { + "skipRendering": false, + "tag": "@returns", + "content": [ + { + "kind": "code", + "text": "`Promise`" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "WebDriver Bidi command to send command method \"browsingContext.locateNodes\" with parameters." + } + ] + } + }, + "browsingContextNavigate": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@url", + "content": [ + { + "kind": "text", + "text": "https://w3c.github.io/webdriver-bidi/#command-browsingContext-navigate" + } + ] + }, + { + "skipRendering": false, + "tag": "@returns", + "content": [ + { + "kind": "code", + "text": "`Promise`" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "WebDriver Bidi command to send command method \"browsingContext.navigate\" with parameters." + } + ] + } + }, + "browsingContextPrint": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@url", + "content": [ + { + "kind": "text", + "text": "https://w3c.github.io/webdriver-bidi/#command-browsingContext-print" + } + ] + }, + { + "skipRendering": false, + "tag": "@returns", + "content": [ + { + "kind": "code", + "text": "`Promise`" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "WebDriver Bidi command to send command method \"browsingContext.print\" with parameters." + } + ] + } + }, + "browsingContextReload": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@url", + "content": [ + { + "kind": "text", + "text": "https://w3c.github.io/webdriver-bidi/#command-browsingContext-reload" + } + ] + }, + { + "skipRendering": false, + "tag": "@returns", + "content": [ + { + "kind": "code", + "text": "`Promise`" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "WebDriver Bidi command to send command method \"browsingContext.reload\" with parameters." + } + ] + } + }, + "browsingContextSetViewport": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@url", + "content": [ + { + "kind": "text", + "text": "https://w3c.github.io/webdriver-bidi/#command-browsingContext-setViewport" + } + ] + }, + { + "skipRendering": false, + "tag": "@returns", + "content": [ + { + "kind": "code", + "text": "`Promise`" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "WebDriver Bidi command to send command method \"browsingContext.setViewport\" with parameters." + } + ] + } + }, + "browsingContextTraverseHistory": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@url", + "content": [ + { + "kind": "text", + "text": "https://w3c.github.io/webdriver-bidi/#command-browsingContext-traverseHistory" + } + ] + }, + { + "skipRendering": false, + "tag": "@returns", + "content": [ + { + "kind": "code", + "text": "`Promise`" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "WebDriver Bidi command to send command method \"browsingContext.traverseHistory\" with parameters." + } + ] + } + }, + "networkAddIntercept": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@url", + "content": [ + { + "kind": "text", + "text": "https://w3c.github.io/webdriver-bidi/#command-network-addIntercept" + } + ] + }, + { + "skipRendering": false, + "tag": "@returns", + "content": [ + { + "kind": "code", + "text": "`Promise`" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "WebDriver Bidi command to send command method \"network.addIntercept\" with parameters." + } + ] + } + }, + "networkContinueRequest": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@url", + "content": [ + { + "kind": "text", + "text": "https://w3c.github.io/webdriver-bidi/#command-network-continueRequest" + } + ] + }, + { + "skipRendering": false, + "tag": "@returns", + "content": [ + { + "kind": "code", + "text": "`Promise`" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "WebDriver Bidi command to send command method \"network.continueRequest\" with parameters." + } + ] + } + }, + "networkContinueResponse": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@url", + "content": [ + { + "kind": "text", + "text": "https://w3c.github.io/webdriver-bidi/#command-network-continueResponse" + } + ] + }, + { + "skipRendering": false, + "tag": "@returns", + "content": [ + { + "kind": "code", + "text": "`Promise`" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "WebDriver Bidi command to send command method \"network.continueResponse\" with parameters." + } + ] + } + }, + "networkContinueWithAuth": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@url", + "content": [ + { + "kind": "text", + "text": "https://w3c.github.io/webdriver-bidi/#command-network-continueWithAuth" + } + ] + }, + { + "skipRendering": false, + "tag": "@returns", + "content": [ + { + "kind": "code", + "text": "`Promise`" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "WebDriver Bidi command to send command method \"network.continueWithAuth\" with parameters." + } + ] + } + }, + "networkFailRequest": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@url", + "content": [ + { + "kind": "text", + "text": "https://w3c.github.io/webdriver-bidi/#command-network-failRequest" + } + ] + }, + { + "skipRendering": false, + "tag": "@returns", + "content": [ + { + "kind": "code", + "text": "`Promise`" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "WebDriver Bidi command to send command method \"network.failRequest\" with parameters." + } + ] + } + }, + "networkProvideResponse": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@url", + "content": [ + { + "kind": "text", + "text": "https://w3c.github.io/webdriver-bidi/#command-network-provideResponse" + } + ] + }, + { + "skipRendering": false, + "tag": "@returns", + "content": [ + { + "kind": "code", + "text": "`Promise`" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "WebDriver Bidi command to send command method \"network.provideResponse\" with parameters." + } + ] + } + }, + "networkRemoveIntercept": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@url", + "content": [ + { + "kind": "text", + "text": "https://w3c.github.io/webdriver-bidi/#command-network-removeIntercept" + } + ] + }, + { + "skipRendering": false, + "tag": "@returns", + "content": [ + { + "kind": "code", + "text": "`Promise`" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "WebDriver Bidi command to send command method \"network.removeIntercept\" with parameters." + } + ] + } + }, + "scriptAddPreloadScript": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@url", + "content": [ + { + "kind": "text", + "text": "https://w3c.github.io/webdriver-bidi/#command-script-addPreloadScript" + } + ] + }, + { + "skipRendering": false, + "tag": "@returns", + "content": [ + { + "kind": "code", + "text": "`Promise`" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "WebDriver Bidi command to send command method \"script.addPreloadScript\" with parameters." + } + ] + } + }, + "scriptDisown": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@url", + "content": [ + { + "kind": "text", + "text": "https://w3c.github.io/webdriver-bidi/#command-script-disown" + } + ] + }, + { + "skipRendering": false, + "tag": "@returns", + "content": [ + { + "kind": "code", + "text": "`Promise`" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "WebDriver Bidi command to send command method \"script.disown\" with parameters." + } + ] + } + }, + "scriptCallFunction": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@url", + "content": [ + { + "kind": "text", + "text": "https://w3c.github.io/webdriver-bidi/#command-script-callFunction" + } + ] + }, + { + "skipRendering": false, + "tag": "@returns", + "content": [ + { + "kind": "code", + "text": "`Promise`" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "WebDriver Bidi command to send command method \"script.callFunction\" with parameters." + } + ] + } + }, + "scriptEvaluate": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@url", + "content": [ + { + "kind": "text", + "text": "https://w3c.github.io/webdriver-bidi/#command-script-evaluate" + } + ] + }, + { + "skipRendering": false, + "tag": "@returns", + "content": [ + { + "kind": "code", + "text": "`Promise`" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "WebDriver Bidi command to send command method \"script.evaluate\" with parameters." + } + ] + } + }, + "scriptGetRealms": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@url", + "content": [ + { + "kind": "text", + "text": "https://w3c.github.io/webdriver-bidi/#command-script-getRealms" + } + ] + }, + { + "skipRendering": false, + "tag": "@returns", + "content": [ + { + "kind": "code", + "text": "`Promise`" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "WebDriver Bidi command to send command method \"script.getRealms\" with parameters." + } + ] + } + }, + "scriptRemovePreloadScript": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@url", + "content": [ + { + "kind": "text", + "text": "https://w3c.github.io/webdriver-bidi/#command-script-removePreloadScript" + } + ] + }, + { + "skipRendering": false, + "tag": "@returns", + "content": [ + { + "kind": "code", + "text": "`Promise`" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "WebDriver Bidi command to send command method \"script.removePreloadScript\" with parameters." + } + ] + } + }, + "inputPerformActions": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@url", + "content": [ + { + "kind": "text", + "text": "https://w3c.github.io/webdriver-bidi/#command-input-performActions" + } + ] + }, + { + "skipRendering": false, + "tag": "@returns", + "content": [ + { + "kind": "code", + "text": "`Promise`" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "WebDriver Bidi command to send command method \"input.performActions\" with parameters." + } + ] + } + }, + "inputReleaseActions": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@url", + "content": [ + { + "kind": "text", + "text": "https://w3c.github.io/webdriver-bidi/#command-input-releaseActions" + } + ] + }, + { + "skipRendering": false, + "tag": "@returns", + "content": [ + { + "kind": "code", + "text": "`Promise`" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "WebDriver Bidi command to send command method \"input.releaseActions\" with parameters." + } + ] + } + }, + "newSession": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://w3c.github.io/webdriver/#dfn-new-sessions" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Webdriver Protocol Command\n\nThe New Session command creates a new WebDriver session with the endpoint node. If the creation fails, a session not created error is returned." + } + ] + } + }, + "deleteSession": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://w3c.github.io/webdriver/#dfn-delete-session" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Webdriver Protocol Command\n\nThe Delete Session command closes any top-level browsing contexts associated with the current session, terminates the connection, and finally closes the current session." + } + ] + } + }, + "status": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://w3c.github.io/webdriver/#dfn-status" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Webdriver Protocol Command\n\nThe Status command returns information about whether a remote end is in a state in which it can create new sessions and can additionally include arbitrary meta information that is specific to the implementation." + } + ] + } + }, + "getTimeouts": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://w3c.github.io/webdriver/#dfn-get-timeouts" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Webdriver Protocol Command\n\nThe Get Timeouts command gets timeout durations associated with the current session." + } + ] + } + }, + "setTimeouts": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://w3c.github.io/webdriver/#dfn-set-timeouts" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Webdriver Protocol Command\n\nThe Set Timeouts command sets timeout durations associated with the current session. The timeouts that can be controlled are listed in the table of session timeouts below." + } + ] + } + }, + "getUrl": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://w3c.github.io/webdriver/#dfn-get-current-url" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Webdriver Protocol Command\n\nThe Get Current URL command returns the URL of the current top-level browsing context." + } + ] + } + }, + "navigateTo": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://w3c.github.io/webdriver/#dfn-navigate-to" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Webdriver Protocol Command\n\nThe navigateTo (go) command is used to cause the user agent to navigate the current top-level browsing context a new location." + } + ] + } + }, + "back": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://w3c.github.io/webdriver/#dfn-back" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Webdriver Protocol Command\n\nThe Back command causes the browser to traverse one step backward in the joint session history of the current top-level browsing context. This is equivalent to pressing the back button in the browser chrome or calling " + }, + { + "kind": "code", + "text": "`window.history.back`" + }, + { + "kind": "text", + "text": "." + } + ] + } + }, + "forward": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://w3c.github.io/webdriver/#dfn-forward" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Webdriver Protocol Command\n\nThe Forward command causes the browser to traverse one step forwards in the joint session history of the current top-level browsing context." + } + ] + } + }, + "refresh": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://w3c.github.io/webdriver/#dfn-refresh" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Webdriver Protocol Command\n\nThe Refresh command causes the browser to reload the page in current top-level browsing context." + } + ] + } + }, + "getTitle": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://w3c.github.io/webdriver/#dfn-get-title" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Webdriver Protocol Command\n\nThe Get Title command returns the document title of the current top-level browsing context, equivalent to calling " + }, + { + "kind": "code", + "text": "`document.title`" + }, + { + "kind": "text", + "text": "." + } + ] + } + }, + "getWindowHandle": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://w3c.github.io/webdriver/#dfn-get-window-handle" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Webdriver Protocol Command\n\nThe Get Window Handle command returns the window handle for the current top-level browsing context. It can be used as an argument to Switch To Window." + } + ] + } + }, + "closeWindow": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://w3c.github.io/webdriver/#dfn-close-window" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Webdriver Protocol Command\n\nThe Close Window command closes the current top-level browsing context. Once done, if there are no more top-level browsing contexts open, the WebDriver session itself is closed." + } + ] + } + }, + "switchToWindow": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://w3c.github.io/webdriver/#dfn-switch-to-window" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Webdriver Protocol Command\n\nThe Switch To Window command is used to select the current top-level browsing context for the current session, i.e. the one that will be used for processing commands." + } + ] + } + }, + "createWindow": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://w3c.github.io/webdriver/#new-window" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Webdriver Protocol Command\n\nCreate a new top-level browsing context." + } + ] + } + }, + "getWindowHandles": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://w3c.github.io/webdriver/#dfn-get-window-handles" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Webdriver Protocol Command\n\nThe Get Window Handles command returns a list of window handles for every open top-level browsing context. The order in which the window handles are returned is arbitrary." + } + ] + } + }, + "printPage": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://w3c.github.io/webdriver/#print-page" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Webdriver Protocol Command\n\nThe Print Page command renders the document to a paginated PDF document. __Note:__ Chrome currently only supports this in [headless mode](https://webdriver.io/docs/capabilities/#run-browser-headless), see [" + }, + { + "kind": "code", + "text": "`crbug753118`" + }, + { + "kind": "text", + "text": "](https://bugs.chromium.org/p/chromium/issues/detail?id=753118))." + } + ] + } + }, + "switchToFrame": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://w3c.github.io/webdriver/#dfn-switch-to-frame" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Webdriver Protocol Command\n\nThe Switch To Frame command is used to select the current top-level browsing context or a child browsing context of the current browsing context to use as the current browsing context for subsequent commands." + } + ] + } + }, + "switchToParentFrame": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://w3c.github.io/webdriver/#dfn-switch-to-parent-frame" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Webdriver Protocol Command\n\nThe Switch to Parent Frame command sets the current browsing context for future commands to the parent of the current browsing context." + } + ] + } + }, + "getWindowRect": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://w3c.github.io/webdriver/#dfn-get-window-rect" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Webdriver Protocol Command\n\nThe Get Window Rect command returns the size and position on the screen of the operating system window corresponding to the current top-level browsing context." + } + ] + } + }, + "setWindowRect": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://w3c.github.io/webdriver/#dfn-set-window-rect" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Webdriver Protocol Command\n\nThe Set Window Rect command alters the size and the position of the operating system window corresponding to the current top-level browsing context." + } + ] + } + }, + "maximizeWindow": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://w3c.github.io/webdriver/#dfn-maximize-window" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Webdriver Protocol Command\n\nThe Maximize Window command invokes the window manager-specific \"maximize\" operation, if any, on the window containing the current top-level browsing context. This typically increases the window to the maximum available size without going full-screen." + } + ] + } + }, + "minimizeWindow": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://w3c.github.io/webdriver/#dfn-minimize-window" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Webdriver Protocol Command\n\nThe Minimize Window command invokes the window manager-specific \"minimize\" operation, if any, on the window containing the current top-level browsing context. This typically hides the window in the system tray." + } + ] + } + }, + "fullscreenWindow": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://w3c.github.io/webdriver/#dfn-fullscreen-window" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Webdriver Protocol Command\n\nThe Fullscreen Window command invokes the window manager-specific “full screen” operation, if any, on the window containing the current top-level browsing context. This typically increases the window to the size of the physical display and can hide browser chrome elements such as toolbars." + } + ] + } + }, + "findElement": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://w3c.github.io/webdriver/#dfn-find-element" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Webdriver Protocol Command\n\nThe Find Element command is used to find an element in the current browsing context that can be used for future commands. This command returns JSON representation of the element that can be passed to $ command to transform the reference to an extended WebdriverIO element." + } + ] + } + }, + "findElementFromShadowRoot": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://w3c.github.io/webdriver/#find-element-from-shadow-root" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Webdriver Protocol Command\n\nThe Find Element From Shadow Root command is used to find an element within the shadow root of an element that can be used for future commands. This command returns JSON representation of the element that can be passed to $ command to transform the reference to an extended WebdriverIO element." + } + ] + } + }, + "findElements": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://w3c.github.io/webdriver/#dfn-find-elements" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Webdriver Protocol Command\n\nThe Find Elements command is used to find elements in the current browsing context that can be used for future commands. This command returns array of JSON representation of the elements that can be passed to $ command to transform the reference to an extended WebdriverIO element (See findElement)." + } + ] + } + }, + "findElementsFromShadowRoot": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://w3c.github.io/webdriver/#find-elements-from-shadow-root" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Webdriver Protocol Command\n\nThe Find Elements command is used to find elements within the shadow root of an element that can be used for future commands. This command returns array of JSON representation of the elements that can be passed to $ command to transform the reference to an extended WebdriverIO element (See findElement)." + } + ] + } + }, + "findElementFromElement": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://w3c.github.io/webdriver/#dfn-find-element-from-element" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Webdriver Protocol Command\n\nThe Find Element From Element command is used to find an element from a web element in the current browsing context that can be used for future commands. This command returns JSON representation of the element that can be passed to $ command to transform the reference to an extended WebdriverIO element (See findElement)." + } + ] + } + }, + "findElementsFromElement": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://w3c.github.io/webdriver/#dfn-find-elements-from-element" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Webdriver Protocol Command\n\nThe Find Elements From Element command is used to find elements from a web element in the current browsing context that can be used for future commands. This command returns array of JSON representation of the elements that can be passed to $ command to transform the reference to an extended WebdriverIO element (See findElement)." + } + ] + } + }, + "getElementShadowRoot": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://w3c.github.io/webdriver/#dfn-get-active-element" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Webdriver Protocol Command\n\nGet the shadow root object of an element. The result object can be used to fetch elements within this shadow root using e.g. findElementFromShadowRoots or findElementsFromShadowRoots." + } + ] + } + }, + "getActiveElement": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://w3c.github.io/webdriver/#dfn-get-active-element" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Webdriver Protocol Command\n\nGet Active Element returns the active element of the current browsing context’s document element. This command returns JSON representation of the element that can be passed to $ command to transform the reference to an extended WebdriverIO element (See findElement)." + } + ] + } + }, + "isElementSelected": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://w3c.github.io/webdriver/#dfn-is-element-selected" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Webdriver Protocol Command\n\nIs Element Selected determines if the referenced element is selected or not. This operation only makes sense on input elements of the Checkbox- and Radio Button states, or option elements." + } + ] + } + }, + "isElementDisplayed": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://w3c.github.io/webdriver/#element-displayedness" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Webdriver Protocol Command\n\nIs Element Displayed determines the visibility of an element which is guided by what is perceptually visible to the human eye. In this context, an element's displayedness does not relate to the " + }, + { + "kind": "code", + "text": "`visibility`" + }, + { + "kind": "text", + "text": " or " + }, + { + "kind": "code", + "text": "`display`" + }, + { + "kind": "text", + "text": " style properties." + } + ] + } + }, + "getElementAttribute": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://w3c.github.io/webdriver/#dfn-get-element-attribute" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Webdriver Protocol Command\n\nThe Get Element Attribute command will return the attribute of a web element." + } + ] + } + }, + "getElementProperty": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://w3c.github.io/webdriver/#dfn-get-element-property" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Webdriver Protocol Command\n\nThe Get Element Property command will return the result of getting a property of an element." + } + ] + } + }, + "getElementCSSValue": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://w3c.github.io/webdriver/#dfn-get-element-css-value" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Webdriver Protocol Command\n\nThe Get Element CSS Value command retrieves the computed value of the given CSS property of the given web element." + } + ] + } + }, + "getElementText": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://w3c.github.io/webdriver/#dfn-get-element-text" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Webdriver Protocol Command\n\nThe Get Element Text command intends to return an element’s text \"as rendered\". An element's rendered text is also used for locating a elements by their link text and partial link text." + } + ] + } + }, + "getElementTagName": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://w3c.github.io/webdriver/#dfn-get-element-tag-name" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Webdriver Protocol Command\n\nThe Get Element Tag Name command returns the qualified element name of the given web element." + } + ] + } + }, + "getElementRect": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://w3c.github.io/webdriver/#dfn-get-element-rect" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Webdriver Protocol Command\n\nThe Get Element Rect command returns the dimensions and coordinates of the given web element." + } + ] + } + }, + "isElementEnabled": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://w3c.github.io/webdriver/#dfn-is-element-enabled" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Webdriver Protocol Command\n\nIs Element Enabled determines if the referenced element is enabled or not. This operation only makes sense on form controls." + } + ] + } + }, + "elementClick": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://w3c.github.io/webdriver/#dfn-element-click" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Webdriver Protocol Command\n\nThe Element Click command scrolls into view the element if it is not already pointer-interactable, and clicks its in-view center point. If the element's center point is obscured by another element, an element click intercepted error is returned. If the element is outside the viewport, an element not interactable error is returned." + } + ] + } + }, + "elementClear": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://w3c.github.io/webdriver/#dfn-element-clear" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Webdriver Protocol Command\n\nThe Element Clear command scrolls into view an editable or resettable element and then attempts to clear its selected files or text content." + } + ] + } + }, + "elementSendKeys": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://w3c.github.io/webdriver/#dfn-element-send-keys" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Webdriver Protocol Command\n\nThe Element Send Keys command scrolls into view the form control element and then sends the provided keys to the element. In case the element is not keyboard-interactable, an element not interactable error is returned.

The key input state used for input may be cleared mid-way through \"typing\" by sending the null key, which is U+E000 (NULL)." + } + ] + } + }, + "getPageSource": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://w3c.github.io/webdriver/#dfn-get-page-source" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Webdriver Protocol Command\n\nThe Get Page Source command returns a string serialization of the DOM of the current browsing context active document." + } + ] + } + }, + "executeScript": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://w3c.github.io/webdriver/#dfn-execute-script" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Webdriver Protocol Command\n\nThe Execute Script command executes a JavaScript function in the context of the current browsing context and returns the return value of the function." + } + ] + } + }, + "executeAsyncScript": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://w3c.github.io/webdriver/#dfn-execute-async-script" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Webdriver Protocol Command\n\nThe Execute Async Script command causes JavaScript to execute as an anonymous function. Unlike the Execute Script command, the result of the function is ignored. Instead an additional argument is provided as the final argument to the function. This is a function that, when called, returns its first argument as the response." + } + ] + } + }, + "getAllCookies": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://w3c.github.io/webdriver/#dfn-get-all-cookies" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Webdriver Protocol Command\n\nThe Get All Cookies command returns all cookies associated with the address of the current browsing context’s active document." + } + ] + } + }, + "addCookie": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://w3c.github.io/webdriver/#dfn-adding-a-cookie" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Webdriver Protocol Command\n\nThe Add Cookie command adds a single cookie to the cookie store associated with the active document's address." + } + ] + } + }, + "deleteAllCookies": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://w3c.github.io/webdriver/#dfn-delete-all-cookies" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Webdriver Protocol Command\n\nThe Delete All Cookies command allows deletion of all cookies associated with the active document's address." + } + ] + } + }, + "getNamedCookie": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://w3c.github.io/webdriver/#dfn-get-named-cookie" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Webdriver Protocol Command\n\nThe Get Named Cookie command returns the cookie with the requested name from the associated cookies in the cookie store of the current browsing context's active document. If no cookie is found, a no such cookie error is returned." + } + ] + } + }, + "deleteCookie": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://w3c.github.io/webdriver/#dfn-delete-cookie" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Webdriver Protocol Command\n\nThe Delete Cookie command allows you to delete either a single cookie by parameter name, or all the cookies associated with the active document's address if name is undefined." + } + ] + } + }, + "performActions": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://w3c.github.io/webdriver/#dfn-perform-actions" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Webdriver Protocol Command\n\nThe Perform Actions command is used to execute complex user actions. See [spec](https://github.com/jlipps/simple-wd-spec#perform-actions) for more details." + } + ] + } + }, + "releaseActions": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://w3c.github.io/webdriver/#dfn-release-actions" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Webdriver Protocol Command\n\nThe Release Actions command is used to release all the keys and pointer buttons that are currently depressed. This causes events to be fired as if the state was released by an explicit series of actions. It also clears all the internal state of the virtual devices." + } + ] + } + }, + "dismissAlert": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://w3c.github.io/webdriver/#dfn-dismiss-alert" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Webdriver Protocol Command\n\nThe Dismiss Alert command dismisses a simple dialog if present, otherwise error. A request to dismiss an alert user prompt, which may not necessarily have a dismiss button, has the same effect as accepting it." + } + ] + } + }, + "acceptAlert": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://w3c.github.io/webdriver/#dfn-accept-alert" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Webdriver Protocol Command\n\nThe Accept Alert command accepts a simple dialog if present, otherwise error." + } + ] + } + }, + "getAlertText": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://w3c.github.io/webdriver/#dfn-get-alert-text" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Webdriver Protocol Command\n\nThe Get Alert Text command returns the message of the current user prompt. If there is no current user prompt, it returns an error." + } + ] + } + }, + "sendAlertText": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://w3c.github.io/webdriver/#dfn-send-alert-text" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Webdriver Protocol Command\n\nThe Send Alert Text command sets the text field of a window.prompt user prompt to the given value." + } + ] + } + }, + "takeScreenshot": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://w3c.github.io/webdriver/#dfn-take-screenshot" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Webdriver Protocol Command\n\nThe Take Screenshot command takes a screenshot of the top-level browsing context's viewport." + } + ] + } + }, + "takeElementScreenshot": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://w3c.github.io/webdriver/#dfn-take-element-screenshot" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Webdriver Protocol Command\n\nThe Take Element Screenshot command takes a screenshot of the visible region encompassed by the bounding rectangle of an element." + } + ] + } + }, + "getElementComputedRole": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://w3c.github.io/webdriver/#get-computed-role" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Webdriver Protocol Command\n\nGet the computed WAI-ARIA role of an element." + } + ] + } + }, + "getElementComputedLabel": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://w3c.github.io/webdriver/#get-computed-label" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Webdriver Protocol Command\n\nGet the accessible name of the element." + } + ] + } + }, + "setPermissions": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://w3c.github.io/permissions/#set-permission-command" + } + ] + }, + { + "skipRendering": false, + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```js\n// set midi permissions\nbrowser.setPermissions(\n { name: 'midi', sysex: true },\n 'granted' // can be also \"denied\" or \"prompt\"\n);\n```" + }, + { + "kind": "text", + "text": "*" + } + ] + }, + { + "skipRendering": false, + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```js\n// set clipboard permissions\nbrowser.setPermissions({ name: 'clipboard-read' }, 'granted');\n// now you can read the clipboard via, e.g.\nconst clipboardText = await browser.execute(() => navigator.clipboard.readText());\n```" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Webdriver Protocol Command\n\nSimulates user modification of a PermissionDescriptor's permission state. __Note:__ this feature has not landed in all browsers yet." + } + ] + } + }, + "generateTestReport": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://w3c.github.io/reporting/#automation" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Webdriver Protocol Command\n\nGenerates a report for testing. Extension for [Reporting API](https://developers.google.com/web/updates/2018/09/reportingapi). __Note:__ this feature has not landed in all browsers yet." + } + ] + } + }, + "createMockSensor": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://w3c.github.io/sensors/#create-mock-sensor-command" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Webdriver Protocol Command\n\nCreates a mock sensor to emulate sensors like Ambient Light Sensor. __Note:__ this feature has not landed in all browsers yet." + } + ] + } + }, + "getMockSensor": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://w3c.github.io/sensors/#get-mock-sensor-command" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Webdriver Protocol Command\n\nRetrieves information about a given type of mock sensor. __Note:__ this feature has not landed in all browsers yet." + } + ] + } + }, + "updateMockSensor": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://w3c.github.io/sensors/#update-mock-sensor-reading-command" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Webdriver Protocol Command\n\nUpdates the mock sensor type. __Note:__ this feature has not landed in all browsers yet." + } + ] + } + }, + "deleteMockSensor": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://w3c.github.io/sensors/#delete-mock-sensor-command" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Webdriver Protocol Command\n\nThe Delete Session command closes any top-level browsing contexts associated with the current session, terminates the connection, and finally closes the current session. __Note:__ this feature has not landed in all browsers yet." + } + ] + } + }, + "setTimeZone": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://w3c.github.io/sensors/#create-mock-sensor-command" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Webdriver Protocol Command\n\nSimulates the changing of a time zone for the purposes of testing. __Note:__ this feature has not landed in all browsers yet." + } + ] + } + }, + "addVirtualAuthenticator": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://www.w3.org/TR/webauthn-2/#sctn-automation-add-virtual-authenticator" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Webdriver Protocol Command\n\nCreates a software [Virtual Authenticator](https://www.w3.org/TR/webauthn-2/#virtual-authenticators)." + } + ] + } + }, + "removeVirtualAuthenticator": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://www.w3.org/TR/webauthn-2/#sctn-automation-remove-virtual-authenticator" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Webdriver Protocol Command\n\nRemoves a previously created Virtual Authenticator." + } + ] + } + }, + "addCredential": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://www.w3.org/TR/webauthn-2/#sctn-automation-add-credential" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Webdriver Protocol Command\n\nInjects a Public Key Credential Source into an existing Virtual Authenticator." + } + ] + } + }, + "getCredentials": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://www.w3.org/TR/webauthn-2/#sctn-automation-get-credentials" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Webdriver Protocol Command\n\nReturns one Credential Parameters object for every Public Key Credential Source stored in a Virtual Authenticator, regardless of whether they were stored using Add Credential or " + }, + { + "kind": "code", + "text": "`navigator.credentials.create()`" + }, + { + "kind": "text", + "text": "." + } + ] + } + }, + "removeAllCredentials": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://www.w3.org/TR/webauthn-2/#sctn-automation-remove-all-credentials" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Webdriver Protocol Command\n\nRemoves all Public Key Credential Sources stored on a Virtual Authenticator." + } + ] + } + }, + "removeCredential": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://www.w3.org/TR/webauthn-2/#sctn-automation-remove-credential" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Webdriver Protocol Command\n\nRemoves a Public Key Credential Source stored on a Virtual Authenticator." + } + ] + } + }, + "setUserVerified": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://www.w3.org/TR/webauthn-2/#sctn-automation-set-user-verified" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Webdriver Protocol Command\n\nThe Set User Verified extension command sets the isUserVerified property on the Virtual Authenticator." + } + ] + } + }, + "getSessions": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessions" + } + ] + }, + { + "skipRendering": false, + "tag": "@deprecated", + "content": [ + { + "kind": "text", + "text": "This command is deprecated and likely not supported by any browser." + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Jsonwp Protocol Command\n\nReturns a list of the currently active sessions. Each session will be returned as a list of JSON objects containing " + }, + { + "kind": "code", + "text": "`id`" + }, + { + "kind": "text", + "text": " and " + }, + { + "kind": "code", + "text": "`capabilities`" + }, + { + "kind": "text", + "text": "." + } + ] + } + }, + "getSession": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#get-sessionsessionid" + } + ] + }, + { + "skipRendering": false, + "tag": "@deprecated", + "content": [ + { + "kind": "text", + "text": "This command is deprecated and likely not supported by any browser." + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Jsonwp Protocol Command\n\nRetrieve the capabilities of the specified session." + } + ] + } + }, + "setAsyncTimeout": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidtimeoutsasync_script" + } + ] + }, + { + "skipRendering": false, + "tag": "@deprecated", + "content": [ + { + "kind": "text", + "text": "This command is deprecated and likely not supported by any browser. Use the \"setTimeouts\" command instead!" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Jsonwp Protocol Command\n\nSet the amount of time, in milliseconds, that asynchronous scripts executed by " + }, + { + "kind": "code", + "text": "`/session/:sessionId/execute_async`" + }, + { + "kind": "text", + "text": " are permitted to run before they are aborted and a " + }, + { + "kind": "code", + "text": "`Timeout`" + }, + { + "kind": "text", + "text": " error is returned to the client." + } + ] + } + }, + "setImplicitTimeout": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidtimeoutsimplicit_wait" + } + ] + }, + { + "skipRendering": false, + "tag": "@deprecated", + "content": [ + { + "kind": "text", + "text": "This command is deprecated and likely not supported by any browser. Use the \"setTimeouts\" command instead!" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Jsonwp Protocol Command\n\nSet the amount of time the driver should wait when searching for elements. When searching for a single element, the driver should poll the page until an element is found or the timeout expires, whichever occurs first. When searching for multiple elements, the driver should poll the page until at least one element is found or the timeout expires, at which point it should return an empty list. If this command is never sent, the driver should default to an implicit wait of 0ms." + } + ] + } + }, + "getWindowPosition": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#get-sessionsessionidwindowwindowhandleposition" + } + ] + }, + { + "skipRendering": false, + "tag": "@deprecated", + "content": [ + { + "kind": "text", + "text": "This command is deprecated and likely not supported by any browser." + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Jsonwp Protocol Command\n\nGet the position of the current focussed window." + } + ] + } + }, + "setWindowPosition": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#post-sessionsessionidwindowwindowhandleposition" + } + ] + }, + { + "skipRendering": false, + "tag": "@deprecated", + "content": [ + { + "kind": "text", + "text": "This command is deprecated and likely not supported by any browser." + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Jsonwp Protocol Command\n\nChange the position of the current focussed window." + } + ] + } + }, + "_getWindowSize": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#get-sessionsessionidwindowwindowhandlesize" + } + ] + }, + { + "skipRendering": false, + "tag": "@deprecated", + "content": [ + { + "kind": "text", + "text": "This command is deprecated and likely not supported by any browser." + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Jsonwp Protocol Command\n\nGet the size of the current focused window." + } + ] + } + }, + "_setWindowSize": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#post-sessionsessionidwindowwindowhandlesize" + } + ] + }, + { + "skipRendering": false, + "tag": "@deprecated", + "content": [ + { + "kind": "text", + "text": "This command is deprecated and likely not supported by any browser." + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Jsonwp Protocol Command\n\nChange the size of the current focused window." + } + ] + } + }, + "getElementLocation": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidelementidlocation" + } + ] + }, + { + "skipRendering": false, + "tag": "@deprecated", + "content": [ + { + "kind": "text", + "text": "This command is deprecated and likely not supported by any browser." + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Jsonwp Protocol Command\n\nDetermine an element's location on the page. The point " + }, + { + "kind": "code", + "text": "`(0, 0)`" + }, + { + "kind": "text", + "text": " refers to the upper-left corner of the page. The element's coordinates are returned as a JSON object with " + }, + { + "kind": "code", + "text": "`x`" + }, + { + "kind": "text", + "text": " and " + }, + { + "kind": "code", + "text": "`y`" + }, + { + "kind": "text", + "text": " properties." + } + ] + } + }, + "getElementLocationInView": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidelementidlocation_in_view" + } + ] + }, + { + "skipRendering": false, + "tag": "@deprecated", + "content": [ + { + "kind": "text", + "text": "This command is deprecated and likely not supported by any browser." + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Jsonwp Protocol Command\n\nDetermine an element's location on the screen once it has been scrolled into view.

__Note:__ This is considered an internal command and should only be used to determine an element's location for correctly generating native events." + } + ] + } + }, + "getElementSize": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidelementidsize" + } + ] + }, + { + "skipRendering": false, + "tag": "@deprecated", + "content": [ + { + "kind": "text", + "text": "This command is deprecated and likely not supported by any browser. Use the \"getElementRect\" command instead of \"getElementSize\"!" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Jsonwp Protocol Command\n\nDetermine an element's size in pixels. The size will be returned as a JSON object with " + }, + { + "kind": "code", + "text": "`width`" + }, + { + "kind": "text", + "text": " and " + }, + { + "kind": "code", + "text": "`height`" + }, + { + "kind": "text", + "text": " properties." + } + ] + } + }, + "elementEquals": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidelementidequalsother" + } + ] + }, + { + "skipRendering": false, + "tag": "@deprecated", + "content": [ + { + "kind": "text", + "text": "This command is deprecated and likely not supported by any browser." + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Jsonwp Protocol Command\n\nCompare elements with each other." + } + ] + } + }, + "elementSubmit": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidelementidsubmit" + } + ] + }, + { + "skipRendering": false, + "tag": "@deprecated", + "content": [ + { + "kind": "text", + "text": "This command is deprecated and likely not supported by any browser." + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Jsonwp Protocol Command\n\nNo description available, please see reference link." + } + ] + } + }, + "sendKeys": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidkeys" + } + ] + }, + { + "skipRendering": false, + "tag": "@deprecated", + "content": [ + { + "kind": "text", + "text": "This command is deprecated and likely not supported by any browser." + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Jsonwp Protocol Command\n\nNo description available, please see reference link." + } + ] + } + }, + "getAvailableEngines": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidimeavailable_engines" + } + ] + }, + { + "skipRendering": false, + "tag": "@deprecated", + "content": [ + { + "kind": "text", + "text": "This command is deprecated and likely not supported by any browser." + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Jsonwp Protocol Command\n\nNo description available, please see reference link." + } + ] + } + }, + "getActiveEngine": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidimeactive_engine" + } + ] + }, + { + "skipRendering": false, + "tag": "@deprecated", + "content": [ + { + "kind": "text", + "text": "This command is deprecated and likely not supported by any browser." + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Jsonwp Protocol Command\n\nNo description available, please see reference link." + } + ] + } + }, + "isIMEActivated": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidimeactivated" + } + ] + }, + { + "skipRendering": false, + "tag": "@deprecated", + "content": [ + { + "kind": "text", + "text": "This command is deprecated and likely not supported by any browser." + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Jsonwp Protocol Command\n\nNo description available, please see reference link." + } + ] + } + }, + "deactivateIME": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidimedeactivate" + } + ] + }, + { + "skipRendering": false, + "tag": "@deprecated", + "content": [ + { + "kind": "text", + "text": "This command is deprecated and likely not supported by any browser." + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Jsonwp Protocol Command\n\nNo description available, please see reference link." + } + ] + } + }, + "activateIME": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidimeactivate" + } + ] + }, + { + "skipRendering": false, + "tag": "@deprecated", + "content": [ + { + "kind": "text", + "text": "This command is deprecated and likely not supported by any browser." + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Jsonwp Protocol Command\n\nNo description available, please see reference link." + } + ] + } + }, + "getOrientation": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#get-sessionsessionidorientation" + } + ] + }, + { + "skipRendering": false, + "tag": "@deprecated", + "content": [ + { + "kind": "text", + "text": "This command is deprecated and likely not supported by any browser." + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Jsonwp Protocol Command\n\nNo description available, please see reference link." + } + ] + } + }, + "setOrientation": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#post-sessionsessionidorientation" + } + ] + }, + { + "skipRendering": false, + "tag": "@deprecated", + "content": [ + { + "kind": "text", + "text": "This command is deprecated and likely not supported by any browser." + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Jsonwp Protocol Command\n\nNo description available, please see reference link." + } + ] + } + }, + "moveToElement": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidmoveto" + } + ] + }, + { + "skipRendering": false, + "tag": "@deprecated", + "content": [ + { + "kind": "text", + "text": "This command is deprecated and likely not supported by any browser. Use the \"action\" command instead to execute a \"move to\" gesture!" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Jsonwp Protocol Command\n\nNo description available, please see reference link." + } + ] + } + }, + "buttonDown": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidbuttondown" + } + ] + }, + { + "skipRendering": false, + "tag": "@deprecated", + "content": [ + { + "kind": "text", + "text": "This command is deprecated and likely not supported by any browser. Use the \"action\" command instead to execute a click gesture!" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Jsonwp Protocol Command\n\nClick and hold the left mouse button (at the coordinates set by the last moveto command). Note that the next mouse-related command that should follow is buttonup . Any other mouse command (such as click or another call to buttondown) will yield undefined behaviour." + } + ] + } + }, + "buttonUp": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidbuttonup" + } + ] + }, + { + "skipRendering": false, + "tag": "@deprecated", + "content": [ + { + "kind": "text", + "text": "This command is deprecated and likely not supported by any browser. Use the \"action\" command instead to execute a click gesture!" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Jsonwp Protocol Command\n\nReleases the mouse button previously held (where the mouse is currently at). Must be called once for every buttondown command issued. See the note in click and buttondown about implications of out-of-order commands." + } + ] + } + }, + "positionClick": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidclick" + } + ] + }, + { + "skipRendering": false, + "tag": "@deprecated", + "content": [ + { + "kind": "text", + "text": "This command is deprecated and likely not supported by any browser. Use the \"action\" command instead of \"positionClick\"!" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Jsonwp Protocol Command\n\nClicks at the current mouse coordinates (set by moveto)." + } + ] + } + }, + "positionDoubleClick": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessioniddoubleclick" + } + ] + }, + { + "skipRendering": false, + "tag": "@deprecated", + "content": [ + { + "kind": "text", + "text": "This command is deprecated and likely not supported by any browser. Use the \"action\" command instead to execute a click gesture!" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Jsonwp Protocol Command\n\nDouble-clicks at the current mouse coordinates (set by moveto)." + } + ] + } + }, + "touchClick": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidtouchclick" + } + ] + }, + { + "skipRendering": false, + "tag": "@deprecated", + "content": [ + { + "kind": "text", + "text": "This command is deprecated and likely not supported by any browser. Use the \"action\" command instead to execute a touch gesture!" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Jsonwp Protocol Command\n\nSingle tap on the touch enabled device." + } + ] + } + }, + "touchScroll": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidtouchscroll" + } + ] + }, + { + "skipRendering": false, + "tag": "@deprecated", + "content": [ + { + "kind": "text", + "text": "This command is deprecated and likely not supported by any browser. Use the \"action\" command instead to execute a touch gesture!" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Jsonwp Protocol Command\n\nFinger move on the screen." + } + ] + } + }, + "touchDoubleClick": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidtouchdoubleclick" + } + ] + }, + { + "skipRendering": false, + "tag": "@deprecated", + "content": [ + { + "kind": "text", + "text": "This command is deprecated and likely not supported by any browser. Use the \"action\" command instead to execute a touch gesture!" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Jsonwp Protocol Command\n\nDouble tap on the touch screen using finger motion events." + } + ] + } + }, + "touchFlick": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidtouchflick" + } + ] + }, + { + "skipRendering": false, + "tag": "@deprecated", + "content": [ + { + "kind": "text", + "text": "This command is deprecated and likely not supported by any browser. Use the \"action\" command instead to execute a touch gesture!" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Jsonwp Protocol Command\n\nFlick on the touch screen using finger motion events. This flickcommand starts at a particulat screen location." + } + ] + } + }, + "getGeoLocation": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#get-sessionsessionidlocation" + } + ] + }, + { + "skipRendering": false, + "tag": "@deprecated", + "content": [ + { + "kind": "text", + "text": "This command is deprecated and likely not supported by any browser." + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Jsonwp Protocol Command\n\nGet the current geo location." + } + ] + } + }, + "setGeoLocation": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#post-sessionsessionidlocation" + } + ] + }, + { + "skipRendering": false, + "tag": "@deprecated", + "content": [ + { + "kind": "text", + "text": "This command is deprecated and likely not supported by any browser." + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Jsonwp Protocol Command\n\nSet the current geo location." + } + ] + } + }, + "getLocalStorage": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#get-sessionsessionidlocal_storage" + } + ] + }, + { + "skipRendering": false, + "tag": "@deprecated", + "content": [ + { + "kind": "text", + "text": "This command is deprecated and likely not supported by any browser. Use the \"execute\" command instead to interact with the session storage interface!" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Jsonwp Protocol Command\n\nGet all keys of the storage." + } + ] + } + }, + "setLocalStorage": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#post-sessionsessionidlocal_storage" + } + ] + }, + { + "skipRendering": false, + "tag": "@deprecated", + "content": [ + { + "kind": "text", + "text": "This command is deprecated and likely not supported by any browser. Use the \"execute\" command instead to interact with the session storage interface!" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Jsonwp Protocol Command\n\nSet the storage item for the given key." + } + ] + } + }, + "clearLocalStorage": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#get-sessionsessionidlocal_storage" + } + ] + }, + { + "skipRendering": false, + "tag": "@deprecated", + "content": [ + { + "kind": "text", + "text": "This command is deprecated and likely not supported by any browser. Use the \"execute\" command instead to interact with the session storage interface!" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Jsonwp Protocol Command\n\nClear the storage." + } + ] + } + }, + "getLocalStorageItem": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#get-sessionsessionidlocal_storagekeykey" + } + ] + }, + { + "skipRendering": false, + "tag": "@deprecated", + "content": [ + { + "kind": "text", + "text": "This command is deprecated and likely not supported by any browser. Use the \"execute\" command instead to interact with the session storage interface!" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Jsonwp Protocol Command\n\nGet the storage item for the given key." + } + ] + } + }, + "deleteLocalStorageItem": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#delete-sessionsessionidlocal_storagekeykey" + } + ] + }, + { + "skipRendering": false, + "tag": "@deprecated", + "content": [ + { + "kind": "text", + "text": "This command is deprecated and likely not supported by any browser. Use the \"execute\" command instead to interact with the session storage interface!" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Jsonwp Protocol Command\n\nNo description available, please see reference link." + } + ] + } + }, + "getLocalStorageSize": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidlocal_storagesize" + } + ] + }, + { + "skipRendering": false, + "tag": "@deprecated", + "content": [ + { + "kind": "text", + "text": "This command is deprecated and likely not supported by any browser. Use the \"execute\" command instead to interact with the session storage interface!" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Jsonwp Protocol Command\n\nGet the number of items in the storage." + } + ] + } + }, + "getSessionStorage": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#get-sessionsessionidsession_storage" + } + ] + }, + { + "skipRendering": false, + "tag": "@deprecated", + "content": [ + { + "kind": "text", + "text": "This command is deprecated and likely not supported by any browser. Use the \"execute\" command instead to interact with the session storage interface!" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Jsonwp Protocol Command\n\nGet all keys of the storage." + } + ] + } + }, + "setSessionStorage": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#post-sessionsessionidsession_storage" + } + ] + }, + { + "skipRendering": false, + "tag": "@deprecated", + "content": [ + { + "kind": "text", + "text": "This command is deprecated and likely not supported by any browser. Use the \"execute\" command instead to interact with the session storage interface!" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Jsonwp Protocol Command\n\nSet the storage item for the given key." + } + ] + } + }, + "clearSessionStorage": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#delete-sessionsessionidsession_storage" + } + ] + }, + { + "skipRendering": false, + "tag": "@deprecated", + "content": [ + { + "kind": "text", + "text": "This command is deprecated and likely not supported by any browser. Use the \"execute\" command instead to interact with the session storage interface!" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Jsonwp Protocol Command\n\nClear the storage." + } + ] + } + }, + "getSessionStorageItem": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#get-sessionsessionidsession_storagekeykey" + } + ] + }, + { + "skipRendering": false, + "tag": "@deprecated", + "content": [ + { + "kind": "text", + "text": "This command is deprecated and likely not supported by any browser. Use the \"execute\" command instead to interact with the session storage interface!" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Jsonwp Protocol Command\n\nGet the storage item for the given key." + } + ] + } + }, + "deleteSessionStorageItem": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#delete-sessionsessionidsession_storagekeykey" + } + ] + }, + { + "skipRendering": false, + "tag": "@deprecated", + "content": [ + { + "kind": "text", + "text": "This command is deprecated and likely not supported by any browser. Use the \"execute\" command instead to interact with the session storage interface!" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Jsonwp Protocol Command\n\nRemove the storage item for the given key." + } + ] + } + }, + "getSessionStorageSize": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidsession_storagesize" + } + ] + }, + { + "skipRendering": false, + "tag": "@deprecated", + "content": [ + { + "kind": "text", + "text": "This command is deprecated and likely not supported by any browser. Use the \"execute\" command instead to interact with the session storage interface!" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Jsonwp Protocol Command\n\nGet the number of items in the storage." + } + ] + } + }, + "getLogs": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidlog" + } + ] + }, + { + "skipRendering": false, + "tag": "@deprecated", + "content": [ + { + "kind": "text", + "text": "This command is deprecated and likely not supported by any browser. Use the \"devtools\" instead to get logs!" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Jsonwp Protocol Command\n\nGet the log for a given log type. Log buffer is reset after each request." + } + ] + } + }, + "getLogTypes": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidlogtypes" + } + ] + }, + { + "skipRendering": false, + "tag": "@deprecated", + "content": [ + { + "kind": "text", + "text": "This command is deprecated and likely not supported by any browser. Use the \"devtools\" instead to get logs!" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Jsonwp Protocol Command\n\nGet available log types." + } + ] + } + }, + "getApplicationCacheStatus": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidapplication_cachestatus" + } + ] + }, + { + "skipRendering": false, + "tag": "@deprecated", + "content": [ + { + "kind": "text", + "text": "This command is deprecated and likely not supported by any browser." + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Jsonwp Protocol Command\n\nGet the status of the html5 application cache." + } + ] + } + }, + "getContext": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://github.com/SeleniumHQ/mobile-spec/blob/master/spec-draft.md#webviews-and-other-contexts" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Appium Protocol Command\n\nNo description available, please see reference link." + } + ] + } + }, + "switchContext": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://github.com/SeleniumHQ/mobile-spec/blob/master/spec-draft.md#webviews-and-other-contexts" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Appium Protocol Command\n\nNo description available, please see reference link." + } + ] + } + }, + "getContexts": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://github.com/SeleniumHQ/mobile-spec/blob/master/spec-draft.md#webviews-and-other-contexts" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Appium Protocol Command\n\nNo description available, please see reference link." + } + ] + } + }, + "shake": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://appium.github.io/appium.io/docs/en/commands/device/interactions/shake/" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Appium Protocol Command\n\nPerform a shake action on the device." + } + ] + } + }, + "lock": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://appium.github.io/appium.io/docs/en/commands/device/interactions/lock/" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Appium Protocol Command\n\nLock the device." + } + ] + } + }, + "unlock": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://appium.github.io/appium.io/docs/en/commands/device/interactions/unlock/" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Appium Protocol Command\n\nUnlock the device." + } + ] + } + }, + "isLocked": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://appium.github.io/appium.io/docs/en/commands/device/interactions/is-locked/" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Appium Protocol Command\n\nCheck whether the device is locked or not." + } + ] + } + }, + "startRecordingScreen": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://appium.github.io/appium.io/docs/en/commands/device/recording-screen/start-recording-screen/" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Appium Protocol Command\n\nStart recording the screen." + } + ] + } + }, + "stopRecordingScreen": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://appium.github.io/appium.io/docs/en/commands/device/recording-screen/stop-recording-screen/" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Appium Protocol Command\n\nStop recording screen" + } + ] + } + }, + "getPerformanceDataTypes": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://appium.github.io/appium.io/docs/en/commands/device/performance-data/performance-data-types/" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Appium Protocol Command\n\nReturns the information types of the system state which is supported to read as like cpu, memory, network traffic, and battery." + } + ] + } + }, + "getPerformanceData": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://appium.github.io/appium.io/docs/en/commands/device/performance-data/get-performance-data/" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Appium Protocol Command\n\nReturns the information of the system state which is supported to read as like cpu, memory, network traffic, and battery." + } + ] + } + }, + "pressKeyCode": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://appium.github.io/appium.io/docs/en/commands/device/keys/press-keycode/" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Appium Protocol Command\n\nPress a particular key on the device." + } + ] + } + }, + "longPressKeyCode": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://appium.github.io/appium.io/docs/en/commands/device/keys/long-press-keycode/" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Appium Protocol Command\n\nPress and hold a particular key code on the device." + } + ] + } + }, + "sendKeyEvent": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://github.com/appium/appium-base-driver/blob/master/docs/mjsonwp/protocol-methods.md#appium-extension-endpoints" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Appium Protocol Command\n\nSend a key code to the device." + } + ] + } + }, + "rotateDevice": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://github.com/SeleniumHQ/mobile-spec/blob/master/spec-draft.md#device-rotation" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Appium Protocol Command\n\nRotate the device in three dimensions." + } + ] + } + }, + "getCurrentActivity": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://appium.github.io/appium.io/docs/en/commands/device/activity/current-activity/" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Appium Protocol Command\n\nGet the name of the current Android activity." + } + ] + } + }, + "getCurrentPackage": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://appium.github.io/appium.io/docs/en/commands/device/activity/current-package/" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Appium Protocol Command\n\nGet the name of the current Android package." + } + ] + } + }, + "installApp": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://appium.github.io/appium.io/docs/en/commands/device/app/install-app/" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Appium Protocol Command\n\nInstall the given app onto the device." + } + ] + } + }, + "activateApp": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://appium.github.io/appium.io/docs/en/commands/device/app/activate-app/" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Appium Protocol Command\n\nActivate the given app onto the device" + } + ] + } + }, + "removeApp": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://appium.github.io/appium.io/docs/en/commands/device/app/remove-app/" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Appium Protocol Command\n\nRemove an app from the device." + } + ] + } + }, + "terminateApp": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://appium.github.io/appium.io/docs/en/commands/device/app/terminate-app/" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Appium Protocol Command\n\nTerminate the given app on the device" + } + ] + } + }, + "isAppInstalled": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://appium.github.io/appium.io/docs/en/commands/device/app/is-app-installed/" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Appium Protocol Command\n\nCheck whether the specified app is installed on the device." + } + ] + } + }, + "queryAppState": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://appium.github.io/appium.io/docs/en/commands/device/app/app-state/" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Appium Protocol Command\n\nGet the given app status on the device" + } + ] + } + }, + "hideKeyboard": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://appium.github.io/appium.io/docs/en/commands/device/keys/hide-keyboard/" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Appium Protocol Command\n\nHide soft keyboard." + } + ] + } + }, + "isKeyboardShown": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://appium.github.io/appium.io/docs/en/commands/device/keys/is-keyboard-shown/" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Appium Protocol Command\n\nWhether or not the soft keyboard is shown." + } + ] + } + }, + "pushFile": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://appium.github.io/appium.io/docs/en/commands/device/files/push-file/" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Appium Protocol Command\n\nPlace a file onto the device in a particular place." + } + ] + } + }, + "pullFile": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://appium.github.io/appium.io/docs/en/commands/device/files/pull-file/" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Appium Protocol Command\n\nRetrieve a file from the device's file system." + } + ] + } + }, + "pullFolder": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://appium.github.io/appium.io/docs/en/commands/device/files/pull-folder/" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Appium Protocol Command\n\nRetrieve a folder from the device's file system." + } + ] + } + }, + "toggleAirplaneMode": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://appium.github.io/appium.io/docs/en/commands/device/network/toggle-airplane-mode/" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Appium Protocol Command\n\nToggle airplane mode on device." + } + ] + } + }, + "toggleData": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://appium.github.io/appium.io/docs/en/commands/device/network/toggle-data/" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Appium Protocol Command\n\nSwitch the state of data service." + } + ] + } + }, + "toggleWiFi": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://appium.github.io/appium.io/docs/en/commands/device/network/toggle-wifi/" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Appium Protocol Command\n\nSwitch the state of the wifi service." + } + ] + } + }, + "toggleLocationServices": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://appium.github.io/appium.io/docs/en/commands/device/network/toggle-location-services/" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Appium Protocol Command\n\nSwitch the state of the location service." + } + ] + } + }, + "toggleNetworkSpeed": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://appium.github.io/appium.io/docs/en/commands/device/network/network-speed/" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Appium Protocol Command\n\nSet network speed (Emulator only)" + } + ] + } + }, + "openNotifications": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://appium.github.io/appium.io/docs/en/commands/device/system/open-notifications/" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Appium Protocol Command\n\nOpen Android notifications (Emulator only)." + } + ] + } + }, + "startActivity": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://appium.github.io/appium.io/docs/en/commands/device/activity/start-activity/" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Appium Protocol Command\n\nStart an Android activity by providing package name and activity name." + } + ] + } + }, + "getSystemBars": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://appium.github.io/appium.io/docs/en/commands/device/system/system-bars/" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Appium Protocol Command\n\nRetrieve visibility and bounds information of the status and navigation bars." + } + ] + } + }, + "getDeviceTime": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://appium.github.io/appium.io/docs/en/commands/device/system/system-time/" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Appium Protocol Command\n\nGet the time on the device." + } + ] + } + }, + "getDisplayDensity": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://github.com/appium/appium-base-driver/blob/master/docs/mjsonwp/protocol-methods.md#appium-extension-endpoints" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Appium Protocol Command\n\nGet display density from device." + } + ] + } + }, + "touchId": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://appium.github.io/appium.io/docs/en/commands/device/simulator/touch-id/" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Appium Protocol Command\n\nSimulate a [touch id](https://support.apple.com/en-ca/ht201371) event (iOS Simulator only). To enable this feature, the " + }, + { + "kind": "code", + "text": "`allowTouchIdEnroll`" + }, + { + "kind": "text", + "text": " desired capability must be set to true and the Simulator must be [enrolled](https://support.apple.com/en-ca/ht201371). When you set allowTouchIdEnroll to true, it will set the Simulator to be enrolled by default. The enrollment state can be [toggled](https://appium.github.io/appium.io/docs/en/commands/device/simulator/toggle-touch-id-enrollment/index.html). This call will only work if Appium process or its parent application (e.g. Terminal.app or Appium.app) has access to Mac OS accessibility in System Preferences > Security & Privacy > Privacy > Accessibility list." + } + ] + } + }, + "toggleEnrollTouchId": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://appium.github.io/appium.io/docs/en/commands/device/simulator/toggle-touch-id-enrollment/" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Appium Protocol Command\n\nToggle the simulator being [enrolled](https://support.apple.com/en-ca/ht201371) to accept touchId (iOS Simulator only). To enable this feature, the " + }, + { + "kind": "code", + "text": "`allowTouchIdEnroll`" + }, + { + "kind": "text", + "text": " desired capability must be set to true. When " + }, + { + "kind": "code", + "text": "`allowTouchIdEnroll`" + }, + { + "kind": "text", + "text": " is set to true the Simulator will be enrolled by default, and the 'Toggle Touch ID Enrollment' changes the enrollment state. This call will only work if the Appium process or its parent application (e.g., Terminal.app or Appium.app) has access to Mac OS accessibility in System Preferences > Security & Privacy > Privacy > Accessibility list." + } + ] + } + }, + "launchApp": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://appium.github.io/appium.io/docs/en/commands/device/app/launch-app/" + } + ] + }, + { + "skipRendering": false, + "tag": "@deprecated", + "content": [ + { + "kind": "text", + "text": "For iOS, utilize " + }, + { + "kind": "code", + "text": "`driver.execute('mobile: launchApp', { ... })`" + }, + { + "kind": "text", + "text": ", and for Android, make use of " + }, + { + "kind": "code", + "text": "`driver.execute('mobile: activateApp', { ... })`" + }, + { + "kind": "text", + "text": "." + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Appium Protocol Command\n\nLaunch an app on device." + } + ] + } + }, + "closeApp": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://appium.github.io/appium.io/docs/en/commands/device/app/close-app/" + } + ] + }, + { + "skipRendering": false, + "tag": "@deprecated", + "content": [ + { + "kind": "text", + "text": "Use " + }, + { + "kind": "code", + "text": "`driver.execute('mobile: terminateApp', { ... })`" + }, + { + "kind": "text", + "text": " instead" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Appium Protocol Command\n\nClose an app on device." + } + ] + } + }, + "background": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://appium.github.io/appium.io/docs/en/commands/device/app/background-app/" + } + ] + }, + { + "skipRendering": false, + "tag": "@deprecated", + "content": [ + { + "kind": "text", + "text": "Use " + }, + { + "kind": "code", + "text": "`driver.execute('mobile: backgroundApp', { ... })`" + }, + { + "kind": "text", + "text": " instead" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Appium Protocol Command\n\nSend the currently running app for this session to the background." + } + ] + } + }, + "endCoverage": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://appium.github.io/appium.io/docs/en/commands/device/app/end-test-coverage/" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Appium Protocol Command\n\nGet test coverage data." + } + ] + } + }, + "getStrings": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://appium.github.io/appium.io/docs/en/commands/device/app/get-app-strings/" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Appium Protocol Command\n\nGet app strings." + } + ] + } + }, + "setValueImmediate": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://github.com/appium/appium-base-driver/blob/master/docs/mjsonwp/protocol-methods.md#appium-extension-endpoints" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Appium Protocol Command\n\nNo description available, please see reference link." + } + ] + } + }, + "replaceValue": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://github.com/appium/appium-base-driver/blob/master/docs/mjsonwp/protocol-methods.md#appium-extension-endpoints" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Appium Protocol Command\n\nReplace the value to element directly." + } + ] + } + }, + "getSettings": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://appium.github.io/appium.io/docs/en/commands/session/settings/get-settings/" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Appium Protocol Command\n\nRetrieve the current settings on the device." + } + ] + } + }, + "updateSettings": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://appium.github.io/appium.io/docs/en/commands/session/settings/update-settings/" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Appium Protocol Command\n\nUpdate the current setting on the device." + } + ] + } + }, + "receiveAsyncResponse": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://github.com/appium/appium-base-driver/blob/master/docs/mjsonwp/protocol-methods.md#appium-extension-endpoints" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Appium Protocol Command\n\nCallback url for asynchronous execution of JavaScript." + } + ] + } + }, + "gsmCall": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://appium.github.io/appium.io/docs/en/commands/device/network/gsm-call/" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Appium Protocol Command\n\nMake GSM call (Emulator only)." + } + ] + } + }, + "gsmSignal": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://appium.github.io/appium.io/docs/en/commands/device/network/gsm-signal/" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Appium Protocol Command\n\nSet GSM signal strength (Emulator only)." + } + ] + } + }, + "powerCapacity": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://appium.github.io/appium.io/docs/en/commands/device/emulator/power_capacity/" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Appium Protocol Command\n\nSet the battery percentage (Emulator only)." + } + ] + } + }, + "powerAC": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://appium.github.io/appium.io/docs/en/commands/device/emulator/power_ac/" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Appium Protocol Command\n\nSet the state of the battery charger to connected or not (Emulator only)." + } + ] + } + }, + "gsmVoice": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://appium.github.io/appium.io/docs/en/commands/device/network/gsm-voice/" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Appium Protocol Command\n\nSet GSM voice state (Emulator only)." + } + ] + } + }, + "sendSms": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://appium.github.io/appium.io/docs/en/commands/device/network/send-sms/" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Appium Protocol Command\n\nSimulate an SMS message (Emulator only)." + } + ] + } + }, + "fingerPrint": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://appium.github.io/appium.io/docs/en/commands/device/authentication/finger-print/" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Appium Protocol Command\n\nAuthenticate users by using their finger print scans on supported emulators." + } + ] + } + }, + "setClipboard": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://appium.github.io/appium.io/docs/en/commands/device/clipboard/set-clipboard/" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Appium Protocol Command\n\nSet the content of the system clipboard" + } + ] + } + }, + "getClipboard": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://appium.github.io/appium.io/docs/en/commands/device/clipboard/get-clipboard/" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Appium Protocol Command\n\nGet the content of the system clipboard" + } + ] + } + }, + "touchPerform": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://appium.github.io/appium.io/docs/en/commands/interactions/touch/touch-perform/" + } + ] + }, + { + "skipRendering": false, + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```js\n// do a horizontal swipe by percentage\nconst startPercentage = 10;\nconst endPercentage = 90;\nconst anchorPercentage = 50;\n\nconst { width, height } = driver.getWindowSize();\nconst anchor = height// anchorPercentage / 100;\nconst startPoint = width// startPercentage / 100;\nconst endPoint = width// endPercentage / 100;\ndriver.touchPerform([\n {\n action: 'press',\n options: {\n x: startPoint,\n y: anchor,\n },\n },\n {\n action: 'wait',\n options: {\n ms: 100,\n },\n },\n {\n action: 'moveTo',\n options: {\n x: endPoint,\n y: anchor,\n },\n },\n {\n action: 'release',\n options: {},\n },\n]);\n```" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Appium Protocol Command\n\nThis functionality is only available from within a native context. 'Touch Perform' works similarly to the other singular touch interactions, except that this allows you to chain together more than one touch action as one command. This is useful because Appium commands are sent over the network and there's latency between commands. This latency can make certain touch interactions impossible because some interactions need to be performed in one sequence. Vertical, for example, requires pressing down, moving to a different y coordinate, and then releasing. For it to work, there can't be a delay between the interactions." + } + ] + } + }, + "multiTouchPerform": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://appium.github.io/appium.io/docs/en/commands/interactions/touch/multi-touch-perform/" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Appium Protocol Command\n\nThis functionality is only available from within a native context. Perform a multi touch action sequence." + } + ] + } + }, + "executeDriverScript": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://github.com/appium/appium/blob/master/docs/en/commands/session/execute-driver.md" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Appium Protocol Command\n\nThis command enables you to specify a WebdriverIO script as a string and transmit it to the Appium server for local execution on the server itself. This approach helps minimize potential latency associated with each command. ***To utilize this command with Appium 2.0, you must have the [" + }, + { + "kind": "code", + "text": "`execute-driver-plugin`" + }, + { + "kind": "text", + "text": "](https://github.com/appium/appium/tree/master/packages/execute-driver-plugin) plugin installed.***" + } + ] + } + }, + "getEvents": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://github.com/appium/appium/blob/master/docs/en/commands/session/events/get-events.md" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Appium Protocol Command\n\nGet events stored in appium server." + } + ] + } + }, + "logEvent": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://github.com/appium/appium/blob/master/docs/en/commands/session/events/log-event.md" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Appium Protocol Command\n\nStore a custom event." + } + ] + } + }, + "compareImages": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://appium.github.io/appium.io/docs/en/writing-running-appium/image-comparison/" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Appium Protocol Command\n\nThis feature conducts image comparisons utilizing the capabilities of the OpenCV framework. Please note that for this functionality to work, both the OpenCV framework and the opencv4nodejs module must be installed on the machine where the Appium server is operational. ***Furthermore, you'll need to have the [" + }, + { + "kind": "code", + "text": "`images-plugin`" + }, + { + "kind": "text", + "text": "](https://github.com/appium/appium/tree/master/packages/images-plugin) plugin installed to use this feature with Appium 2.0.***" + } + ] + } + }, + "isAlertOpen": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://github.com/bayandin/chromedriver/blob/v2.45/alert_commands.cc#L42-L49" + } + ] + }, + { + "skipRendering": false, + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```js\nconsole.log(browser.isAlertOpen()); // outputs: false\nbrowser.execute('window.alert()');\nconsole.log(browser.isAlertOpen()); // outputs: true\n```" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Chromium Protocol Command\n\nWhether a simple dialog is currently open." + } + ] + } + }, + "isAutoReporting": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://codereview.chromium.org/101203012" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Chromium Protocol Command\n\nWhether it should automatically raises errors on browser logs." + } + ] + } + }, + "setAutoReporting": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://codereview.chromium.org/101203012" + } + ] + }, + { + "skipRendering": false, + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```js\n// Enable auto reporting first thing after session was initiated with empty browser logs\nconsole.log(browser.setAutoReporting(true)); // outputs: null\n// Upon requesting an non-existing resource it will abort execution due to thrown unknown error\nbrowser.url('https://webdriver.io/img/404-does-not-exist.png');\n```" + }, + { + "kind": "text", + "text": "*" + } + ] + }, + { + "skipRendering": false, + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```js\n// During the session do some operations which populate the browser logs\nbrowser.url('https://webdriver.io/img/404-does-not-exist.png');\nbrowser.url('https://webdriver.io/403/no-access');\n// Enable auto reporting which throws an unknown error for first browser log (404 response)\nbrowser.setAutoReporting(true);\n```" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Chromium Protocol Command\n\nToggle whether to return response with unknown error with first browser error (e.g. failed to load resource due to 403/404 response) for all subsequent commands (once enabled)." + } + ] + } + }, + "isLoading": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://github.com/bayandin/chromedriver/blob/v2.45/session_commands.cc#L783-L802" + } + ] + }, + { + "skipRendering": false, + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```js\nconsole.log(browser.isLoading()); // outputs: false\nbrowser.newWindow('https://webdriver.io');\nconsole.log(browser.isLoading()); // outputs: true\n```" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Chromium Protocol Command\n\nDetermines load status for active window handle." + } + ] + } + }, + "takeHeapSnapshot": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://github.com/bayandin/chromedriver/blob/v2.45/chrome/web_view.h#L198-L202" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Chromium Protocol Command\n\nTakes a heap snapshot of the current execution context." + } + ] + } + }, + "getNetworkConnection": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://github.com/SeleniumHQ/mobile-spec/blob/master/spec-draft.md#device-modes" + } + ] + }, + { + "skipRendering": false, + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```js\nconst browser = remote({\n capabilities: {\n browserName: 'chrome',\n 'goog:chromeOptions': {\n // Network emulation requires device mode, which is only enabled when mobile emulation is on\n mobileEmulation: { deviceName: 'iPad' },\n },\n }\n});\nconsole.log(browser.getNetworkConnection()); // outputs: 6 (Both Wi-Fi and data)\n```" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Chromium Protocol Command\n\nGet the connection type for network emulation. This command is only applicable when remote end replies with " + }, + { + "kind": "code", + "text": "`networkConnectionEnabled`" + }, + { + "kind": "text", + "text": " capability set to " + }, + { + "kind": "code", + "text": "`true`" + }, + { + "kind": "text", + "text": "." + } + ] + } + }, + "setNetworkConnection": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://github.com/SeleniumHQ/mobile-spec/blob/master/spec-draft.md#device-modes" + } + ] + }, + { + "skipRendering": false, + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```js\nconst browser = remote({\n capabilities: {\n browserName: 'chrome',\n 'goog:chromeOptions': {\n // Network emulation requires device mode, which is only enabled when mobile emulation is on\n mobileEmulation: { deviceName: 'iPad' },\n },\n }\n});\nconsole.log(browser.setNetworkConnection({ type: 1 })); // outputs: 1 (Airplane Mode)\n```" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Chromium Protocol Command\n\nChange connection type for network connection. This command is only applicable when remote end replies with " + }, + { + "kind": "code", + "text": "`networkConnectionEnabled`" + }, + { + "kind": "text", + "text": " capability set to " + }, + { + "kind": "code", + "text": "`true`" + }, + { + "kind": "text", + "text": "." + } + ] + } + }, + "getNetworkConditions": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://github.com/bayandin/chromedriver/blob/v2.45/session_commands.cc#L839-L859" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Chromium Protocol Command\n\nGet current network conditions used for emulation." + } + ] + } + }, + "setNetworkConditions": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://github.com/bayandin/chromedriver/blob/v2.45/window_commands.cc#L1663-L1722" + } + ] + }, + { + "skipRendering": false, + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```js\n// Use different download (25kb/s) and upload (50kb/s) throughput values for throttling with a latency of 1000ms\nbrowser.setNetworkConditions({ latency: 1000, download_throughput: 25600, upload_throughput: 51200 });\n```" + }, + { + "kind": "text", + "text": "*" + } + ] + }, + { + "skipRendering": false, + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```js\n// Force disconnected from network by setting 'offline' to true\nbrowser.setNetworkConditions({ latency: 0, throughput: 0, offline: true });\n```" + }, + { + "kind": "text", + "text": "*" + } + ] + }, + { + "skipRendering": false, + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```js\n// When preset name (e.g. 'DSL') is specified it does not respect values in object (e.g. 'offline')\nbrowser.setNetworkConditions({ latency: 0, throughput: 0, offline: true }, 'DSL');\n```" + }, + { + "kind": "text", + "text": "*" + } + ] + }, + { + "skipRendering": false, + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```js\n// Best practice for specifying network throttling preset is to use an empty object\nbrowser.setNetworkConditions({}, 'Good 3G');\n```" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Chromium Protocol Command\n\nSet network conditions used for emulation by throttling connection." + } + ] + } + }, + "deleteNetworkConditions": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://github.com/bayandin/chromedriver/blob/v2.45/window_commands.cc#L1724-L1745" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Chromium Protocol Command\n\nDisable any network throttling which might have been set. Equivalent of setting the " + }, + { + "kind": "code", + "text": "`No throttling`" + }, + { + "kind": "text", + "text": " preset." + } + ] + } + }, + "sendCommand": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://github.com/bayandin/chromedriver/blob/v2.45/window_commands.cc#L1290-L1304" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Chromium Protocol Command\n\nSend a command to the DevTools debugger.
For a list of available commands and their parameters refer to the [Chrome DevTools Protocol Viewer](https://chromedevtools.github.io/devtools-protocol/)." + } + ] + } + }, + "sendCommandAndGetResult": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://github.com/bayandin/chromedriver/blob/v2.45/window_commands.cc#L1306-L1320" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Chromium Protocol Command\n\nSend a command to the DevTools debugger and wait for the result.
For a list of available commands and their parameters refer to the [Chrome DevTools Protocol Viewer](https://chromedevtools.github.io/devtools-protocol/)." + } + ] + } + }, + "file": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://github.com/bayandin/chromedriver/blob/v2.45/session_commands.cc#L1037-L1065" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Chromium Protocol Command\n\nUpload a file to remote machine on which the browser is running." + } + ] + } + }, + "launchChromeApp": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://github.com/bayandin/chromedriver/blob/v2.45/session_commands.cc#L521-L539" + } + ] + }, + { + "skipRendering": false, + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```js\nimport fs from 'fs'\nconst browser = remote({\n capabilities: {\n browserName: 'chrome',\n 'goog:chromeOptions': {\n // Install upon starting browser in order to launch it\n extensions: [\n // Entry should be a base64-encoded packed Chrome app (.crx)\n fs.readFileSync('/absolute/path/app.crx').toString('base64')\n ]\n }\n }\n});\nbrowser.launchChromeApp('aohghmighlieiainnegkcijnfilokake')); // Google Docs (https://chrome.google.com/webstore/detail/docs/aohghmighlieiainnegkcijnfilokake)\n```" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Chromium Protocol Command\n\nLaunches a Chrome app by specified id." + } + ] + } + }, + "getElementValue": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://github.com/bayandin/chromedriver/blob/v2.45/element_commands.cc#L431-L443" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Chromium Protocol Command\n\nRetrieves the value of a given form control element." + } + ] + } + }, + "elementHover": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://github.com/bayandin/chromedriver/blob/v2.45/element_commands.cc#L126-L146" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Chromium Protocol Command\n\nEnable hover state for an element, which is reset upon next interaction." + } + ] + } + }, + "touchPinch": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://github.com/bayandin/chromedriver/blob/v2.45/window_commands.cc#L813-L827" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Chromium Protocol Command\n\nTrigger a pinch zoom effect." + } + ] + } + }, + "freeze": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://github.com/bayandin/chromedriver/blob/v2.45/window_commands.cc#L625-L633" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Chromium Protocol Command\n\nFreeze the current page. Extension for [Page Lifecycle API](https://developers.google.com/web/updates/2018/07/page-lifecycle-api)." + } + ] + } + }, + "resume": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://github.com/bayandin/chromedriver/blob/v2.45/window_commands.cc#L635-L645" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Chromium Protocol Command\n\nResume the current page. Extension for [Page Lifecycle API](https://developers.google.com/web/updates/2018/07/page-lifecycle-api)." + } + ] + } + }, + "getCastSinks": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://chromium.googlesource.com/chromium/src/+/refs/tags/73.0.3683.121/chrome/test/chromedriver/server/http_handler.cc#748" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Chromium Protocol Command\n\nReturns the list of cast sinks (Cast devices) available to the Chrome media router." + } + ] + } + }, + "selectCastSink": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://chromium.googlesource.com/chromium/src/+/refs/tags/73.0.3683.121/chrome/test/chromedriver/server/http_handler.cc#737" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Chromium Protocol Command\n\nSelects a cast sink (Cast device) as the recipient of media router intents (connect or play)." + } + ] + } + }, + "startCastTabMirroring": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://chromium.googlesource.com/chromium/src/+/refs/tags/73.0.3683.121/chrome/test/chromedriver/server/http_handler.cc#741" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Chromium Protocol Command\n\nInitiates tab mirroring for the current browser tab on the specified device." + } + ] + } + }, + "getCastIssueMessage": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://chromium.googlesource.com/chromium/src/+/refs/tags/73.0.3683.121/chrome/test/chromedriver/server/http_handler.cc#751" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Chromium Protocol Command\n\nReturns error message if there is any issue in a Cast session." + } + ] + } + }, + "stopCasting": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://chromium.googlesource.com/chromium/src/+/refs/tags/73.0.3683.121/chrome/test/chromedriver/server/http_handler.cc#744" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Chromium Protocol Command\n\nStops casting from media router to the specified device, if connected." + } + ] + } + }, + "shutdown": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://github.com/bayandin/chromedriver/blob/v2.45/session_commands.cc#L489-L498" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Chromium Protocol Command\n\nShutdown ChromeDriver process and consequently terminating all active sessions." + } + ] + } + }, + "getPageIndex": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://github.com/appium/appium-base-driver/blob/master/docs/mjsonwp/protocol-methods.md#mobile-json-wire-protocol-endpoints" + } + ] + }, + { + "skipRendering": false, + "tag": "@deprecated", + "content": [ + { + "kind": "text", + "text": "In Appium 2.0, this method is marked as deprecated and currently has no available alternatives." + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Mjsonwp Protocol Command\n\nNo description available, please see reference link." + } + ] + } + }, + "getPageLogs": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://wiki.saucelabs.com/display/DOCS/Custom+Sauce+Labs+WebDriver+Extensions+for+Network+and+Log+Commands#CustomSauceLabsWebDriverExtensionsforNetworkandLogCommands-ExtendedDebuggingTools" + } + ] + }, + { + "skipRendering": false, + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```js\n// Get Network Logs\nconsole.log(browser.getPageLogs('sauce:network'));\n//\n// outputs:\n// [{\n// \"url\": \"https://app.saucelabs.com/dashboard\",\n// \"statusCode\": 200,\n// \"method\": \"GET\",\n// \"requestHeaders\": {\n// ...\n// },\n// \"responseHeaders\": {\n// ...\n// },\n// \"timing\": {\n// ...\n// }\n// }, {,\n// ...\n// }]\n//\n```" + }, + { + "kind": "text", + "text": "*" + } + ] + }, + { + "skipRendering": false, + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```js\n// Get Performance Logs (needs capturePerformance capability see: https://wiki.saucelabs.com/display/DOCS/Measure+Page+Load+Performance+Using+Test+Automation#MeasurePageLoadPerformanceUsingTestAutomation-EnableYourScript)\nconsole.log(browser.getPageLogs('sauce:performance'));\n//\n// outputs:\n// {\n// \"speedIndex\": 1472.023,\n// \"timeToFirstInteractive\": 1243.214,\n// \"firstMeaningfulPaint\": 892.643,\n// ...\n// }\n//\n```" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Saucelabs Protocol Command\n\nGet webpage specific log information based on the last page load." + } + ] + } + }, + "sauceThrottleNetwork": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://wiki.saucelabs.com/display/DOCS/Custom+Sauce+Labs+WebDriver+Extensions+for+Network+and+Log+Commands#CustomSauceLabsWebDriverExtensionsforNetworkandLogCommands-ThrottleNetworkCapabilities" + } + ] + }, + { + "skipRendering": false, + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```js\n// predefined network condition\nbrowser.sauceThrottleNetwork('offline')\n```" + }, + { + "kind": "text", + "text": "*" + } + ] + }, + { + "skipRendering": false, + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```js\n// custom network condition\nbrowser.sauceThrottleNetwork({\n download: 1000,\n upload: 500,\n latency: 40'\n})\n```" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Saucelabs Protocol Command\n\nWith network conditioning you can test your site on a variety of network connections, including Edge, 3G, and even offline. You can throttle the data throughput, including the maximum download and upload throughput, and use latency manipulation to enforce a minimum delay in connection round-trip time (RTT)." + } + ] + } + }, + "throttleCPU": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://wiki.saucelabs.com/display/DOCS/Custom+Sauce+Labs+WebDriver+Extensions+for+Network+and+Log+Commands#CustomSauceLabsWebDriverExtensionsforNetworkandLogCommands-ThrottleCPUCapabilities" + } + ] + }, + { + "skipRendering": false, + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```js\n// throttle CPU and make it run 4x slower\nbrowser.throttleCPU(4)\n```" + }, + { + "kind": "text", + "text": "*" + } + ] + }, + { + "skipRendering": false, + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```js\n// reset CPU throttling\nbrowser.throttleCPU(0)\n```" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Saucelabs Protocol Command\n\nYou can throttle the CPU in DevTools to understand how your page performs under that constraint." + } + ] + } + }, + "interceptRequest": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://wiki.saucelabs.com/display/DOCS/Custom+Sauce+Labs+WebDriver+Extensions+for+Network+and+Log+Commands#CustomSauceLabsWebDriverExtensionsforNetworkandLogCommands-InterceptNetworkRequests" + } + ] + }, + { + "skipRendering": false, + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```js\n// redirect a request\nbrowser.interceptRequest({\n url: 'https://saucelabs.com',\n redirect: 'https://google.com'\n})\n```" + }, + { + "kind": "text", + "text": "*" + } + ] + }, + { + "skipRendering": false, + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```js\n// Blacklist requests to 3rd party vendors\nbrowser.interceptRequest({\n url: 'https://api.segment.io/v1/p',\n error: 'Failed'\n})\n```" + }, + { + "kind": "text", + "text": "*" + } + ] + }, + { + "skipRendering": false, + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```js\n// Modify requests to REST API (Mock REST API response)\nbrowser.interceptRequest({\n url: 'http://sampleapp.appspot.com/api/todos',\n response: {\n headers: {\n 'x-custom-headers': 'foobar'\n },\n body: [{\n title: 'My custom todo',\n order: 1,\n completed: false,\n url: 'http://todo-backend-express.herokuapp.com/15727'\n }]\n }\n})\n```" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Saucelabs Protocol Command\n\nAllows modifying any request made by the browser. You can blacklist, modify, or redirect these as required for your tests." + } + ] + } + }, + "assertPerformance": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://wiki.saucelabs.com/display/DOCS/Custom+Sauce+Labs+WebDriver+Extensions+for+Network+and+Log+Commands" + } + ] + }, + { + "skipRendering": false, + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```js\n// test performance for a page\nbrowser.url('https://webdriver.io')\nconst hasRegression = browser.assertPerformance({\n name: 'my performance test', // make sure that the name is also set in the sauce options in your capabilities\n metrics: ['score', 'firstPaint']\n})\n```" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Saucelabs Protocol Command\n\nAssert against the performance baseline of your app." + } + ] + } + }, + "jankinessCheck": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://wiki.saucelabs.com/display/DOCS/Custom+Sauce+Labs+WebDriver+Extensions+for+Network+and+Log+Commands" + } + ] + }, + { + "skipRendering": false, + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```js\n// test performance for a page\nbrowser.url('https://webdriver.io')\nbrowser.jankinessCheck()\n```" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Saucelabs Protocol Command\n\nPerform a scroll test that evaluates the jankiness of the application." + } + ] + } + }, + "mockRequest": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://wiki.saucelabs.com/display/DOCS/Custom+Sauce+Labs+WebDriver+Extensions+for+Network+and+Log+Commands" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Saucelabs Protocol Command\n\nMocks a network resource." + } + ] + } + }, + "getMockCalls": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://wiki.saucelabs.com/display/DOCS/Custom+Sauce+Labs+WebDriver+Extensions+for+Network+and+Log+Commands" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Saucelabs Protocol Command\n\nReceive request information about requests that match the mocked resource." + } + ] + } + }, + "clearMockCalls": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://wiki.saucelabs.com/display/DOCS/Custom+Sauce+Labs+WebDriver+Extensions+for+Network+and+Log+Commands" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Saucelabs Protocol Command\n\nClear list of mock calls." + } + ] + } + }, + "respondMock": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://wiki.saucelabs.com/display/DOCS/Custom+Sauce+Labs+WebDriver+Extensions+for+Network+and+Log+Commands" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Saucelabs Protocol Command\n\nRespond if mock matches a specific resource." + } + ] + } + }, + "getDownloadableFiles": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://www.seleniumhq.org/" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Selenium Protocol Command\n\nList files from remote machine available for download." + } + ] + } + }, + "download": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://www.seleniumhq.org/" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Selenium Protocol Command\n\nDownload a file from remote machine on which the browser is running." + } + ] + } + }, + "deleteDownloadableFiles": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://www.seleniumhq.org/" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Selenium Protocol Command\n\nRemove all downloadable files from remote machine on which the browser is running." + } + ] + } + }, + "getHubConfig": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://github.com/nicegraham/selenium-grid2-api#gridapihub" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Selenium Protocol Command\n\nReceive hub config remotely." + } + ] + } + }, + "gridTestSession": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://github.com/nicegraham/selenium-grid2-api#gridapitestsession" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Selenium Protocol Command\n\nGet the details of the Selenium Grid node running a session." + } + ] + } + }, + "gridProxyDetails": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://github.com/nicegraham/selenium-grid2-api#gridapiproxy" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Selenium Protocol Command\n\nGet proxy details." + } + ] + } + }, + "manageSeleniumHubLifecycle": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://github.com/nicegraham/selenium-grid2-api#lifecycle-manager" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Selenium Protocol Command\n\nManage lifecycle of hub node." + } + ] + } + }, + "queryGrid": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://www.selenium.dev/documentation/grid/advanced_features/graphql_support/" + } + ] + }, + { + "skipRendering": false, + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```js\nconst result = await browser.queryGrid('{ nodesInfo { nodes { status, uri } } }');\nconsole.log(JSON.stringify(result, null, 4))\n//\n// outputs:\n// {\n// \"data\": {\n// \"nodesInfo\": {\n// \"nodes\": [{\n// \"status\": \"UP\",\n// \"uri\": \"http://192.168.0.39:4444\"\n// }]\n// }\n// }\n// }\n//\n```" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Selenium Protocol Command\n\nSend GraphQL queries to the Selenium (hub or node) server to fetch data. (Only supported with Selenium v4 Server)" + } + ] + } + }, + "fullPageScreenshot": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://phabricator.services.mozilla.com/source/mozilla-central/browse/default/testing/geckodriver/src/command.rs$43-46" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Gecko Protocol Command\n\nCaptures a screenshot of the entire page." + } + ] + } + }, + "getMozContext": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://github.com/SeleniumHQ/selenium/blob/586affe0cf675b1d5c8abc756defa4a46d95391b/javascript/node/selenium-webdriver/firefox.js#L615-L622" + } + ] + }, + { + "skipRendering": false, + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```js\nconsole.log(await browser.getMozContext()); // outputs: 'CHROME'\n```" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Gecko Protocol Command\n\nGet the context that is currently in effect, e.g. " + }, + { + "kind": "code", + "text": "`CHROME`" + }, + { + "kind": "text", + "text": " or " + }, + { + "kind": "code", + "text": "`CONTENT`" + }, + { + "kind": "text", + "text": "." + } + ] + } + }, + "setMozContext": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://github.com/SeleniumHQ/selenium/blob/586affe0cf675b1d5c8abc756defa4a46d95391b/javascript/node/selenium-webdriver/firefox.js#L615-L645" + } + ] + }, + { + "skipRendering": false, + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```js\nconsole.log(await browser.getMozContext()); // outputs: 'CHROME'\nbrowser.setMozContext('CONTENT');\nconsole.log(await browser.getMozContext()); // outputs: 'CONTENT'\n```" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Gecko Protocol Command\n\nChanges target context for commands between chrome- and content.

Changing the current context has a stateful impact on all subsequent commands. The " + }, + { + "kind": "code", + "text": "`CONTENT`" + }, + { + "kind": "text", + "text": " context has normal web platform document permissions, as if you would evaluate arbitrary JavaScript. The " + }, + { + "kind": "code", + "text": "`CHROME`" + }, + { + "kind": "text", + "text": " context gets elevated permissions that lets you manipulate the browser chrome itself, with full access to the XUL toolkit." + } + ] + } + }, + "installAddOn": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://github.com/SeleniumHQ/selenium/blob/586affe0cf675b1d5c8abc756defa4a46d95391b/javascript/node/selenium-webdriver/firefox.js#L647-L668" + } + ] + }, + { + "skipRendering": false, + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```js\n// Create a buffer of the add on .zip file\nconst extension = await fs.promises.readFile('/path/to/extension.zip')\n// Load extension in Firefox\nconst id = await browser.installAddOn(extension.toString('base64'), false);\n```" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Gecko Protocol Command\n\nInstalls a new addon with the current session. This function will return an ID that may later be used to uninstall the addon using " + }, + { + "kind": "code", + "text": "`uninstallAddon`" + }, + { + "kind": "text", + "text": "." + } + ] + } + }, + "uninstallAddOn": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@ref", + "content": [ + { + "kind": "text", + "text": "https://github.com/SeleniumHQ/selenium/blob/586affe0cf675b1d5c8abc756defa4a46d95391b/javascript/node/selenium-webdriver/firefox.js#L670-L687" + } + ] + }, + { + "skipRendering": false, + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```js\n// Create a buffer of the add on .zip file\nconst extension = await fs.promises.readFile('/path/to/extension.zip')\n// Load extension in Firefox\nconst id = await browser.installAddOn(extension.toString('base64'), false);\n// ...\nawait browser.uninstallAddOn(id)\n```" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "Gecko Protocol Command\n\nUninstalls an addon from the current browser session's profile." + } + ] + } + }, + "__type": { + "comment": { + "blockTags": [ + { + "skipRendering": false, + "tag": "@alias", + "content": [ + { + "kind": "text", + "text": "browser.waitUntil" + } + ] + }, + { + "skipRendering": false, + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "true if condition is fulfilled" + } + ] + }, + { + "skipRendering": false, + "tag": "@uses", + "content": [ + { + "kind": "text", + "text": "utility/pause" + } + ] + }, + { + "skipRendering": false, + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nhttps://github.com/webdriverio/example-recipes/blob/0bfb2b8d212b627a2659b10f4449184b657e1d59/waitUntil/index.html#L3-L8\n```" + } + ] + }, + { + "skipRendering": false, + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nhttps://github.com/webdriverio/example-recipes/blob/0c9252b0a4f7e18a34cece74e5798c1fe464c120/waitUntil/waitUntilExample.js#L16-L24\n```" + } + ] + } + ], + "modifierTags": {}, + "summary": [ + { + "kind": "text", + "text": "This wait command is your universal weapon if you want to wait on something. It expects a condition\nand waits until that condition is fulfilled with a truthy value to be returned.\n\nA common example is to wait until a certain element contains a certain text (see example)." + } + ] + } + } + } + } +} \ No newline at end of file diff --git a/i18n/en/docusaurus-plugin-content-docs/current.json b/i18n/en/docusaurus-plugin-content-docs/current.json index 4ab9139..1f6ea09 100644 --- a/i18n/en/docusaurus-plugin-content-docs/current.json +++ b/i18n/en/docusaurus-plugin-content-docs/current.json @@ -18,5 +18,9 @@ "sidebar.mainSidebar.category.Plugins": { "message": "Plugins", "description": "The label for category Plugins in sidebar mainSidebar" + }, + "sidebar.mainSidebar.category.API Reference": { + "message": "API Reference", + "description": "The label for category API Reference in sidebar mainSidebar" } } diff --git a/i18n/en/docusaurus-plugin-content-docs/current/api-reference/README.mdx b/i18n/en/docusaurus-plugin-content-docs/current/api-reference/README.mdx new file mode 100644 index 0000000..bbdb385 --- /dev/null +++ b/i18n/en/docusaurus-plugin-content-docs/current/api-reference/README.mdx @@ -0,0 +1,81 @@ +# testplane + +## Classes + +| Class | Description | +| ------ | ------ | +| [AbortOnReconnectError](classes/AbortOnReconnectError.mdx) | - | +| [AssertViewError](classes/AssertViewError.mdx) | - | +| [CancelledError](classes/CancelledError.mdx) | - | +| [ClientBridgeError](classes/ClientBridgeError.mdx) | - | +| [Config](classes/Config.mdx) | - | +| [CoreError](classes/CoreError.mdx) | - | +| [HeightViewportError](classes/HeightViewportError.mdx) | Height of the element is larger than viewport | +| [ImageDiffError](classes/ImageDiffError.mdx) | - | +| [NoRefImageError](classes/NoRefImageError.mdx) | - | +| [OffsetViewportError](classes/OffsetViewportError.mdx) | Position of an element is outside of a viewport left, top or right bounds | +| [Suite](classes/Suite.mdx) | - | +| [Test](classes/Test.mdx) | - | +| [TestCollection](classes/TestCollection.mdx) | - | +| [Testplane](classes/Testplane.mdx) | - | +| [TestplaneInternalError](classes/TestplaneInternalError.mdx) | - | + +## Interfaces + +| Interface | Description | +| ------ | ------ | +| [AfterFileReadData](interfaces/AfterFileReadData.mdx) | - | +| [AssertViewOpts](interfaces/AssertViewOpts.mdx) | - | +| [AssertViewOptsConfig](interfaces/AssertViewOptsConfig.mdx) | - | +| [AssertViewResultDiff](interfaces/AssertViewResultDiff.mdx) | - | +| [AssertViewResultNoRefImage](interfaces/AssertViewResultNoRefImage.mdx) | - | +| [AssertViewResultSuccess](interfaces/AssertViewResultSuccess.mdx) | - | +| [BeforeFileReadData](interfaces/BeforeFileReadData.mdx) | - | +| [BrowserHistory](interfaces/BrowserHistory.mdx) | - | +| [BrowserInfo](interfaces/BrowserInfo.mdx) | - | +| [BuildDiffOptsConfig](interfaces/BuildDiffOptsConfig.mdx) | - | +| [CommandHistory](interfaces/CommandHistory.mdx) | - | +| [CommonConfig](interfaces/CommonConfig.mdx) | - | +| [CompareOptsConfig](interfaces/CompareOptsConfig.mdx) | - | +| [DiffOptions](interfaces/DiffOptions.mdx) | - | +| [ErrorDetails](interfaces/ErrorDetails.mdx) | - | +| [ExecutionThreadToolCtx](interfaces/ExecutionThreadToolCtx.mdx) | - | +| [ExpectOptsConfig](interfaces/ExpectOptsConfig.mdx) | - | +| [GlobalHelper](interfaces/GlobalHelper.mdx) | - | +| [HermioneCtx](interfaces/HermioneCtx.mdx) | - | +| [ImageBase64](interfaces/ImageBase64.mdx) | - | +| [ImageInfo](interfaces/ImageInfo.mdx) | - | +| [ImageSize](interfaces/ImageSize.mdx) | - | +| [InterceptData](interfaces/InterceptData.mdx) | - | +| [MochaOpts](interfaces/MochaOpts.mdx) | - | +| [ReadTestsOpts](interfaces/ReadTestsOpts.mdx) | - | +| [RefImageInfo](interfaces/RefImageInfo.mdx) | - | +| [RootSuite](interfaces/RootSuite.mdx) | - | +| [RunOpts](interfaces/RunOpts.mdx) | - | +| [SetsConfig](interfaces/SetsConfig.mdx) | - | +| [SystemConfig](interfaces/SystemConfig.mdx) | - | +| [TestError](interfaces/TestError.mdx) | - | +| [TestFunctionCtx](interfaces/TestFunctionCtx.mdx) | - | +| [TestResult](interfaces/TestResult.mdx) | - | +| [TestResultWithRetries](interfaces/TestResultWithRetries.mdx) | - | +| [TestplaneCtx](interfaces/TestplaneCtx.mdx) | - | +| [WdioBrowser](interfaces/WdioBrowser.mdx) | - | + +## Type Aliases + +| Type alias | Description | +| ------ | ------ | +| [AssertViewResult](type-aliases/AssertViewResult.mdx) | - | +| [AsyncSessionEventCallback](type-aliases/AsyncSessionEventCallback.mdx) | - | +| [ConfigInput](type-aliases/ConfigInput.mdx) | - | +| [InterceptHandler](type-aliases/InterceptHandler.mdx) | - | +| [InterceptedEvent](type-aliases/InterceptedEvent.mdx) | - | +| [MasterEventHandler](type-aliases/MasterEventHandler.mdx) | - | +| [SyncSessionEventCallback](type-aliases/SyncSessionEventCallback.mdx) | - | +| [WorkerEventHandler](type-aliases/WorkerEventHandler.mdx) | - | + +## Variables + +| Variable | Description | +| ------ | ------ | +| [Key](variables/Key.mdx) | - | diff --git a/i18n/en/docusaurus-plugin-content-docs/current/api-reference/classes/AbortOnReconnectError.mdx b/i18n/en/docusaurus-plugin-content-docs/current/api-reference/classes/AbortOnReconnectError.mdx new file mode 100644 index 0000000..401b43d --- /dev/null +++ b/i18n/en/docusaurus-plugin-content-docs/current/api-reference/classes/AbortOnReconnectError.mdx @@ -0,0 +1,66 @@ +[testplane](../README.mdx) / AbortOnReconnectError + +# Class: AbortOnReconnectError + +## Extends + +- `Error` + +## Constructors + +### new AbortOnReconnectError() + +```ts +new AbortOnReconnectError(): AbortOnReconnectError +``` + +#### Returns + +[`AbortOnReconnectError`](AbortOnReconnectError.mdx) + +#### Overrides + +`Error.constructor` + +#### Defined in + +testplane-docs/.testplane/src/errors/abort-on-reconnect-error.ts:2 + +## Properties + +| Property | Modifier | Type | Description | Inherited from | Defined in | +| ------ | ------ | ------ | ------ | ------ | ------ | +| `message` | `public` | `string` | - | `Error.message` | testplane-docs/node\_modules/typescript/lib/lib.es5.d.ts:1077 | +| `name` | `public` | `string` | - | `Error.name` | testplane-docs/node\_modules/typescript/lib/lib.es5.d.ts:1076 | +| `stack?` | `public` | `string` | - | `Error.stack` | testplane-docs/node\_modules/typescript/lib/lib.es5.d.ts:1078 | +| `prepareStackTrace?` | `static` | (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` | Optional override for formatting stack traces **See** https://v8.dev/docs/stack-trace-api#customizing-stack-traces | `Error.prepareStackTrace` | testplane/node\_modules/@types/node/globals.d.ts:27 | +| `stackTraceLimit` | `static` | `number` | - | `Error.stackTraceLimit` | testplane/node\_modules/@types/node/globals.d.ts:29 | + +## Methods + +### captureStackTrace() + +```ts +static captureStackTrace(targetObject, constructorOpt?): void +``` + +Create .stack property on a target object + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `targetObject` | `object` | +| `constructorOpt`? | `Function` | + +#### Returns + +`void` + +#### Inherited from + +`Error.captureStackTrace` + +#### Defined in + +testplane/node\_modules/@types/node/globals.d.ts:20 diff --git a/i18n/en/docusaurus-plugin-content-docs/current/api-reference/classes/AssertViewError.mdx b/i18n/en/docusaurus-plugin-content-docs/current/api-reference/classes/AssertViewError.mdx new file mode 100644 index 0000000..61953ce --- /dev/null +++ b/i18n/en/docusaurus-plugin-content-docs/current/api-reference/classes/AssertViewError.mdx @@ -0,0 +1,72 @@ +[testplane](../README.mdx) / AssertViewError + +# Class: AssertViewError + +## Extends + +- `Error` + +## Constructors + +### new AssertViewError() + +```ts +new AssertViewError(message): AssertViewError +``` + +#### Parameters + +| Parameter | Type | Default value | +| ------ | ------ | ------ | +| `message` | `string` | `"image comparison failed"` | + +#### Returns + +[`AssertViewError`](AssertViewError.mdx) + +#### Overrides + +`Error.constructor` + +#### Defined in + +testplane-docs/.testplane/src/browser/commands/assert-view/errors/assert-view-error.ts:2 + +## Properties + +| Property | Modifier | Type | Default value | Description | Inherited from | Defined in | +| ------ | ------ | ------ | ------ | ------ | ------ | ------ | +| `message` | `public` | `string` | `"image comparison failed"` | - | `Error.message` | testplane-docs/.testplane/src/browser/commands/assert-view/errors/assert-view-error.ts:2 | +| `name` | `public` | `string` | `undefined` | - | `Error.name` | testplane-docs/node\_modules/typescript/lib/lib.es5.d.ts:1076 | +| `stack?` | `public` | `string` | `undefined` | - | `Error.stack` | testplane-docs/node\_modules/typescript/lib/lib.es5.d.ts:1078 | +| `prepareStackTrace?` | `static` | (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` | `undefined` | Optional override for formatting stack traces **See** https://v8.dev/docs/stack-trace-api#customizing-stack-traces | `Error.prepareStackTrace` | testplane/node\_modules/@types/node/globals.d.ts:27 | +| `stackTraceLimit` | `static` | `number` | `undefined` | - | `Error.stackTraceLimit` | testplane/node\_modules/@types/node/globals.d.ts:29 | + +## Methods + +### captureStackTrace() + +```ts +static captureStackTrace(targetObject, constructorOpt?): void +``` + +Create .stack property on a target object + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `targetObject` | `object` | +| `constructorOpt`? | `Function` | + +#### Returns + +`void` + +#### Inherited from + +`Error.captureStackTrace` + +#### Defined in + +testplane/node\_modules/@types/node/globals.d.ts:20 diff --git a/i18n/en/docusaurus-plugin-content-docs/current/api-reference/classes/CancelledError.mdx b/i18n/en/docusaurus-plugin-content-docs/current/api-reference/classes/CancelledError.mdx new file mode 100644 index 0000000..63af97f --- /dev/null +++ b/i18n/en/docusaurus-plugin-content-docs/current/api-reference/classes/CancelledError.mdx @@ -0,0 +1,66 @@ +[testplane](../README.mdx) / CancelledError + +# Class: CancelledError + +## Extends + +- `Error` + +## Constructors + +### new CancelledError() + +```ts +new CancelledError(): CancelledError +``` + +#### Returns + +[`CancelledError`](CancelledError.mdx) + +#### Overrides + +`Error.constructor` + +#### Defined in + +testplane-docs/.testplane/src/browser-pool/cancelled-error.ts:5 + +## Properties + +| Property | Modifier | Type | Default value | Description | Overrides | Inherited from | Defined in | +| ------ | ------ | ------ | ------ | ------ | ------ | ------ | ------ | +| `message` | `public` | `string` | `"Browser request was cancelled"` | - | `Error.message` | - | testplane-docs/.testplane/src/browser-pool/cancelled-error.ts:3 | +| `name` | `public` | `string` | `"CancelledError"` | - | `Error.name` | - | testplane-docs/.testplane/src/browser-pool/cancelled-error.ts:2 | +| `stack?` | `public` | `string` | `undefined` | - | - | `Error.stack` | testplane-docs/node\_modules/typescript/lib/lib.es5.d.ts:1078 | +| `prepareStackTrace?` | `static` | (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` | `undefined` | Optional override for formatting stack traces **See** https://v8.dev/docs/stack-trace-api#customizing-stack-traces | - | `Error.prepareStackTrace` | testplane/node\_modules/@types/node/globals.d.ts:27 | +| `stackTraceLimit` | `static` | `number` | `undefined` | - | - | `Error.stackTraceLimit` | testplane/node\_modules/@types/node/globals.d.ts:29 | + +## Methods + +### captureStackTrace() + +```ts +static captureStackTrace(targetObject, constructorOpt?): void +``` + +Create .stack property on a target object + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `targetObject` | `object` | +| `constructorOpt`? | `Function` | + +#### Returns + +`void` + +#### Inherited from + +`Error.captureStackTrace` + +#### Defined in + +testplane/node\_modules/@types/node/globals.d.ts:20 diff --git a/i18n/en/docusaurus-plugin-content-docs/current/api-reference/classes/ClientBridgeError.mdx b/i18n/en/docusaurus-plugin-content-docs/current/api-reference/classes/ClientBridgeError.mdx new file mode 100644 index 0000000..847e218 --- /dev/null +++ b/i18n/en/docusaurus-plugin-content-docs/current/api-reference/classes/ClientBridgeError.mdx @@ -0,0 +1,72 @@ +[testplane](../README.mdx) / ClientBridgeError + +# Class: ClientBridgeError + +## Extends + +- `Error` + +## Constructors + +### new ClientBridgeError() + +```ts +new ClientBridgeError(message): ClientBridgeError +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +#### Returns + +[`ClientBridgeError`](ClientBridgeError.mdx) + +#### Overrides + +`Error.constructor` + +#### Defined in + +testplane-docs/.testplane/src/browser/client-bridge/error.ts:2 + +## Properties + +| Property | Modifier | Type | Description | Inherited from | Defined in | +| ------ | ------ | ------ | ------ | ------ | ------ | +| `message` | `public` | `string` | - | `Error.message` | testplane-docs/node\_modules/typescript/lib/lib.es5.d.ts:1077 | +| `name` | `public` | `string` | - | `Error.name` | testplane-docs/node\_modules/typescript/lib/lib.es5.d.ts:1076 | +| `stack?` | `public` | `string` | - | `Error.stack` | testplane-docs/node\_modules/typescript/lib/lib.es5.d.ts:1078 | +| `prepareStackTrace?` | `static` | (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` | Optional override for formatting stack traces **See** https://v8.dev/docs/stack-trace-api#customizing-stack-traces | `Error.prepareStackTrace` | testplane/node\_modules/@types/node/globals.d.ts:27 | +| `stackTraceLimit` | `static` | `number` | - | `Error.stackTraceLimit` | testplane/node\_modules/@types/node/globals.d.ts:29 | + +## Methods + +### captureStackTrace() + +```ts +static captureStackTrace(targetObject, constructorOpt?): void +``` + +Create .stack property on a target object + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `targetObject` | `object` | +| `constructorOpt`? | `Function` | + +#### Returns + +`void` + +#### Inherited from + +`Error.captureStackTrace` + +#### Defined in + +testplane/node\_modules/@types/node/globals.d.ts:20 diff --git a/i18n/en/docusaurus-plugin-content-docs/current/api-reference/classes/Config.mdx b/i18n/en/docusaurus-plugin-content-docs/current/api-reference/classes/Config.mdx new file mode 100644 index 0000000..1f84ebd --- /dev/null +++ b/i18n/en/docusaurus-plugin-content-docs/current/api-reference/classes/Config.mdx @@ -0,0 +1,307 @@ +[testplane](../README.mdx) / Config + +# Class: Config + +## Extends + +- [`CommonConfig`](../interfaces/CommonConfig.mdx) + +## Constructors + +### new Config() + +```ts +new Config(config?): Config +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `config`? | `string` \| [`ConfigInput`](../type-aliases/ConfigInput.mdx) | + +#### Returns + +[`Config`](Config.mdx) + +#### Defined in + +testplane-docs/.testplane/src/config/index.ts:28 + +## Properties + +| Property | Type | Inherited from | Defined in | +| ------ | ------ | ------ | ------ | +| `antialiasingTolerance` | `number` | [`CommonConfig`](../interfaces/CommonConfig.mdx).`antialiasingTolerance` | testplane-docs/.testplane/src/config/types.ts:133 | +| `assertViewOpts` | [`AssertViewOptsConfig`](../interfaces/AssertViewOptsConfig.mdx) | [`CommonConfig`](../interfaces/CommonConfig.mdx).`assertViewOpts` | testplane-docs/.testplane/src/config/types.ts:136 | +| `automationProtocol` | `"webdriver"` \| `"devtools"` | [`CommonConfig`](../interfaces/CommonConfig.mdx).`automationProtocol` | testplane-docs/.testplane/src/config/types.ts:97 | +| `baseUrl` | `string` | [`CommonConfig`](../interfaces/CommonConfig.mdx).`baseUrl` | testplane-docs/.testplane/src/config/types.ts:104 | +| `browsers` | `Record`\<`string`, `BrowserConfig`\> | - | testplane-docs/.testplane/src/config/types.ts:213 | +| `buildDiffOpts` | [`BuildDiffOptsConfig`](../interfaces/BuildDiffOptsConfig.mdx) | [`CommonConfig`](../interfaces/CommonConfig.mdx).`buildDiffOpts` | testplane-docs/.testplane/src/config/types.ts:135 | +| `calibrate` | `boolean` | [`CommonConfig`](../interfaces/CommonConfig.mdx).`calibrate` | testplane-docs/.testplane/src/config/types.ts:127 | +| `compareOpts` | [`CompareOptsConfig`](../interfaces/CompareOptsConfig.mdx) | [`CommonConfig`](../interfaces/CommonConfig.mdx).`compareOpts` | testplane-docs/.testplane/src/config/types.ts:134 | +| `compositeImage` | `boolean` | [`CommonConfig`](../interfaces/CommonConfig.mdx).`compositeImage` | testplane-docs/.testplane/src/config/types.ts:128 | +| `configPath` | `string` | [`CommonConfig`](../interfaces/CommonConfig.mdx).`configPath` | testplane-docs/.testplane/src/config/index.ts:10 | +| `desiredCapabilities` | `null` \| `Capabilities` | [`CommonConfig`](../interfaces/CommonConfig.mdx).`desiredCapabilities` | testplane-docs/.testplane/src/config/types.ts:98 | +| `devServer` | \{ `args`: `string`[]; `command`: `null` \| `string`; `cwd`: `null` \| `string`; `env`: `Record`\<`string`, `string`\>; `logs`: `boolean`; `readinessProbe`: `ReadinessProbe`; \} | [`CommonConfig`](../interfaces/CommonConfig.mdx).`devServer` | testplane-docs/.testplane/src/config/types.ts:170 | +| `devServer.args` | `string`[] | - | testplane-docs/.testplane/src/config/types.ts:174 | +| `devServer.command` | `null` \| `string` | - | testplane-docs/.testplane/src/config/types.ts:171 | +| `devServer.cwd` | `null` \| `string` | - | testplane-docs/.testplane/src/config/types.ts:172 | +| `devServer.env` | `Record`\<`string`, `string`\> | - | testplane-docs/.testplane/src/config/types.ts:173 | +| `devServer.logs` | `boolean` | - | testplane-docs/.testplane/src/config/types.ts:175 | +| `devServer.readinessProbe` | `ReadinessProbe` | - | testplane-docs/.testplane/src/config/types.ts:176 | +| `expectOpts` | [`ExpectOptsConfig`](../interfaces/ExpectOptsConfig.mdx) | [`CommonConfig`](../interfaces/CommonConfig.mdx).`expectOpts` | testplane-docs/.testplane/src/config/types.ts:137 | +| `gridUrl` | `string` | [`CommonConfig`](../interfaces/CommonConfig.mdx).`gridUrl` | testplane-docs/.testplane/src/config/types.ts:103 | +| `headers` | `null` \| `Record`\<`string`, `string`\> | [`CommonConfig`](../interfaces/CommonConfig.mdx).`headers` | testplane-docs/.testplane/src/config/types.ts:142 | +| `headless` | `null` \| `boolean` \| `"old"` \| `"new"` | [`CommonConfig`](../interfaces/CommonConfig.mdx).`headless` | testplane-docs/.testplane/src/config/types.ts:153 | +| `httpTimeout` | `number` | [`CommonConfig`](../interfaces/CommonConfig.mdx).`httpTimeout` | testplane-docs/.testplane/src/config/types.ts:109 | +| `isolation` | `boolean` | [`CommonConfig`](../interfaces/CommonConfig.mdx).`isolation` | testplane-docs/.testplane/src/config/types.ts:154 | +| `key` | `null` \| `string` | [`CommonConfig`](../interfaces/CommonConfig.mdx).`key` | testplane-docs/.testplane/src/config/types.ts:149 | +| `lastFailed` | \{ `input`: `string` \| `string`[]; `only`: `boolean`; `output`: `string`; \} | [`CommonConfig`](../interfaces/CommonConfig.mdx).`lastFailed` | testplane-docs/.testplane/src/config/types.ts:156 | +| `lastFailed.input` | `string` \| `string`[] | - | testplane-docs/.testplane/src/config/types.ts:158 | +| `lastFailed.only` | `boolean` | - | testplane-docs/.testplane/src/config/types.ts:157 | +| `lastFailed.output` | `string` | - | testplane-docs/.testplane/src/config/types.ts:159 | +| `meta` | \{\} | [`CommonConfig`](../interfaces/CommonConfig.mdx).`meta` | testplane-docs/.testplane/src/config/types.ts:138 | +| `openAndWaitOpts` | \{ `failOnNetworkError`: `boolean`; `ignoreNetworkErrorsPatterns`: (`string` \| `RegExp`)[]; `timeout`: `number`; `waitNetworkIdle`: `boolean`; `waitNetworkIdleTimeout`: `number`; \} | [`CommonConfig`](../interfaces/CommonConfig.mdx).`openAndWaitOpts` | testplane-docs/.testplane/src/config/types.ts:162 | +| `openAndWaitOpts.failOnNetworkError` | `boolean` | - | testplane-docs/.testplane/src/config/types.ts:166 | +| `openAndWaitOpts.ignoreNetworkErrorsPatterns` | (`string` \| `RegExp`)[] | - | testplane-docs/.testplane/src/config/types.ts:167 | +| `openAndWaitOpts.timeout?` | `number` | - | testplane-docs/.testplane/src/config/types.ts:163 | +| `openAndWaitOpts.waitNetworkIdle` | `boolean` | - | testplane-docs/.testplane/src/config/types.ts:164 | +| `openAndWaitOpts.waitNetworkIdleTimeout` | `number` | - | testplane-docs/.testplane/src/config/types.ts:165 | +| `orientation` | `null` \| `"landscape"` \| `"portrait"` | [`CommonConfig`](../interfaces/CommonConfig.mdx).`orientation` | testplane-docs/.testplane/src/config/types.ts:140 | +| `pageLoadTimeout` | `null` \| `number` | [`CommonConfig`](../interfaces/CommonConfig.mdx).`pageLoadTimeout` | testplane-docs/.testplane/src/config/types.ts:111 | +| `plugins` | `Record`\<`string`, `Record`\<`string`, `unknown`\>\> | - | testplane-docs/.testplane/src/config/types.ts:214 | +| `prepareEnvironment?` | () => `null` \| `void` | - | testplane-docs/.testplane/src/config/types.ts:216 | +| `region` | `null` \| `string` | [`CommonConfig`](../interfaces/CommonConfig.mdx).`region` | testplane-docs/.testplane/src/config/types.ts:150 | +| `resetCursor` | `boolean` | [`CommonConfig`](../interfaces/CommonConfig.mdx).`resetCursor` | testplane-docs/.testplane/src/config/types.ts:141 | +| `retry` | `number` | [`CommonConfig`](../interfaces/CommonConfig.mdx).`retry` | testplane-docs/.testplane/src/config/types.ts:107 | +| `saveHistoryMode` | `"all"` \| `"none"` \| `"onlyFailed"` | [`CommonConfig`](../interfaces/CommonConfig.mdx).`saveHistoryMode` | testplane-docs/.testplane/src/config/types.ts:117 | +| `screenshotDelay` | `number` | [`CommonConfig`](../interfaces/CommonConfig.mdx).`screenshotDelay` | testplane-docs/.testplane/src/config/types.ts:131 | +| `screenshotMode` | `"auto"` \| `"fullpage"` \| `"viewport"` | [`CommonConfig`](../interfaces/CommonConfig.mdx).`screenshotMode` | testplane-docs/.testplane/src/config/types.ts:130 | +| `screenshotPath` | `null` \| `string` | [`CommonConfig`](../interfaces/CommonConfig.mdx).`screenshotPath` | testplane-docs/.testplane/src/config/types.ts:125 | +| `sessionEnvFlags` | `Record`\< \| `"isW3C"` \| `"isAndroid"` \| `"isMobile"` \| `"isIOS"` \| `"isSauce"` \| `"isSeleniumStandalone"` \| `"isChrome"`, `boolean`\> | [`CommonConfig`](../interfaces/CommonConfig.mdx).`sessionEnvFlags` | testplane-docs/.testplane/src/config/types.ts:99 | +| `sessionQuitTimeout` | `null` \| `number` | [`CommonConfig`](../interfaces/CommonConfig.mdx).`sessionQuitTimeout` | testplane-docs/.testplane/src/config/types.ts:113 | +| `sessionRequestTimeout` | `null` \| `number` | [`CommonConfig`](../interfaces/CommonConfig.mdx).`sessionRequestTimeout` | testplane-docs/.testplane/src/config/types.ts:112 | +| `sessionsPerBrowser` | `number` | [`CommonConfig`](../interfaces/CommonConfig.mdx).`sessionsPerBrowser` | testplane-docs/.testplane/src/config/types.ts:105 | +| `sets` | `Record`\<`string`, `SetsConfigParsed`\> | - | testplane-docs/.testplane/src/config/types.ts:215 | +| `strictSSL` | `null` \| `boolean` | [`CommonConfig`](../interfaces/CommonConfig.mdx).`strictSSL` | testplane-docs/.testplane/src/config/types.ts:147 | +| `strictTestsOrder` | `boolean` | [`CommonConfig`](../interfaces/CommonConfig.mdx).`strictTestsOrder` | testplane-docs/.testplane/src/config/types.ts:129 | +| `system` | [`SystemConfig`](../interfaces/SystemConfig.mdx) | [`CommonConfig`](../interfaces/CommonConfig.mdx).`system` | testplane-docs/.testplane/src/config/types.ts:152 | +| `takeScreenshotOnFails` | \{ `assertViewFail`: `boolean`; `testFail`: `boolean`; \} | [`CommonConfig`](../interfaces/CommonConfig.mdx).`takeScreenshotOnFails` | testplane-docs/.testplane/src/config/types.ts:118 | +| `takeScreenshotOnFails.assertViewFail` | `boolean` | - | testplane-docs/.testplane/src/config/types.ts:120 | +| `takeScreenshotOnFails.testFail` | `boolean` | - | testplane-docs/.testplane/src/config/types.ts:119 | +| `takeScreenshotOnFailsMode` | `"fullpage"` \| `"viewport"` | [`CommonConfig`](../interfaces/CommonConfig.mdx).`takeScreenshotOnFailsMode` | testplane-docs/.testplane/src/config/types.ts:123 | +| `takeScreenshotOnFailsTimeout` | `null` \| `number` | [`CommonConfig`](../interfaces/CommonConfig.mdx).`takeScreenshotOnFailsTimeout` | testplane-docs/.testplane/src/config/types.ts:122 | +| `testTimeout` | `null` \| `number` | [`CommonConfig`](../interfaces/CommonConfig.mdx).`testTimeout` | testplane-docs/.testplane/src/config/types.ts:114 | +| `testsPerSession` | `number` | [`CommonConfig`](../interfaces/CommonConfig.mdx).`testsPerSession` | testplane-docs/.testplane/src/config/types.ts:106 | +| `tolerance` | `number` | [`CommonConfig`](../interfaces/CommonConfig.mdx).`tolerance` | testplane-docs/.testplane/src/config/types.ts:132 | +| `transformRequest` | (`req`: `RequestOptions`) => `RequestOptions` | [`CommonConfig`](../interfaces/CommonConfig.mdx).`transformRequest` | testplane-docs/.testplane/src/config/types.ts:144 | +| `transformResponse` | (`res`: `Response`, `req`: `RequestOptions`) => `Response` | [`CommonConfig`](../interfaces/CommonConfig.mdx).`transformResponse` | testplane-docs/.testplane/src/config/types.ts:145 | +| `urlHttpTimeout` | `null` \| `number` | [`CommonConfig`](../interfaces/CommonConfig.mdx).`urlHttpTimeout` | testplane-docs/.testplane/src/config/types.ts:110 | +| `user` | `null` \| `string` | [`CommonConfig`](../interfaces/CommonConfig.mdx).`user` | testplane-docs/.testplane/src/config/types.ts:148 | +| `waitInterval` | `number` | [`CommonConfig`](../interfaces/CommonConfig.mdx).`waitInterval` | testplane-docs/.testplane/src/config/types.ts:116 | +| `waitTimeout` | `number` | [`CommonConfig`](../interfaces/CommonConfig.mdx).`waitTimeout` | testplane-docs/.testplane/src/config/types.ts:115 | +| `windowSize` | `null` \| `string` \| \{ `height`: `number`; `width`: `number`; \} | [`CommonConfig`](../interfaces/CommonConfig.mdx).`windowSize` | testplane-docs/.testplane/src/config/types.ts:139 | + +## Methods + +### forBrowser() + +```ts +forBrowser(id): BrowserConfig +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `id` | `string` | + +#### Returns + +`BrowserConfig` + +#### Defined in + +testplane-docs/.testplane/src/config/index.ts:82 + +*** + +### getBrowserIds() + +```ts +getBrowserIds(): string[] +``` + +#### Returns + +`string`[] + +#### Defined in + +testplane-docs/.testplane/src/config/index.ts:86 + +*** + +### mergeWith() + +```ts +mergeWith(config): void +``` + +This method is used in subrocesses to merge a created config +in a subrocess with a config from the main process + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `config` | [`Config`](Config.mdx) | + +#### Returns + +`void` + +#### Defined in + +testplane-docs/.testplane/src/config/index.ts:100 + +*** + +### prepareBrowser() + +```ts +prepareBrowser(browser): null | void +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `browser` | `Browser` | + +#### Returns + +`null` \| `void` + +#### Inherited from + +[`CommonConfig`](../interfaces/CommonConfig.mdx).[`prepareBrowser`](../interfaces/CommonConfig.mdx#preparebrowser) + +#### Defined in + +testplane-docs/.testplane/src/config/types.ts:124 + +*** + +### screenshotsDir() + +```ts +screenshotsDir(test): string +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `test` | [`Test`](Test.mdx) | + +#### Returns + +`string` + +#### Inherited from + +[`CommonConfig`](../interfaces/CommonConfig.mdx).[`screenshotsDir`](../interfaces/CommonConfig.mdx#screenshotsdir) + +#### Defined in + +testplane-docs/.testplane/src/config/types.ts:126 + +*** + +### serialize() + +```ts +serialize(): Omit +``` + +#### Returns + +`Omit`\<[`Config`](Config.mdx), `"system"`\> + +#### Defined in + +testplane-docs/.testplane/src/config/index.ts:90 + +*** + +### shouldRetry() + +```ts +shouldRetry(testInfo): null | boolean +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `testInfo` | `object` | +| `testInfo.ctx` | [`Test`](Test.mdx) | +| `testInfo.retriesLeft` | `number` | + +#### Returns + +`null` \| `boolean` + +#### Inherited from + +[`CommonConfig`](../interfaces/CommonConfig.mdx).[`shouldRetry`](../interfaces/CommonConfig.mdx#shouldretry) + +#### Defined in + +testplane-docs/.testplane/src/config/types.ts:108 + +*** + +### create() + +```ts +static create(config?): Config +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `config`? | `string` \| [`ConfigInput`](../type-aliases/ConfigInput.mdx) | + +#### Returns + +[`Config`](Config.mdx) + +#### Defined in + +testplane-docs/.testplane/src/config/index.ts:12 + +*** + +### read() + +```ts +static read(configPath): unknown +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `configPath` | `string` | + +#### Returns + +`unknown` + +#### Defined in + +testplane-docs/.testplane/src/config/index.ts:16 diff --git a/i18n/en/docusaurus-plugin-content-docs/current/api-reference/classes/CoreError.mdx b/i18n/en/docusaurus-plugin-content-docs/current/api-reference/classes/CoreError.mdx new file mode 100644 index 0000000..44c3855 --- /dev/null +++ b/i18n/en/docusaurus-plugin-content-docs/current/api-reference/classes/CoreError.mdx @@ -0,0 +1,72 @@ +[testplane](../README.mdx) / CoreError + +# Class: CoreError + +## Extends + +- `Error` + +## Constructors + +### new CoreError() + +```ts +new CoreError(message): CoreError +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +#### Returns + +[`CoreError`](CoreError.mdx) + +#### Overrides + +`Error.constructor` + +#### Defined in + +testplane-docs/.testplane/src/browser/core-error.ts:4 + +## Properties + +| Property | Modifier | Type | Default value | Description | Overrides | Inherited from | Defined in | +| ------ | ------ | ------ | ------ | ------ | ------ | ------ | ------ | +| `message` | `public` | `string` | `undefined` | - | - | `Error.message` | testplane-docs/node\_modules/typescript/lib/lib.es5.d.ts:1077 | +| `name` | `public` | `string` | `"CoreError"` | - | `Error.name` | - | testplane-docs/.testplane/src/browser/core-error.ts:2 | +| `stack?` | `public` | `string` | `undefined` | - | - | `Error.stack` | testplane-docs/node\_modules/typescript/lib/lib.es5.d.ts:1078 | +| `prepareStackTrace?` | `static` | (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` | `undefined` | Optional override for formatting stack traces **See** https://v8.dev/docs/stack-trace-api#customizing-stack-traces | - | `Error.prepareStackTrace` | testplane/node\_modules/@types/node/globals.d.ts:27 | +| `stackTraceLimit` | `static` | `number` | `undefined` | - | - | `Error.stackTraceLimit` | testplane/node\_modules/@types/node/globals.d.ts:29 | + +## Methods + +### captureStackTrace() + +```ts +static captureStackTrace(targetObject, constructorOpt?): void +``` + +Create .stack property on a target object + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `targetObject` | `object` | +| `constructorOpt`? | `Function` | + +#### Returns + +`void` + +#### Inherited from + +`Error.captureStackTrace` + +#### Defined in + +testplane/node\_modules/@types/node/globals.d.ts:20 diff --git a/i18n/en/docusaurus-plugin-content-docs/current/api-reference/classes/HeightViewportError.mdx b/i18n/en/docusaurus-plugin-content-docs/current/api-reference/classes/HeightViewportError.mdx new file mode 100644 index 0000000..b88842b --- /dev/null +++ b/i18n/en/docusaurus-plugin-content-docs/current/api-reference/classes/HeightViewportError.mdx @@ -0,0 +1,74 @@ +[testplane](../README.mdx) / HeightViewportError + +# Class: HeightViewportError + +Height of the element is larger than viewport + +## Extends + +- `Error` + +## Constructors + +### new HeightViewportError() + +```ts +new HeightViewportError(message): HeightViewportError +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +#### Returns + +[`HeightViewportError`](HeightViewportError.mdx) + +#### Overrides + +`Error.constructor` + +#### Defined in + +testplane-docs/.testplane/src/browser/screen-shooter/viewport/coord-validator/errors/height-viewport-error.ts:5 + +## Properties + +| Property | Modifier | Type | Description | Inherited from | Defined in | +| ------ | ------ | ------ | ------ | ------ | ------ | +| `message` | `public` | `string` | - | `Error.message` | testplane-docs/node\_modules/typescript/lib/lib.es5.d.ts:1077 | +| `name` | `public` | `string` | - | `Error.name` | testplane-docs/node\_modules/typescript/lib/lib.es5.d.ts:1076 | +| `stack?` | `public` | `string` | - | `Error.stack` | testplane-docs/node\_modules/typescript/lib/lib.es5.d.ts:1078 | +| `prepareStackTrace?` | `static` | (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` | Optional override for formatting stack traces **See** https://v8.dev/docs/stack-trace-api#customizing-stack-traces | `Error.prepareStackTrace` | testplane/node\_modules/@types/node/globals.d.ts:27 | +| `stackTraceLimit` | `static` | `number` | - | `Error.stackTraceLimit` | testplane/node\_modules/@types/node/globals.d.ts:29 | + +## Methods + +### captureStackTrace() + +```ts +static captureStackTrace(targetObject, constructorOpt?): void +``` + +Create .stack property on a target object + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `targetObject` | `object` | +| `constructorOpt`? | `Function` | + +#### Returns + +`void` + +#### Inherited from + +`Error.captureStackTrace` + +#### Defined in + +testplane/node\_modules/@types/node/globals.d.ts:20 diff --git a/i18n/en/docusaurus-plugin-content-docs/current/api-reference/classes/ImageDiffError.mdx b/i18n/en/docusaurus-plugin-content-docs/current/api-reference/classes/ImageDiffError.mdx new file mode 100644 index 0000000..c495631 --- /dev/null +++ b/i18n/en/docusaurus-plugin-content-docs/current/api-reference/classes/ImageDiffError.mdx @@ -0,0 +1,177 @@ +[testplane](../README.mdx) / ImageDiffError + +# Class: ImageDiffError + +## Extends + +- `BaseStateError` + +## Constructors + +### new ImageDiffError() + +```ts +new ImageDiffError(__namedParameters): ImageDiffError +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `object` | +| `__namedParameters.currImg` | [`ImageInfo`](../interfaces/ImageInfo.mdx) | +| `__namedParameters.diffAreas`? | `DiffAreas` | +| `__namedParameters.diffBuffer` | `Buffer` | +| `__namedParameters.diffOpts` | `DiffOptions` | +| `__namedParameters.diffRatio` | `number` | +| `__namedParameters.differentPixels` | `number` | +| `__namedParameters.refImg` | [`RefImageInfo`](../interfaces/RefImageInfo.mdx) | +| `__namedParameters.stateName` | `string` | + +#### Returns + +[`ImageDiffError`](ImageDiffError.mdx) + +#### Overrides + +`BaseStateError.constructor` + +#### Defined in + +testplane-docs/.testplane/src/browser/commands/assert-view/errors/image-diff-error.ts:79 + +## Properties + +| Property | Modifier | Type | Description | Overrides | Inherited from | Defined in | +| ------ | ------ | ------ | ------ | ------ | ------ | ------ | +| `currImg` | `public` | [`ImageInfo`](../interfaces/ImageInfo.mdx) | - | - | `BaseStateError.currImg` | testplane-docs/.testplane/src/browser/commands/assert-view/errors/base-state-error.ts:4 | +| `diffBounds?` | `public` | `CoordBounds` | - | - | - | testplane-docs/.testplane/src/browser/commands/assert-view/errors/image-diff-error.ts:43 | +| `diffBuffer` | `public` | `Buffer` | - | - | - | testplane-docs/.testplane/src/browser/commands/assert-view/errors/image-diff-error.ts:45 | +| `diffClusters?` | `public` | `CoordBounds`[] | - | - | - | testplane-docs/.testplane/src/browser/commands/assert-view/errors/image-diff-error.ts:44 | +| `diffOpts` | `public` | `DiffOptions` | - | - | - | testplane-docs/.testplane/src/browser/commands/assert-view/errors/image-diff-error.ts:42 | +| `diffRatio` | `public` | `number` | - | - | - | testplane-docs/.testplane/src/browser/commands/assert-view/errors/image-diff-error.ts:47 | +| `differentPixels` | `public` | `number` | - | - | - | testplane-docs/.testplane/src/browser/commands/assert-view/errors/image-diff-error.ts:46 | +| `message` | `public` | `string` | - | `BaseStateError.message` | - | testplane-docs/.testplane/src/browser/commands/assert-view/errors/image-diff-error.ts:41 | +| `name` | `public` | `string` | - | - | `BaseStateError.name` | testplane-docs/node\_modules/typescript/lib/lib.es5.d.ts:1076 | +| `refImg` | `public` | [`RefImageInfo`](../interfaces/RefImageInfo.mdx) | - | - | `BaseStateError.refImg` | testplane-docs/.testplane/src/browser/commands/assert-view/errors/base-state-error.ts:4 | +| `stack?` | `public` | `string` | - | - | `BaseStateError.stack` | testplane-docs/node\_modules/typescript/lib/lib.es5.d.ts:1078 | +| `stateName` | `public` | `string` | - | - | `BaseStateError.stateName` | testplane-docs/.testplane/src/browser/commands/assert-view/errors/base-state-error.ts:4 | +| `prepareStackTrace?` | `static` | (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` | Optional override for formatting stack traces **See** https://v8.dev/docs/stack-trace-api#customizing-stack-traces | - | `BaseStateError.prepareStackTrace` | testplane/node\_modules/@types/node/globals.d.ts:27 | +| `stackTraceLimit` | `static` | `number` | - | - | `BaseStateError.stackTraceLimit` | testplane/node\_modules/@types/node/globals.d.ts:29 | + +## Methods + +### saveDiffTo() + +```ts +saveDiffTo(diffPath): Promise +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `diffPath` | `string` | + +#### Returns + +`Promise`\<`null`\> + +#### Defined in + +testplane-docs/.testplane/src/browser/commands/assert-view/errors/image-diff-error.ts:109 + +*** + +### captureStackTrace() + +```ts +static captureStackTrace(targetObject, constructorOpt?): void +``` + +Create .stack property on a target object + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `targetObject` | `object` | +| `constructorOpt`? | `Function` | + +#### Returns + +`void` + +#### Inherited from + +`BaseStateError.captureStackTrace` + +#### Defined in + +testplane/node\_modules/@types/node/globals.d.ts:20 + +*** + +### create() + +```ts +static create(this, __namedParameters): T +``` + +#### Type Parameters + +| Type Parameter | +| ------ | +| `T` *extends* [`ImageDiffError`](ImageDiffError.mdx) | + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `this` | `ImageDiffErrorConstructor`\<`T`\> | +| `__namedParameters` | `object` | +| `__namedParameters.currImg` | [`ImageInfo`](../interfaces/ImageInfo.mdx) | +| `__namedParameters.diffAreas`? | `DiffAreas` | +| `__namedParameters.diffBuffer` | `Buffer` | +| `__namedParameters.diffOpts` | `DiffOptions` | +| `__namedParameters.diffRatio` | `number` | +| `__namedParameters.differentPixels` | `number` | +| `__namedParameters.refImg` | [`RefImageInfo`](../interfaces/RefImageInfo.mdx) | +| `__namedParameters.stateName` | `string` | + +#### Returns + +`T` + +#### Defined in + +testplane-docs/.testplane/src/browser/commands/assert-view/errors/image-diff-error.ts:49 + +*** + +### fromObject() + +```ts +static fromObject(this, data): T +``` + +#### Type Parameters + +| Type Parameter | +| ------ | +| `T` | + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `this` | `ImageDiffErrorConstructor`\<`T`\> | +| `data` | `ImageDiffErrorData` | + +#### Returns + +`T` + +#### Defined in + +testplane-docs/.testplane/src/browser/commands/assert-view/errors/image-diff-error.ts:74 diff --git a/i18n/en/docusaurus-plugin-content-docs/current/api-reference/classes/NoRefImageError.mdx b/i18n/en/docusaurus-plugin-content-docs/current/api-reference/classes/NoRefImageError.mdx new file mode 100644 index 0000000..2128ed9 --- /dev/null +++ b/i18n/en/docusaurus-plugin-content-docs/current/api-reference/classes/NoRefImageError.mdx @@ -0,0 +1,144 @@ +[testplane](../README.mdx) / NoRefImageError + +# Class: NoRefImageError + +## Extends + +- `BaseStateError` + +## Constructors + +### new NoRefImageError() + +```ts +new NoRefImageError( + stateName, + currImg, + refImg): NoRefImageError +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `stateName` | `string` | +| `currImg` | [`ImageInfo`](../interfaces/ImageInfo.mdx) | +| `refImg` | [`RefImageInfo`](../interfaces/RefImageInfo.mdx) | + +#### Returns + +[`NoRefImageError`](NoRefImageError.mdx) + +#### Overrides + +`BaseStateError.constructor` + +#### Defined in + +testplane-docs/.testplane/src/browser/commands/assert-view/errors/no-ref-image-error.ts:26 + +## Properties + +| Property | Modifier | Type | Description | Inherited from | Defined in | +| ------ | ------ | ------ | ------ | ------ | ------ | +| `currImg` | `public` | [`ImageInfo`](../interfaces/ImageInfo.mdx) | - | `BaseStateError.currImg` | testplane-docs/.testplane/src/browser/commands/assert-view/errors/base-state-error.ts:4 | +| `message` | `public` | `string` | - | `BaseStateError.message` | testplane-docs/node\_modules/typescript/lib/lib.es5.d.ts:1077 | +| `name` | `public` | `string` | - | `BaseStateError.name` | testplane-docs/node\_modules/typescript/lib/lib.es5.d.ts:1076 | +| `refImg` | `public` | [`RefImageInfo`](../interfaces/RefImageInfo.mdx) | - | `BaseStateError.refImg` | testplane-docs/.testplane/src/browser/commands/assert-view/errors/base-state-error.ts:4 | +| `stack?` | `public` | `string` | - | `BaseStateError.stack` | testplane-docs/node\_modules/typescript/lib/lib.es5.d.ts:1078 | +| `stateName` | `public` | `string` | - | `BaseStateError.stateName` | testplane-docs/.testplane/src/browser/commands/assert-view/errors/base-state-error.ts:4 | +| `prepareStackTrace?` | `static` | (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` | Optional override for formatting stack traces **See** https://v8.dev/docs/stack-trace-api#customizing-stack-traces | `BaseStateError.prepareStackTrace` | testplane/node\_modules/@types/node/globals.d.ts:27 | +| `stackTraceLimit` | `static` | `number` | - | `BaseStateError.stackTraceLimit` | testplane/node\_modules/@types/node/globals.d.ts:29 | + +## Methods + +### captureStackTrace() + +```ts +static captureStackTrace(targetObject, constructorOpt?): void +``` + +Create .stack property on a target object + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `targetObject` | `object` | +| `constructorOpt`? | `Function` | + +#### Returns + +`void` + +#### Inherited from + +`BaseStateError.captureStackTrace` + +#### Defined in + +testplane/node\_modules/@types/node/globals.d.ts:20 + +*** + +### create() + +```ts +static create( + this, + stateName, + currImg, + refImg): T +``` + +#### Type Parameters + +| Type Parameter | +| ------ | +| `T` *extends* [`NoRefImageError`](NoRefImageError.mdx) | + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `this` | `NoRefImageErrorConstructor`\<`T`\> | +| `stateName` | `string` | +| `currImg` | [`ImageInfo`](../interfaces/ImageInfo.mdx) | +| `refImg` | [`RefImageInfo`](../interfaces/RefImageInfo.mdx) | + +#### Returns + +`T` + +#### Defined in + +testplane-docs/.testplane/src/browser/commands/assert-view/errors/no-ref-image-error.ts:13 + +*** + +### fromObject() + +```ts +static fromObject(this, data): T +``` + +#### Type Parameters + +| Type Parameter | +| ------ | +| `T` *extends* [`NoRefImageError`](NoRefImageError.mdx) | + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `this` | `NoRefImageErrorConstructor`\<`T`\> | +| `data` | `NoRefImageErrorData` | + +#### Returns + +`T` + +#### Defined in + +testplane-docs/.testplane/src/browser/commands/assert-view/errors/no-ref-image-error.ts:22 diff --git a/i18n/en/docusaurus-plugin-content-docs/current/api-reference/classes/OffsetViewportError.mdx b/i18n/en/docusaurus-plugin-content-docs/current/api-reference/classes/OffsetViewportError.mdx new file mode 100644 index 0000000..098577a --- /dev/null +++ b/i18n/en/docusaurus-plugin-content-docs/current/api-reference/classes/OffsetViewportError.mdx @@ -0,0 +1,74 @@ +[testplane](../README.mdx) / OffsetViewportError + +# Class: OffsetViewportError + +Position of an element is outside of a viewport left, top or right bounds + +## Extends + +- `Error` + +## Constructors + +### new OffsetViewportError() + +```ts +new OffsetViewportError(message): OffsetViewportError +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +#### Returns + +[`OffsetViewportError`](OffsetViewportError.mdx) + +#### Overrides + +`Error.constructor` + +#### Defined in + +testplane-docs/.testplane/src/browser/screen-shooter/viewport/coord-validator/errors/offset-viewport-error.ts:5 + +## Properties + +| Property | Modifier | Type | Description | Inherited from | Defined in | +| ------ | ------ | ------ | ------ | ------ | ------ | +| `message` | `public` | `string` | - | `Error.message` | testplane-docs/node\_modules/typescript/lib/lib.es5.d.ts:1077 | +| `name` | `public` | `string` | - | `Error.name` | testplane-docs/node\_modules/typescript/lib/lib.es5.d.ts:1076 | +| `stack?` | `public` | `string` | - | `Error.stack` | testplane-docs/node\_modules/typescript/lib/lib.es5.d.ts:1078 | +| `prepareStackTrace?` | `static` | (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` | Optional override for formatting stack traces **See** https://v8.dev/docs/stack-trace-api#customizing-stack-traces | `Error.prepareStackTrace` | testplane/node\_modules/@types/node/globals.d.ts:27 | +| `stackTraceLimit` | `static` | `number` | - | `Error.stackTraceLimit` | testplane/node\_modules/@types/node/globals.d.ts:29 | + +## Methods + +### captureStackTrace() + +```ts +static captureStackTrace(targetObject, constructorOpt?): void +``` + +Create .stack property on a target object + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `targetObject` | `object` | +| `constructorOpt`? | `Function` | + +#### Returns + +`void` + +#### Inherited from + +`Error.captureStackTrace` + +#### Defined in + +testplane/node\_modules/@types/node/globals.d.ts:20 diff --git a/i18n/en/docusaurus-plugin-content-docs/current/api-reference/classes/Suite.mdx b/i18n/en/docusaurus-plugin-content-docs/current/api-reference/classes/Suite.mdx new file mode 100644 index 0000000..49001f3 --- /dev/null +++ b/i18n/en/docusaurus-plugin-content-docs/current/api-reference/classes/Suite.mdx @@ -0,0 +1,766 @@ +[testplane](../README.mdx) / Suite + +# Class: Suite + +## Extends + +- `ConfigurableTestObject` + +## Extended by + +- [`RootSuite`](../interfaces/RootSuite.mdx) + +## Constructors + +### new Suite() + +```ts +new Suite(__namedParameters): Suite +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `SuiteOpts` | + +#### Returns + +[`Suite`](Suite.mdx) + +#### Overrides + +`ConfigurableTestObject.constructor` + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/suite.ts:20 + +## Properties + +| Property | Modifier | Type | Default value | Inherited from | Defined in | +| ------ | ------ | ------ | ------ | ------ | ------ | +| `parent` | `public` | `null` \| [`Suite`](Suite.mdx) | `null` | `ConfigurableTestObject.parent` | testplane-docs/.testplane/src/test-reader/test-object/test-object.ts:6 | + +## Accessors + +### afterEachHooks + +```ts +get afterEachHooks(): Hook[] +``` + +#### Returns + +`Hook`[] + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/suite.ts:95 + +*** + +### beforeEachHooks + +```ts +get beforeEachHooks(): Hook[] +``` + +#### Returns + +`Hook`[] + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/suite.ts:91 + +*** + +### browserId + +```ts +get browserId(): string +``` + +```ts +set browserId(id): void +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `id` | `string` | + +#### Returns + +`string` + +#### Inherited from + +`ConfigurableTestObject.browserId` + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/configurable-test-object.ts:93 + +*** + +### browserVersion + +```ts +get browserVersion(): undefined | string +``` + +```ts +set browserVersion(version): void +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `version` | `string` | + +#### Returns + +`undefined` \| `string` + +#### Inherited from + +`ConfigurableTestObject.browserVersion` + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/configurable-test-object.ts:101 + +*** + +### disabled + +```ts +get disabled(): boolean +``` + +```ts +set disabled(val): void +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `val` | `boolean` | + +#### Returns + +`boolean` + +#### Inherited from + +`ConfigurableTestObject.disabled` + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/configurable-test-object.ts:69 + +*** + +### file + +```ts +get file(): string +``` + +#### Returns + +`string` + +#### Inherited from + +`ConfigurableTestObject.file` + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/configurable-test-object.ts:45 + +*** + +### hasBrowserVersionOverwritten + +```ts +get hasBrowserVersionOverwritten(): boolean +``` + +#### Returns + +`boolean` + +#### Inherited from + +`ConfigurableTestObject.hasBrowserVersionOverwritten` + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/configurable-test-object.ts:105 + +*** + +### id + +```ts +get id(): string +``` + +#### Returns + +`string` + +#### Inherited from + +`ConfigurableTestObject.id` + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/configurable-test-object.ts:41 + +*** + +### pending + +```ts +get pending(): boolean +``` + +```ts +set pending(val): void +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `val` | `boolean` | + +#### Returns + +`boolean` + +#### Inherited from + +`ConfigurableTestObject.pending` + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/configurable-test-object.ts:53 + +*** + +### root + +```ts +get root(): boolean +``` + +#### Returns + +`boolean` + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/suite.ts:79 + +*** + +### silentSkip + +```ts +get silentSkip(): boolean +``` + +```ts +set silentSkip(val): void +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `val` | `boolean` | + +#### Returns + +`boolean` + +#### Inherited from + +`ConfigurableTestObject.silentSkip` + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/configurable-test-object.ts:77 + +*** + +### skipReason + +```ts +get skipReason(): string +``` + +```ts +set skipReason(reason): void +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `reason` | `string` | + +#### Returns + +`string` + +#### Inherited from + +`ConfigurableTestObject.skipReason` + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/configurable-test-object.ts:61 + +*** + +### suites + +```ts +get suites(): Suite[] +``` + +#### Returns + +[`Suite`](Suite.mdx)[] + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/suite.ts:83 + +*** + +### tests + +```ts +get tests(): Test[] +``` + +#### Returns + +[`Test`](Test.mdx)[] + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/suite.ts:87 + +*** + +### timeout + +```ts +get timeout(): number +``` + +```ts +set timeout(timeout): void +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `timeout` | `number` | + +#### Returns + +`number` + +#### Inherited from + +`ConfigurableTestObject.timeout` + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/configurable-test-object.ts:85 + +*** + +### title + +```ts +get title(): string +``` + +#### Returns + +`string` + +#### Inherited from + +`ConfigurableTestObject.title` + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/test-object.ts:16 + +## Methods + +### addAfterEachHook() + +```ts +addAfterEachHook(hook): this +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `hook` | `Hook` | + +#### Returns + +`this` + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/suite.ts:41 + +*** + +### addBeforeEachHook() + +```ts +addBeforeEachHook(hook): this +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `hook` | `Hook` | + +#### Returns + +`this` + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/suite.ts:37 + +*** + +### addSuite() + +```ts +addSuite(suite): this +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `suite` | [`Suite`](Suite.mdx) | + +#### Returns + +`this` + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/suite.ts:29 + +*** + +### addTest() + +```ts +addTest(test): this +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `test` | [`Test`](Test.mdx) | + +#### Returns + +`this` + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/suite.ts:33 + +*** + +### afterEach() + +```ts +afterEach(fn): this +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `fn` | `TestFunction`\<[`TestFunctionCtx`](../interfaces/TestFunctionCtx.mdx)\> | + +#### Returns + +`this` + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/suite.ts:49 + +*** + +### assign() + +```ts +assign(src): this +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `src` | `this` | + +#### Returns + +`this` + +#### Inherited from + +`ConfigurableTestObject.assign` + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/configurable-test-object.ts:20 + +*** + +### beforeEach() + +```ts +beforeEach(fn): this +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `fn` | `TestFunction`\<[`TestFunctionCtx`](../interfaces/TestFunctionCtx.mdx)\> | + +#### Returns + +`this` + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/suite.ts:45 + +*** + +### disable() + +```ts +disable(): void +``` + +#### Returns + +`void` + +#### Inherited from + +`ConfigurableTestObject.disable` + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/configurable-test-object.ts:31 + +*** + +### eachTest() + +```ts +eachTest(cb): void +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `cb` | (`test`) => `void` | + +#### Returns + +`void` + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/suite.ts:60 + +*** + +### enable() + +```ts +enable(): void +``` + +#### Returns + +`void` + +#### Inherited from + +`ConfigurableTestObject.enable` + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/configurable-test-object.ts:36 + +*** + +### filterTests() + +```ts +filterTests(cb): this +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `cb` | (`test`) => `unknown` | + +#### Returns + +`this` + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/suite.ts:70 + +*** + +### fullTitle() + +```ts +fullTitle(): string +``` + +#### Returns + +`string` + +#### Inherited from + +`ConfigurableTestObject.fullTitle` + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/test-object.ts:30 + +*** + +### getTests() + +```ts +getTests(): Test[] +``` + +#### Returns + +[`Test`](Test.mdx)[] + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/suite.ts:65 + +*** + +### skip() + +```ts +skip(__namedParameters): void +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `SkipData` | + +#### Returns + +`void` + +#### Inherited from + +`ConfigurableTestObject.skip` + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/configurable-test-object.ts:26 + +*** + +### titlePath() + +```ts +titlePath(): string[] +``` + +#### Returns + +`string`[] + +#### Inherited from + +`ConfigurableTestObject.titlePath` + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/test-object.ts:20 + +*** + +### create() + +```ts +static create(this, opts): T +``` + +#### Type Parameters + +| Type Parameter | +| ------ | +| `T` *extends* [`Suite`](Suite.mdx) | + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `this` | (`opts`) => `T` | +| `opts` | `SuiteOpts` | + +#### Returns + +`T` + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/suite.ts:15 diff --git a/i18n/en/docusaurus-plugin-content-docs/current/api-reference/classes/Test.mdx b/i18n/en/docusaurus-plugin-content-docs/current/api-reference/classes/Test.mdx new file mode 100644 index 0000000..9717a80 --- /dev/null +++ b/i18n/en/docusaurus-plugin-content-docs/current/api-reference/classes/Test.mdx @@ -0,0 +1,512 @@ +[testplane](../README.mdx) / Test + +# Class: Test + +## Extends + +- `ConfigurableTestObject` + +## Extended by + +- [`TestResult`](../interfaces/TestResult.mdx) + +## Constructors + +### new Test() + +```ts +new Test(__namedParameters): Test +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `TestOpts` | + +#### Returns + +[`Test`](Test.mdx) + +#### Overrides + +`ConfigurableTestObject.constructor` + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/test.ts:17 + +## Properties + +| Property | Modifier | Type | Default value | Inherited from | Defined in | +| ------ | ------ | ------ | ------ | ------ | ------ | +| `err?` | `public` | `Error` | `undefined` | - | testplane-docs/.testplane/src/test-reader/test-object/test.ts:11 | +| `fn` | `public` | `TestFunction`\<[`TestFunctionCtx`](../interfaces/TestFunctionCtx.mdx)\> | `undefined` | - | testplane-docs/.testplane/src/test-reader/test-object/test.ts:10 | +| `parent` | `public` | `null` \| [`Suite`](Suite.mdx) | `null` | `ConfigurableTestObject.parent` | testplane-docs/.testplane/src/test-reader/test-object/test-object.ts:6 | + +## Accessors + +### browserId + +```ts +get browserId(): string +``` + +```ts +set browserId(id): void +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `id` | `string` | + +#### Returns + +`string` + +#### Inherited from + +`ConfigurableTestObject.browserId` + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/configurable-test-object.ts:93 + +*** + +### browserVersion + +```ts +get browserVersion(): undefined | string +``` + +```ts +set browserVersion(version): void +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `version` | `string` | + +#### Returns + +`undefined` \| `string` + +#### Inherited from + +`ConfigurableTestObject.browserVersion` + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/configurable-test-object.ts:101 + +*** + +### disabled + +```ts +get disabled(): boolean +``` + +```ts +set disabled(val): void +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `val` | `boolean` | + +#### Returns + +`boolean` + +#### Inherited from + +`ConfigurableTestObject.disabled` + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/configurable-test-object.ts:69 + +*** + +### file + +```ts +get file(): string +``` + +#### Returns + +`string` + +#### Inherited from + +`ConfigurableTestObject.file` + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/configurable-test-object.ts:45 + +*** + +### hasBrowserVersionOverwritten + +```ts +get hasBrowserVersionOverwritten(): boolean +``` + +#### Returns + +`boolean` + +#### Inherited from + +`ConfigurableTestObject.hasBrowserVersionOverwritten` + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/configurable-test-object.ts:105 + +*** + +### id + +```ts +get id(): string +``` + +#### Returns + +`string` + +#### Inherited from + +`ConfigurableTestObject.id` + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/configurable-test-object.ts:41 + +*** + +### pending + +```ts +get pending(): boolean +``` + +```ts +set pending(val): void +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `val` | `boolean` | + +#### Returns + +`boolean` + +#### Inherited from + +`ConfigurableTestObject.pending` + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/configurable-test-object.ts:53 + +*** + +### silentSkip + +```ts +get silentSkip(): boolean +``` + +```ts +set silentSkip(val): void +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `val` | `boolean` | + +#### Returns + +`boolean` + +#### Inherited from + +`ConfigurableTestObject.silentSkip` + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/configurable-test-object.ts:77 + +*** + +### skipReason + +```ts +get skipReason(): string +``` + +```ts +set skipReason(reason): void +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `reason` | `string` | + +#### Returns + +`string` + +#### Inherited from + +`ConfigurableTestObject.skipReason` + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/configurable-test-object.ts:61 + +*** + +### timeout + +```ts +get timeout(): number +``` + +```ts +set timeout(timeout): void +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `timeout` | `number` | + +#### Returns + +`number` + +#### Inherited from + +`ConfigurableTestObject.timeout` + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/configurable-test-object.ts:85 + +*** + +### title + +```ts +get title(): string +``` + +#### Returns + +`string` + +#### Inherited from + +`ConfigurableTestObject.title` + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/test-object.ts:16 + +## Methods + +### assign() + +```ts +assign(src): this +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `src` | `this` | + +#### Returns + +`this` + +#### Inherited from + +`ConfigurableTestObject.assign` + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/configurable-test-object.ts:20 + +*** + +### clone() + +```ts +clone(): Test +``` + +#### Returns + +[`Test`](Test.mdx) + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/test.ts:23 + +*** + +### disable() + +```ts +disable(): void +``` + +#### Returns + +`void` + +#### Inherited from + +`ConfigurableTestObject.disable` + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/configurable-test-object.ts:31 + +*** + +### enable() + +```ts +enable(): void +``` + +#### Returns + +`void` + +#### Inherited from + +`ConfigurableTestObject.enable` + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/configurable-test-object.ts:36 + +*** + +### fullTitle() + +```ts +fullTitle(): string +``` + +#### Returns + +`string` + +#### Inherited from + +`ConfigurableTestObject.fullTitle` + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/test-object.ts:30 + +*** + +### skip() + +```ts +skip(__namedParameters): void +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `SkipData` | + +#### Returns + +`void` + +#### Inherited from + +`ConfigurableTestObject.skip` + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/configurable-test-object.ts:26 + +*** + +### titlePath() + +```ts +titlePath(): string[] +``` + +#### Returns + +`string`[] + +#### Inherited from + +`ConfigurableTestObject.titlePath` + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/test-object.ts:20 + +*** + +### create() + +```ts +static create(this, opts): T +``` + +#### Type Parameters + +| Type Parameter | +| ------ | +| `T` *extends* [`Test`](Test.mdx) | + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `this` | (`opts`) => `T` | +| `opts` | `TestOpts` | + +#### Returns + +`T` + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/test.ts:13 diff --git a/i18n/en/docusaurus-plugin-content-docs/current/api-reference/classes/TestCollection.mdx b/i18n/en/docusaurus-plugin-content-docs/current/api-reference/classes/TestCollection.mdx new file mode 100644 index 0000000..d792fcd --- /dev/null +++ b/i18n/en/docusaurus-plugin-content-docs/current/api-reference/classes/TestCollection.mdx @@ -0,0 +1,374 @@ +[testplane](../README.mdx) / TestCollection + +# Class: TestCollection + +## Constructors + +### new TestCollection() + +```ts +new TestCollection(specs): TestCollection +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `specs` | `Record`\<`string`, [`Test`](Test.mdx)[]\> | + +#### Returns + +[`TestCollection`](TestCollection.mdx) + +#### Defined in + +testplane-docs/.testplane/src/test-collection.ts:20 + +## Methods + +### disableAll() + +```ts +disableAll(browserId?): this +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `browserId`? | `string` | + +#### Returns + +`this` + +#### Defined in + +testplane-docs/.testplane/src/test-collection.ts:122 + +*** + +### disableTest() + +```ts +disableTest(fullTitle, browserId?): this +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `fullTitle` | `string` | +| `browserId`? | `string` | + +#### Returns + +`this` + +#### Defined in + +testplane-docs/.testplane/src/test-collection.ts:136 + +*** + +### eachRootSuite() + +```ts +eachRootSuite(cb): void +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `cb` | (`root`, `browserId`) => `void` | + +#### Returns + +`void` + +#### Defined in + +testplane-docs/.testplane/src/test-collection.ts:30 + +*** + +### eachTest() + +#### eachTest(callback) + +```ts +eachTest(callback): void +``` + +##### Parameters + +| Parameter | Type | +| ------ | ------ | +| `callback` | `TestsCallback`\<`void`\> | + +##### Returns + +`void` + +##### Defined in + +testplane-docs/.testplane/src/test-collection.ts:87 + +#### eachTest(browserId, callback) + +```ts +eachTest(browserId, callback): void +``` + +##### Parameters + +| Parameter | Type | +| ------ | ------ | +| `browserId` | `undefined` \| `string` | +| `callback` | `TestsCallback`\<`void`\> | + +##### Returns + +`void` + +##### Defined in + +testplane-docs/.testplane/src/test-collection.ts:88 + +*** + +### eachTestByVersions() + +```ts +eachTestByVersions(browserId, cb): void +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `browserId` | `string` | +| `cb` | (`test`, `browserId`, `browserVersion`?) => `void` | + +#### Returns + +`void` + +#### Defined in + +testplane-docs/.testplane/src/test-collection.ts:102 + +*** + +### enableAll() + +```ts +enableAll(browserId?): this +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `browserId`? | `string` | + +#### Returns + +`this` + +#### Defined in + +testplane-docs/.testplane/src/test-collection.ts:153 + +*** + +### enableTest() + +```ts +enableTest(fullTitle, browserId?): this +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `fullTitle` | `string` | +| `browserId`? | `string` | + +#### Returns + +`this` + +#### Defined in + +testplane-docs/.testplane/src/test-collection.ts:163 + +*** + +### getBrowsers() + +```ts +getBrowsers(): string[] +``` + +#### Returns + +`string`[] + +#### Defined in + +testplane-docs/.testplane/src/test-collection.ts:43 + +*** + +### getRootSuite() + +```ts +getRootSuite(browserId): null | RootSuite +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `browserId` | `string` | + +#### Returns + +`null` \| [`RootSuite`](../interfaces/RootSuite.mdx) + +#### Defined in + +testplane-docs/.testplane/src/test-collection.ts:25 + +*** + +### mapTests() + +#### mapTests(cb) + +```ts +mapTests(cb): T[] +``` + +##### Type Parameters + +| Type Parameter | +| ------ | +| `T` | + +##### Parameters + +| Parameter | Type | +| ------ | ------ | +| `cb` | `TestsCallback`\<`T`\> | + +##### Returns + +`T`[] + +##### Defined in + +testplane-docs/.testplane/src/test-collection.ts:47 + +#### mapTests(browserId, cb) + +```ts +mapTests(browserId, cb): T[] +``` + +##### Type Parameters + +| Type Parameter | +| ------ | +| `T` | + +##### Parameters + +| Parameter | Type | +| ------ | ------ | +| `browserId` | `undefined` \| `string` | +| `cb` | `TestsCallback`\<`T`\> | + +##### Returns + +`T`[] + +##### Defined in + +testplane-docs/.testplane/src/test-collection.ts:48 + +*** + +### sortTests() + +#### sortTests(callback) + +```ts +sortTests(callback): this +``` + +##### Parameters + +| Parameter | Type | +| ------ | ------ | +| `callback` | `SortTestsCallback` | + +##### Returns + +`this` + +##### Defined in + +testplane-docs/.testplane/src/test-collection.ts:63 + +#### sortTests(browserId, callback) + +```ts +sortTests(browserId, callback): this +``` + +##### Parameters + +| Parameter | Type | +| ------ | ------ | +| `browserId` | `undefined` \| `string` | +| `callback` | `SortTestsCallback` | + +##### Returns + +`this` + +##### Defined in + +testplane-docs/.testplane/src/test-collection.ts:64 + +*** + +### create() + +```ts +static create(this, specs): T +``` + +#### Type Parameters + +| Type Parameter | +| ------ | +| `T` *extends* [`TestCollection`](TestCollection.mdx) | + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `this` | (`specs`) => `T` | +| `specs` | `Record`\<`string`, [`Test`](Test.mdx)[]\> | + +#### Returns + +`T` + +#### Defined in + +testplane-docs/.testplane/src/test-collection.ts:13 diff --git a/i18n/en/docusaurus-plugin-content-docs/current/api-reference/classes/Testplane.mdx b/i18n/en/docusaurus-plugin-content-docs/current/api-reference/classes/Testplane.mdx new file mode 100644 index 0000000..468bdbf --- /dev/null +++ b/i18n/en/docusaurus-plugin-content-docs/current/api-reference/classes/Testplane.mdx @@ -0,0 +1,1442 @@ +[testplane](../README.mdx) / Testplane + +# Class: Testplane + +## Extends + +- `BaseTestplane` + +## Constructors + +### new Testplane() + +```ts +new Testplane(config?): Testplane +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `config`? | `string` \| [`ConfigInput`](../type-aliases/ConfigInput.mdx) | + +#### Returns + +[`Testplane`](Testplane.mdx) + +#### Defined in + +testplane-docs/.testplane/src/testplane.ts:67 + +## Properties + +| Property | Modifier | Type | Description | Defined in | +| ------ | ------ | ------ | ------ | ------ | +| `on` | `public` | [`MasterEventHandler`](../type-aliases/MasterEventHandler.mdx)\<[`Testplane`](Testplane.mdx)\> | - | testplane-docs/.testplane/src/testplane.ts:57 | +| `once` | `public` | [`MasterEventHandler`](../type-aliases/MasterEventHandler.mdx)\<[`Testplane`](Testplane.mdx)\> | - | testplane-docs/.testplane/src/testplane.ts:58 | +| `prependListener` | `public` | [`MasterEventHandler`](../type-aliases/MasterEventHandler.mdx)\<[`Testplane`](Testplane.mdx)\> | - | testplane-docs/.testplane/src/testplane.ts:59 | +| `captureRejectionSymbol` | `readonly` | *typeof* `captureRejectionSymbol` | - | testplane/node\_modules/@types/node/events.d.ts:405 | +| `captureRejections` | `static` | `boolean` | Sets or gets the default captureRejection value for all emitters. | testplane/node\_modules/@types/node/events.d.ts:410 | +| `defaultMaxListeners` | `static` | `number` | - | testplane/node\_modules/@types/node/events.d.ts:411 | +| `errorMonitor` | `readonly` | *typeof* `errorMonitor` | This symbol shall be used to install a listener for only monitoring `'error'` events. Listeners installed using this symbol are called before the regular `'error'` listeners are called. Installing a listener using this symbol does not change the behavior once an `'error'` event is emitted, therefore the process will still crash if no regular `'error'` listener is installed. | testplane/node\_modules/@types/node/events.d.ts:404 | + +## Accessors + +### config + +```ts +get config(): Config +``` + +#### Returns + +[`Config`](Config.mdx) + +#### Defined in + +testplane-docs/.testplane/src/base-testplane.ts:45 + +*** + +### errors + +```ts +get errors(): { + AbortOnReconnectError: typeof AbortOnReconnectError; + AssertViewError: typeof AssertViewError; + CancelledError: typeof CancelledError; + ClientBridgeError: typeof ClientBridgeError; + CoreError: typeof CoreError; + HeightViewportError: typeof HeightViewportError; + ImageDiffError: typeof ImageDiffError; + NoRefImageError: typeof NoRefImageError; + OffsetViewportError: typeof OffsetViewportError; + TestplaneInternalError: typeof TestplaneInternalError; +} +``` + +#### Returns + +```ts +{ + AbortOnReconnectError: typeof AbortOnReconnectError; + AssertViewError: typeof AssertViewError; + CancelledError: typeof CancelledError; + ClientBridgeError: typeof ClientBridgeError; + CoreError: typeof CoreError; + HeightViewportError: typeof HeightViewportError; + ImageDiffError: typeof ImageDiffError; + NoRefImageError: typeof NoRefImageError; + OffsetViewportError: typeof OffsetViewportError; + TestplaneInternalError: typeof TestplaneInternalError; +} +``` + +| Name | Type | Defined in | +| ------ | ------ | ------ | +| `AbortOnReconnectError` | *typeof* [`AbortOnReconnectError`](AbortOnReconnectError.mdx) | testplane-docs/.testplane/src/errors.ts:34 | +| `AssertViewError` | *typeof* [`AssertViewError`](AssertViewError.mdx) | testplane-docs/.testplane/src/errors.ts:30 | +| `CancelledError` | *typeof* [`CancelledError`](CancelledError.mdx) | testplane-docs/.testplane/src/errors.ts:26 | +| `ClientBridgeError` | *typeof* [`ClientBridgeError`](ClientBridgeError.mdx) | testplane-docs/.testplane/src/errors.ts:27 | +| `CoreError` | *typeof* [`CoreError`](CoreError.mdx) | testplane-docs/.testplane/src/errors.ts:25 | +| `HeightViewportError` | *typeof* [`HeightViewportError`](HeightViewportError.mdx) | testplane-docs/.testplane/src/errors.ts:28 | +| `ImageDiffError` | *typeof* [`ImageDiffError`](ImageDiffError.mdx) | testplane-docs/.testplane/src/errors.ts:31 | +| `NoRefImageError` | *typeof* [`NoRefImageError`](NoRefImageError.mdx) | testplane-docs/.testplane/src/errors.ts:32 | +| `OffsetViewportError` | *typeof* [`OffsetViewportError`](OffsetViewportError.mdx) | testplane-docs/.testplane/src/errors.ts:29 | +| `TestplaneInternalError` | *typeof* [`TestplaneInternalError`](TestplaneInternalError.mdx) | testplane-docs/.testplane/src/errors.ts:33 | + +#### Defined in + +testplane-docs/.testplane/src/base-testplane.ts:53 + +*** + +### events + +```ts +get events(): { + AFTER_FILE_READ: MasterEvents.AFTER_FILE_READ; + AFTER_TESTS_READ: MasterEvents.AFTER_TESTS_READ; + BEFORE_FILE_READ: MasterEvents.BEFORE_FILE_READ; + BEGIN: "begin"; + CLI: "cli"; + END: "end"; + ERROR: "err"; + EXIT: "exit"; + INFO: "info"; + INIT: MasterEvents.INIT; + NEW_BROWSER: "newBrowser"; + NEW_WORKER_PROCESS: "newWorkerProcess"; + RETRY: "retry"; + RUNNER_END: "endRunner"; + RUNNER_START: "startRunner"; + SESSION_END: "endSession"; + SESSION_START: "startSession"; + SUITE_BEGIN: "beginSuite"; + SUITE_END: "endSuite"; + TEST_BEGIN: "beginTest"; + TEST_END: "endTest"; + TEST_FAIL: "failTest"; + TEST_PASS: "passTest"; + TEST_PENDING: "pendingTest"; + UPDATE_REFERENCE: "updateReference"; + WARNING: "warning"; +} +``` + +#### Returns + +```ts +{ + AFTER_FILE_READ: MasterEvents.AFTER_FILE_READ; + AFTER_TESTS_READ: MasterEvents.AFTER_TESTS_READ; + BEFORE_FILE_READ: MasterEvents.BEFORE_FILE_READ; + BEGIN: "begin"; + CLI: "cli"; + END: "end"; + ERROR: "err"; + EXIT: "exit"; + INFO: "info"; + INIT: MasterEvents.INIT; + NEW_BROWSER: "newBrowser"; + NEW_WORKER_PROCESS: "newWorkerProcess"; + RETRY: "retry"; + RUNNER_END: "endRunner"; + RUNNER_START: "startRunner"; + SESSION_END: "endSession"; + SESSION_START: "startSession"; + SUITE_BEGIN: "beginSuite"; + SUITE_END: "endSuite"; + TEST_BEGIN: "beginTest"; + TEST_END: "endTest"; + TEST_FAIL: "failTest"; + TEST_PASS: "passTest"; + TEST_PENDING: "pendingTest"; + UPDATE_REFERENCE: "updateReference"; + WARNING: "warning"; +} +``` + +| Name | Type | Default value | Defined in | +| ------ | ------ | ------ | ------ | +| `AFTER_FILE_READ` | `"afterFileRead"` | MasterEvents.AFTER\_FILE\_READ | testplane-docs/.testplane/src/events/index.ts:92 | +| `AFTER_TESTS_READ` | `"afterTestsRead"` | MasterEvents.AFTER\_TESTS\_READ | testplane-docs/.testplane/src/events/index.ts:94 | +| `BEFORE_FILE_READ` | `"beforeFileRead"` | MasterEvents.BEFORE\_FILE\_READ | testplane-docs/.testplane/src/events/index.ts:91 | +| `BEGIN` | `"begin"` | "begin" | testplane-docs/.testplane/src/events/index.ts:53 | +| `CLI` | `"cli"` | "cli" | testplane-docs/.testplane/src/events/index.ts:51 | +| `END` | `"end"` | "end" | testplane-docs/.testplane/src/events/index.ts:54 | +| `ERROR` | `"err"` | "err" | testplane-docs/.testplane/src/events/index.ts:63 | +| `EXIT` | `"exit"` | "exit" | testplane-docs/.testplane/src/events/index.ts:23 | +| `INFO` | `"info"` | "info" | testplane-docs/.testplane/src/events/index.ts:61 | +| `INIT` | `"init"` | MasterEvents.INIT | testplane-docs/.testplane/src/events/index.ts:89 | +| `NEW_BROWSER` | `"newBrowser"` | "newBrowser" | testplane-docs/.testplane/src/events/index.ts:96 | +| `NEW_WORKER_PROCESS` | `"newWorkerProcess"` | "newWorkerProcess" | testplane-docs/.testplane/src/events/index.ts:31 | +| `RETRY` | `"retry"` | "retry" | testplane-docs/.testplane/src/events/index.ts:43 | +| `RUNNER_END` | `"endRunner"` | "endRunner" | testplane-docs/.testplane/src/events/index.ts:18 | +| `RUNNER_START` | `"startRunner"` | "startRunner" | testplane-docs/.testplane/src/events/index.ts:17 | +| `SESSION_END` | `"endSession"` | "endSession" | testplane-docs/.testplane/src/events/index.ts:21 | +| `SESSION_START` | `"startSession"` | "startSession" | testplane-docs/.testplane/src/events/index.ts:20 | +| `SUITE_BEGIN` | `"beginSuite"` | "beginSuite" | testplane-docs/.testplane/src/events/index.ts:33 | +| `SUITE_END` | `"endSuite"` | "endSuite" | testplane-docs/.testplane/src/events/index.ts:34 | +| `TEST_BEGIN` | `"beginTest"` | "beginTest" | testplane-docs/.testplane/src/events/index.ts:36 | +| `TEST_END` | `"endTest"` | "endTest" | testplane-docs/.testplane/src/events/index.ts:37 | +| `TEST_FAIL` | `"failTest"` | "failTest" | testplane-docs/.testplane/src/events/index.ts:40 | +| `TEST_PASS` | `"passTest"` | "passTest" | testplane-docs/.testplane/src/events/index.ts:39 | +| `TEST_PENDING` | `"pendingTest"` | "pendingTest" | testplane-docs/.testplane/src/events/index.ts:41 | +| `UPDATE_REFERENCE` | `"updateReference"` | "updateReference" | testplane-docs/.testplane/src/events/index.ts:98 | +| `WARNING` | `"warning"` | "warning" | testplane-docs/.testplane/src/events/index.ts:62 | + +#### Defined in + +testplane-docs/.testplane/src/base-testplane.ts:49 + +## Methods + +### \[captureRejectionSymbol\]()? + +```ts +optional [captureRejectionSymbol]( + error, + event, ... + args): void +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `error` | `Error` | +| `event` | `string` | +| ...`args` | `any`[] | + +#### Returns + +`void` + +#### Defined in + +testplane/node\_modules/@types/node/events.d.ts:115 + +*** + +### addListener() + +```ts +addListener(eventName, listener): this +``` + +Alias for `emitter.on(eventName, listener)`. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `eventName` | `string` \| `symbol` | +| `listener` | (...`args`) => `void` | + +#### Returns + +`this` + +#### Since + +v0.1.26 + +#### Defined in + +testplane/node\_modules/@types/node/events.d.ts:475 + +*** + +### addTestToRun() + +```ts +addTestToRun(test, browserId): boolean +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `test` | [`Test`](Test.mdx) | +| `browserId` | `string` | + +#### Returns + +`boolean` + +#### Defined in + +testplane-docs/.testplane/src/testplane.ts:152 + +*** + +### emit() + +```ts +emit(eventName, ...args): boolean +``` + +Synchronously calls each of the listeners registered for the event named`eventName`, in the order they were registered, passing the supplied arguments +to each. + +Returns `true` if the event had listeners, `false` otherwise. + +```js +const EventEmitter = require('events'); +const myEmitter = new EventEmitter(); + +// First listener +myEmitter.on('event', function firstListener() { + console.log('Helloooo! first listener'); +}); +// Second listener +myEmitter.on('event', function secondListener(arg1, arg2) { + console.log(`event with parameters ${arg1}, ${arg2} in second listener`); +}); +// Third listener +myEmitter.on('event', function thirdListener(...args) { + const parameters = args.join(', '); + console.log(`event with parameters ${parameters} in third listener`); +}); + +console.log(myEmitter.listeners('event')); + +myEmitter.emit('event', 1, 2, 3, 4, 5); + +// Prints: +// [ +// [Function: firstListener], +// [Function: secondListener], +// [Function: thirdListener] +// ] +// Helloooo! first listener +// event with parameters 1, 2 in second listener +// event with parameters 1, 2, 3, 4, 5 in third listener +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `eventName` | `string` \| `symbol` | +| ...`args` | `any`[] | + +#### Returns + +`boolean` + +#### Since + +v0.1.26 + +#### Defined in + +testplane/node\_modules/@types/node/events.d.ts:731 + +*** + +### emitAndWait() + +```ts +emitAndWait(event, ...args): Promise +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `event` | `string` \| `symbol` | +| ...`args` | `unknown`[] | + +#### Returns + +`Promise`\<`unknown`[]\> + +#### Defined in + +testplane-docs/.testplane/src/events/async-emitter/index.ts:5 + +*** + +### eventNames() + +```ts +eventNames(): (string | symbol)[] +``` + +Returns an array listing the events for which the emitter has registered +listeners. The values in the array are strings or `Symbol`s. + +```js +const EventEmitter = require('events'); +const myEE = new EventEmitter(); +myEE.on('foo', () => {}); +myEE.on('bar', () => {}); + +const sym = Symbol('symbol'); +myEE.on(sym, () => {}); + +console.log(myEE.eventNames()); +// Prints: [ 'foo', 'bar', Symbol(symbol) ] +``` + +#### Returns + +(`string` \| `symbol`)[] + +#### Since + +v6.0.0 + +#### Defined in + +testplane/node\_modules/@types/node/events.d.ts:794 + +*** + +### extendCli() + +```ts +extendCli(parser): void +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `parser` | `Command` | + +#### Returns + +`void` + +#### Defined in + +testplane-docs/.testplane/src/testplane.ts:75 + +*** + +### getMaxListeners() + +```ts +getMaxListeners(): number +``` + +Returns the current max listener value for the `EventEmitter` which is either +set by `emitter.setMaxListeners(n)` or defaults to [defaultMaxListeners](Testplane.mdx). + +#### Returns + +`number` + +#### Since + +v1.0.0 + +#### Defined in + +testplane/node\_modules/@types/node/events.d.ts:647 + +*** + +### halt() + +```ts +halt(err, timeout): void +``` + +#### Parameters + +| Parameter | Type | Default value | +| ------ | ------ | ------ | +| `err` | `Error` | `undefined` | +| `timeout` | `number` | `60000` | + +#### Returns + +`void` + +#### Defined in + +testplane-docs/.testplane/src/testplane.ts:207 + +*** + +### intercept() + +```ts +intercept(event, handler): this +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `event` | [`InterceptedEvent`](../type-aliases/InterceptedEvent.mdx) | +| `handler` | [`InterceptHandler`](../type-aliases/InterceptHandler.mdx) | + +#### Returns + +`this` + +#### Defined in + +testplane-docs/.testplane/src/base-testplane.ts:57 + +*** + +### isFailed() + +```ts +isFailed(): boolean +``` + +#### Returns + +`boolean` + +#### Defined in + +testplane-docs/.testplane/src/testplane.ts:187 + +*** + +### isWorker() + +```ts +isWorker(): boolean +``` + +#### Returns + +`boolean` + +#### Defined in + +testplane-docs/.testplane/src/testplane.ts:203 + +*** + +### listenerCount() + +```ts +listenerCount(eventName, listener?): number +``` + +Returns the number of listeners listening to the event named `eventName`. + +If `listener` is provided, it will return how many times the listener +is found in the list of the listeners of the event. + +#### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `eventName` | `string` \| `symbol` | The name of the event being listened for | +| `listener`? | `Function` | The event handler function | + +#### Returns + +`number` + +#### Since + +v3.2.0 + +#### Defined in + +testplane/node\_modules/@types/node/events.d.ts:741 + +*** + +### listeners() + +```ts +listeners(eventName): Function[] +``` + +Returns a copy of the array of listeners for the event named `eventName`. + +```js +server.on('connection', (stream) => { + console.log('someone connected!'); +}); +console.log(util.inspect(server.listeners('connection'))); +// Prints: [ [Function] ] +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `eventName` | `string` \| `symbol` | + +#### Returns + +`Function`[] + +#### Since + +v0.1.26 + +#### Defined in + +testplane/node\_modules/@types/node/events.d.ts:660 + +*** + +### off() + +```ts +off(eventName, listener): this +``` + +Alias for `emitter.removeListener()`. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `eventName` | `string` \| `symbol` | +| `listener` | (...`args`) => `void` | + +#### Returns + +`this` + +#### Since + +v10.0.0 + +#### Defined in + +testplane/node\_modules/@types/node/events.d.ts:620 + +*** + +### prependOnceListener() + +```ts +prependOnceListener(eventName, listener): this +``` + +Adds a **one-time**`listener` function for the event named `eventName` to the _beginning_ of the listeners array. The next time `eventName` is triggered, this +listener is removed, and then invoked. + +```js +server.prependOnceListener('connection', (stream) => { + console.log('Ah, we have our first user!'); +}); +``` + +Returns a reference to the `EventEmitter`, so that calls can be chained. + +#### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `eventName` | `string` \| `symbol` | The name of the event. | +| `listener` | (...`args`) => `void` | The callback function | + +#### Returns + +`this` + +#### Since + +v6.0.0 + +#### Defined in + +testplane/node\_modules/@types/node/events.d.ts:775 + +*** + +### rawListeners() + +```ts +rawListeners(eventName): Function[] +``` + +Returns a copy of the array of listeners for the event named `eventName`, +including any wrappers (such as those created by `.once()`). + +```js +const emitter = new EventEmitter(); +emitter.once('log', () => console.log('log once')); + +// Returns a new Array with a function `onceWrapper` which has a property +// `listener` which contains the original listener bound above +const listeners = emitter.rawListeners('log'); +const logFnWrapper = listeners[0]; + +// Logs "log once" to the console and does not unbind the `once` event +logFnWrapper.listener(); + +// Logs "log once" to the console and removes the listener +logFnWrapper(); + +emitter.on('log', () => console.log('log persistently')); +// Will return a new Array with a single function bound by `.on()` above +const newListeners = emitter.rawListeners('log'); + +// Logs "log persistently" twice +newListeners[0](); +emitter.emit('log'); +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `eventName` | `string` \| `symbol` | + +#### Returns + +`Function`[] + +#### Since + +v9.4.0 + +#### Defined in + +testplane/node\_modules/@types/node/events.d.ts:690 + +*** + +### readTests() + +```ts +readTests(testPaths, __namedParameters): Promise +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `testPaths` | `string`[] | +| `__namedParameters` | `Partial`\<[`ReadTestsOpts`](../interfaces/ReadTestsOpts.mdx)\> | + +#### Returns + +`Promise`\<[`TestCollection`](TestCollection.mdx)\> + +#### Defined in + +testplane-docs/.testplane/src/testplane.ts:156 + +*** + +### removeAllListeners() + +```ts +removeAllListeners(event?): this +``` + +Removes all listeners, or those of the specified `eventName`. + +It is bad practice to remove listeners added elsewhere in the code, +particularly when the `EventEmitter` instance was created by some other +component or module (e.g. sockets or file streams). + +Returns a reference to the `EventEmitter`, so that calls can be chained. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `event`? | `string` \| `symbol` | + +#### Returns + +`this` + +#### Since + +v0.1.26 + +#### Defined in + +testplane/node\_modules/@types/node/events.d.ts:631 + +*** + +### removeListener() + +```ts +removeListener(eventName, listener): this +``` + +Removes the specified `listener` from the listener array for the event named`eventName`. + +```js +const callback = (stream) => { + console.log('someone connected!'); +}; +server.on('connection', callback); +// ... +server.removeListener('connection', callback); +``` + +`removeListener()` will remove, at most, one instance of a listener from the +listener array. If any single listener has been added multiple times to the +listener array for the specified `eventName`, then `removeListener()` must be +called multiple times to remove each instance. + +Once an event is emitted, all listeners attached to it at the +time of emitting are called in order. This implies that any`removeListener()` or `removeAllListeners()` calls _after_ emitting and _before_ the last listener finishes execution +will not remove them from`emit()` in progress. Subsequent events behave as expected. + +```js +const myEmitter = new MyEmitter(); + +const callbackA = () => { + console.log('A'); + myEmitter.removeListener('event', callbackB); +}; + +const callbackB = () => { + console.log('B'); +}; + +myEmitter.on('event', callbackA); + +myEmitter.on('event', callbackB); + +// callbackA removes listener callbackB but it will still be called. +// Internal listener array at time of emit [callbackA, callbackB] +myEmitter.emit('event'); +// Prints: +// A +// B + +// callbackB is now removed. +// Internal listener array [callbackA] +myEmitter.emit('event'); +// Prints: +// A +``` + +Because listeners are managed using an internal array, calling this will +change the position indices of any listener registered _after_ the listener +being removed. This will not impact the order in which listeners are called, +but it means that any copies of the listener array as returned by +the `emitter.listeners()` method will need to be recreated. + +When a single function has been added as a handler multiple times for a single +event (as in the example below), `removeListener()` will remove the most +recently added instance. In the example the `once('ping')`listener is removed: + +```js +const ee = new EventEmitter(); + +function pong() { + console.log('pong'); +} + +ee.on('ping', pong); +ee.once('ping', pong); +ee.removeListener('ping', pong); + +ee.emit('ping'); +ee.emit('ping'); +``` + +Returns a reference to the `EventEmitter`, so that calls can be chained. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `eventName` | `string` \| `symbol` | +| `listener` | (...`args`) => `void` | + +#### Returns + +`this` + +#### Since + +v0.1.26 + +#### Defined in + +testplane/node\_modules/@types/node/events.d.ts:615 + +*** + +### run() + +```ts +run(testPaths, __namedParameters): Promise +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `testPaths` | `string`[] \| [`TestCollection`](TestCollection.mdx) | +| `__namedParameters` | `Partial`\<[`RunOpts`](../interfaces/RunOpts.mdx)\> | + +#### Returns + +`Promise`\<`boolean`\> + +#### Defined in + +testplane-docs/.testplane/src/testplane.ts:89 + +*** + +### setMaxListeners() + +```ts +setMaxListeners(n): this +``` + +By default `EventEmitter`s will print a warning if more than `10` listeners are +added for a particular event. This is a useful default that helps finding +memory leaks. The `emitter.setMaxListeners()` method allows the limit to be +modified for this specific `EventEmitter` instance. The value can be set to`Infinity` (or `0`) to indicate an unlimited number of listeners. + +Returns a reference to the `EventEmitter`, so that calls can be chained. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `n` | `number` | + +#### Returns + +`this` + +#### Since + +v0.3.5 + +#### Defined in + +testplane/node\_modules/@types/node/events.d.ts:641 + +*** + +### addAbortListener() + +```ts +static addAbortListener(signal, resource): Disposable +``` + +**`Experimental`** + +Listens once to the `abort` event on the provided `signal`. + +Listening to the `abort` event on abort signals is unsafe and may +lead to resource leaks since another third party with the signal can +call `e.stopImmediatePropagation()`. Unfortunately Node.js cannot change +this since it would violate the web standard. Additionally, the original +API makes it easy to forget to remove listeners. + +This API allows safely using `AbortSignal`s in Node.js APIs by solving these +two issues by listening to the event such that `stopImmediatePropagation` does +not prevent the listener from running. + +Returns a disposable so that it may be unsubscribed from more easily. + +```js +import { addAbortListener } from 'node:events'; + +function example(signal) { + let disposable; + try { + signal.addEventListener('abort', (e) => e.stopImmediatePropagation()); + disposable = addAbortListener(signal, (e) => { + // Do something when signal is aborted. + }); + } finally { + disposable?.[Symbol.dispose](); + } +} +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `signal` | `AbortSignal` | +| `resource` | (`event`) => `void` | + +#### Returns + +`Disposable` + +Disposable that removes the `abort` listener. + +#### Since + +v18.18.0 + +#### Defined in + +testplane/node\_modules/@types/node/events.d.ts:394 + +*** + +### create() + +```ts +static create(this, config?): T +``` + +#### Type Parameters + +| Type Parameter | +| ------ | +| `T` *extends* `BaseTestplane` | + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `this` | (`config`?) => `T` | +| `config`? | `string` \| [`ConfigInput`](../type-aliases/ConfigInput.mdx) | + +#### Returns + +`T` + +#### Defined in + +testplane-docs/.testplane/src/base-testplane.ts:21 + +*** + +### getEventListeners() + +```ts +static getEventListeners(emitter, name): Function[] +``` + +Returns a copy of the array of listeners for the event named `eventName`. + +For `EventEmitter`s this behaves exactly the same as calling `.listeners` on +the emitter. + +For `EventTarget`s this is the only way to get the event listeners for the +event target. This is useful for debugging and diagnostic purposes. + +```js +const { getEventListeners, EventEmitter } = require('events'); + +{ + const ee = new EventEmitter(); + const listener = () => console.log('Events are fun'); + ee.on('foo', listener); + getEventListeners(ee, 'foo'); // [listener] +} +{ + const et = new EventTarget(); + const listener = () => console.log('Events are fun'); + et.addEventListener('foo', listener); + getEventListeners(et, 'foo'); // [listener] +} +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `emitter` | `EventEmitter` \| `_DOMEventTarget` | +| `name` | `string` \| `symbol` | + +#### Returns + +`Function`[] + +#### Since + +v15.2.0, v14.17.0 + +#### Defined in + +testplane/node\_modules/@types/node/events.d.ts:312 + +*** + +### getMaxListeners() + +```ts +static getMaxListeners(emitter): number +``` + +Returns the currently set max amount of listeners. + +For `EventEmitter`s this behaves exactly the same as calling `.getMaxListeners` on +the emitter. + +For `EventTarget`s this is the only way to get the max event listeners for the +event target. If the number of event handlers on a single EventTarget exceeds +the max set, the EventTarget will print a warning. + +```js +import { getMaxListeners, setMaxListeners, EventEmitter } from 'node:events'; + +{ + const ee = new EventEmitter(); + console.log(getMaxListeners(ee)); // 10 + setMaxListeners(11, ee); + console.log(getMaxListeners(ee)); // 11 +} +{ + const et = new EventTarget(); + console.log(getMaxListeners(et)); // 10 + setMaxListeners(11, et); + console.log(getMaxListeners(et)); // 11 +} +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `emitter` | `EventEmitter` \| `_DOMEventTarget` | + +#### Returns + +`number` + +#### Since + +v18.17.0 + +#### Defined in + +testplane/node\_modules/@types/node/events.d.ts:341 + +*** + +### ~~listenerCount()~~ + +```ts +static listenerCount(emitter, eventName): number +``` + +A class method that returns the number of listeners for the given `eventName`registered on the given `emitter`. + +```js +const { EventEmitter, listenerCount } = require('events'); +const myEmitter = new EventEmitter(); +myEmitter.on('event', () => {}); +myEmitter.on('event', () => {}); +console.log(listenerCount(myEmitter, 'event')); +// Prints: 2 +``` + +#### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `emitter` | `EventEmitter` | The emitter to query | +| `eventName` | `string` \| `symbol` | The event name | + +#### Returns + +`number` + +#### Since + +v0.9.12 + +#### Deprecated + +Since v3.2.0 - Use `listenerCount` instead. + +#### Defined in + +testplane/node\_modules/@types/node/events.d.ts:284 + +*** + +### on() + +```ts +static on( + emitter, + eventName, +options?): AsyncIterableIterator +``` + +```js +const { on, EventEmitter } = require('events'); + +(async () => { + const ee = new EventEmitter(); + + // Emit later on + process.nextTick(() => { + ee.emit('foo', 'bar'); + ee.emit('foo', 42); + }); + + for await (const event of on(ee, 'foo')) { + // The execution of this inner block is synchronous and it + // processes one event at a time (even with await). Do not use + // if concurrent execution is required. + console.log(event); // prints ['bar'] [42] + } + // Unreachable here +})(); +``` + +Returns an `AsyncIterator` that iterates `eventName` events. It will throw +if the `EventEmitter` emits `'error'`. It removes all listeners when +exiting the loop. The `value` returned by each iteration is an array +composed of the emitted event arguments. + +An `AbortSignal` can be used to cancel waiting on events: + +```js +const { on, EventEmitter } = require('events'); +const ac = new AbortController(); + +(async () => { + const ee = new EventEmitter(); + + // Emit later on + process.nextTick(() => { + ee.emit('foo', 'bar'); + ee.emit('foo', 42); + }); + + for await (const event of on(ee, 'foo', { signal: ac.signal })) { + // The execution of this inner block is synchronous and it + // processes one event at a time (even with await). Do not use + // if concurrent execution is required. + console.log(event); // prints ['bar'] [42] + } + // Unreachable here +})(); + +process.nextTick(() => ac.abort()); +``` + +#### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `emitter` | `EventEmitter` | - | +| `eventName` | `string` | The name of the event being listened for | +| `options`? | `StaticEventEmitterOptions` | - | + +#### Returns + +`AsyncIterableIterator`\<`any`\> + +that iterates `eventName` events emitted by the `emitter` + +#### Since + +v13.6.0, v12.16.0 + +#### Defined in + +testplane/node\_modules/@types/node/events.d.ts:263 + +*** + +### once() + +#### once(emitter, eventName, options) + +```ts +static once( + emitter, + eventName, +options?): Promise +``` + +Creates a `Promise` that is fulfilled when the `EventEmitter` emits the given +event or that is rejected if the `EventEmitter` emits `'error'` while waiting. +The `Promise` will resolve with an array of all the arguments emitted to the +given event. + +This method is intentionally generic and works with the web platform [EventTarget](https://dom.spec.whatwg.org/#interface-eventtarget) interface, which has no special`'error'` event +semantics and does not listen to the `'error'` event. + +```js +const { once, EventEmitter } = require('events'); + +async function run() { + const ee = new EventEmitter(); + + process.nextTick(() => { + ee.emit('myevent', 42); + }); + + const [value] = await once(ee, 'myevent'); + console.log(value); + + const err = new Error('kaboom'); + process.nextTick(() => { + ee.emit('error', err); + }); + + try { + await once(ee, 'myevent'); + } catch (err) { + console.log('error happened', err); + } +} + +run(); +``` + +The special handling of the `'error'` event is only used when `events.once()`is used to wait for another event. If `events.once()` is used to wait for the +'`error'` event itself, then it is treated as any other kind of event without +special handling: + +```js +const { EventEmitter, once } = require('events'); + +const ee = new EventEmitter(); + +once(ee, 'error') + .then(([err]) => console.log('ok', err.message)) + .catch((err) => console.log('error', err.message)); + +ee.emit('error', new Error('boom')); + +// Prints: ok boom +``` + +An `AbortSignal` can be used to cancel waiting for the event: + +```js +const { EventEmitter, once } = require('events'); + +const ee = new EventEmitter(); +const ac = new AbortController(); + +async function foo(emitter, event, signal) { + try { + await once(emitter, event, { signal }); + console.log('event emitted!'); + } catch (error) { + if (error.name === 'AbortError') { + console.error('Waiting for the event was canceled!'); + } else { + console.error('There was an error', error.message); + } + } +} + +foo(ee, 'foo', ac.signal); +ac.abort(); // Abort waiting for the event +ee.emit('foo'); // Prints: Waiting for the event was canceled! +``` + +##### Parameters + +| Parameter | Type | +| ------ | ------ | +| `emitter` | `_NodeEventTarget` | +| `eventName` | `string` \| `symbol` | +| `options`? | `StaticEventEmitterOptions` | + +##### Returns + +`Promise`\<`any`[]\> + +##### Since + +v11.13.0, v10.16.0 + +##### Defined in + +testplane/node\_modules/@types/node/events.d.ts:199 + +#### once(emitter, eventName, options) + +```ts +static once( + emitter, + eventName, +options?): Promise +``` + +##### Parameters + +| Parameter | Type | +| ------ | ------ | +| `emitter` | `_DOMEventTarget` | +| `eventName` | `string` | +| `options`? | `StaticEventEmitterOptions` | + +##### Returns + +`Promise`\<`any`[]\> + +##### Defined in + +testplane/node\_modules/@types/node/events.d.ts:204 + +*** + +### setMaxListeners() + +```ts +static setMaxListeners(n?, ...eventTargets?): void +``` + +```js +const { + setMaxListeners, + EventEmitter +} = require('events'); + +const target = new EventTarget(); +const emitter = new EventEmitter(); + +setMaxListeners(5, target, emitter); +``` + +#### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `n`? | `number` | A non-negative number. The maximum number of listeners per `EventTarget` event. | +| ...`eventTargets`? | (`EventEmitter` \| `_DOMEventTarget`)[] | - | + +#### Returns + +`void` + +#### Since + +v15.4.0 + +#### Defined in + +testplane/node\_modules/@types/node/events.d.ts:359 diff --git a/i18n/en/docusaurus-plugin-content-docs/current/api-reference/classes/TestplaneInternalError.mdx b/i18n/en/docusaurus-plugin-content-docs/current/api-reference/classes/TestplaneInternalError.mdx new file mode 100644 index 0000000..aa54e1e --- /dev/null +++ b/i18n/en/docusaurus-plugin-content-docs/current/api-reference/classes/TestplaneInternalError.mdx @@ -0,0 +1,72 @@ +[testplane](../README.mdx) / TestplaneInternalError + +# Class: TestplaneInternalError + +## Extends + +- `Error` + +## Constructors + +### new TestplaneInternalError() + +```ts +new TestplaneInternalError(message): TestplaneInternalError +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +#### Returns + +[`TestplaneInternalError`](TestplaneInternalError.mdx) + +#### Overrides + +`Error.constructor` + +#### Defined in + +testplane-docs/.testplane/src/errors/testplane-internal-error.ts:2 + +## Properties + +| Property | Modifier | Type | Description | Inherited from | Defined in | +| ------ | ------ | ------ | ------ | ------ | ------ | +| `message` | `public` | `string` | - | `Error.message` | testplane-docs/node\_modules/typescript/lib/lib.es5.d.ts:1077 | +| `name` | `public` | `string` | - | `Error.name` | testplane-docs/node\_modules/typescript/lib/lib.es5.d.ts:1076 | +| `stack?` | `public` | `string` | - | `Error.stack` | testplane-docs/node\_modules/typescript/lib/lib.es5.d.ts:1078 | +| `prepareStackTrace?` | `static` | (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` | Optional override for formatting stack traces **See** https://v8.dev/docs/stack-trace-api#customizing-stack-traces | `Error.prepareStackTrace` | testplane/node\_modules/@types/node/globals.d.ts:27 | +| `stackTraceLimit` | `static` | `number` | - | `Error.stackTraceLimit` | testplane/node\_modules/@types/node/globals.d.ts:29 | + +## Methods + +### captureStackTrace() + +```ts +static captureStackTrace(targetObject, constructorOpt?): void +``` + +Create .stack property on a target object + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `targetObject` | `object` | +| `constructorOpt`? | `Function` | + +#### Returns + +`void` + +#### Inherited from + +`Error.captureStackTrace` + +#### Defined in + +testplane/node\_modules/@types/node/globals.d.ts:20 diff --git a/i18n/en/docusaurus-plugin-content-docs/current/api-reference/interfaces/AfterFileReadData.mdx b/i18n/en/docusaurus-plugin-content-docs/current/api-reference/interfaces/AfterFileReadData.mdx new file mode 100644 index 0000000..fc4002a --- /dev/null +++ b/i18n/en/docusaurus-plugin-content-docs/current/api-reference/interfaces/AfterFileReadData.mdx @@ -0,0 +1,16 @@ +[testplane](../README.mdx) / AfterFileReadData + +# Interface: AfterFileReadData + +## Extended by + +- [`BeforeFileReadData`](BeforeFileReadData.mdx) + +## Properties + +| Property | Type | Description | Defined in | +| ------ | ------ | ------ | ------ | +| `browser` | `string` | - | testplane-docs/.testplane/src/types/index.ts:176 | +| `file` | `string` | - | testplane-docs/.testplane/src/types/index.ts:177 | +| ~~`hermione`~~ | [`GlobalHelper`](GlobalHelper.mdx) | **Deprecated** Use `testplane` instead | testplane-docs/.testplane/src/types/index.ts:175 | +| `testplane` | [`GlobalHelper`](GlobalHelper.mdx) | - | testplane-docs/.testplane/src/types/index.ts:171 | diff --git a/i18n/en/docusaurus-plugin-content-docs/current/api-reference/interfaces/AssertViewOpts.mdx b/i18n/en/docusaurus-plugin-content-docs/current/api-reference/interfaces/AssertViewOpts.mdx new file mode 100644 index 0000000..1722f00 --- /dev/null +++ b/i18n/en/docusaurus-plugin-content-docs/current/api-reference/interfaces/AssertViewOpts.mdx @@ -0,0 +1,22 @@ +[testplane](../README.mdx) / AssertViewOpts + +# Interface: AssertViewOpts + +## Extends + +- `Partial`\<[`AssertViewOptsConfig`](AssertViewOptsConfig.mdx)\> + +## Properties + +| Property | Type | Default value | Description | Inherited from | Defined in | +| ------ | ------ | ------ | ------ | ------ | ------ | +| `allowViewportOverflow?` | `boolean` | `false` | Disables check that element is outside of the viewport left, top, right or bottom bounds. **Remarks** By default Testplane throws an error if element is outside the viewport bounds. This option disables check that element is outside of the viewport left, top, right or bottom bounds. And in this case if browser option [compositeImage](https://github.com/gemini-testing/testplane#compositeimage) set to `false`, then only visible part of the element will be captured. But if [compositeImage](https://github.com/gemini-testing/testplane#compositeimage) set to `true` (default), then in the resulting screenshot will appear the whole element with not visible parts outside of the bottom bounds of viewport. | `Partial.allowViewportOverflow` | testplane-docs/.testplane/src/config/types.ts:45 | +| `antialiasingTolerance?` | `number` | `4` | Minimum difference in brightness (zero by default) between the darkest/lightest pixel (which is adjacent to the antialiasing pixel) and theirs adjacent pixels. Overrides config [browsers](https://github.com/gemini-testing/testplane#browsers).[antialiasingTolerance](https://github.com/gemini-testing/testplane#antialiasingTolerance) value. **Remarks** Read more about this option in [looks-same](https://github.com/gemini-testing/looks-same#comparing-images-with-ignoring-antialiasing) | - | testplane-docs/.testplane/src/browser/commands/types.ts:26 | +| `captureElementFromTop?` | `boolean` | `true` | Ability to set capture element from the top area or from current position. **Remarks** In the first case viewport will be scrolled to the top of the element. | `Partial.captureElementFromTop` | testplane-docs/.testplane/src/config/types.ts:33 | +| `compositeImage?` | `boolean` | `true` | Allows testing of regions which bottom bounds are outside of a viewport height. Overrides config [browsers](https://github.com/gemini-testing/testplane#browsers).[compositeImage](https://github.com/gemini-testing/testplane#compositeImage) value. **Remarks** In the resulting screenshot the area which fits the viewport bounds will be joined with the area which is outside of the viewport height. | - | testplane-docs/.testplane/src/browser/commands/types.ts:36 | +| `disableAnimation?` | `boolean` | `true` | Ability to disable animations and transitions while making a screenshot **Remarks** Usefull when you capture screenshot of a page, having animations and transitions. Iframe animations are only disabled when using webdriver protocol. | - | testplane-docs/.testplane/src/browser/commands/types.ts:67 | +| `ignoreDiffPixelCount?` | `number` \| \`$\{number\}%\` | `0` | Ability to ignore a small amount of different pixels to classify screenshots as being "identical" **Examples** `5` `'1.5%'` **Remarks** Useful when you encounter a few pixels difference that cannot be eliminated using the tolerance and antialiasingTolerance settings. **Note** This should be considered a last resort and only used in small number of cases where necessary. | - | testplane-docs/.testplane/src/browser/commands/types.ts:82 | +| `ignoreElements?` | `string` \| `string`[] | `[]` | DOM-node selectors which will be ignored (painted with a black rectangle) when comparing images. | `Partial.ignoreElements` | testplane-docs/.testplane/src/config/types.ts:24 | +| `screenshotDelay?` | `number` | `0` | Allows to specify a delay (in milliseconds) before making any screenshot. Overrides config [browsers](https://github.com/gemini-testing/testplane#browsers).[screenshotDelay](https://github.com/gemini-testing/testplane#screenshotDelay) value. **Remarks** This is useful when the page has elements which are animated or if you do not want to screen a scrollbar. | - | testplane-docs/.testplane/src/browser/commands/types.ts:46 | +| `selectorToScroll?` | `string` | `undefined` | Ability to set DOM-node selector which should be scroll when the captured element does not completely fit on the screen. **Remarks** Useful when you capture the modal (popup). In this case a duplicate of the modal appears on the screenshot. That happens because we scroll the page using `window` selector, which scroll only the background of the modal, and the modal itself remains in place. Default value is `undefined` (it means scroll relative to `window`). Works only when `compositeImage` is `true` (default). | - | testplane-docs/.testplane/src/browser/commands/types.ts:57 | +| `tolerance?` | `number` | `2.3` | Maximum allowed difference between colors. Overrides config [browsers](https://github.com/gemini-testing/testplane#browsers).[tolerance](https://github.com/gemini-testing/testplane#tolerance) value. **Remarks** Indicates maximum allowed CIEDE2000 difference between colors. Used only in non-strict mode. Increasing global default is not recommended, prefer changing tolerance for particular suites or states instead. By default it's 2.3 which should be enough for the most cases. | - | testplane-docs/.testplane/src/browser/commands/types.ts:16 | diff --git a/i18n/en/docusaurus-plugin-content-docs/current/api-reference/interfaces/AssertViewOptsConfig.mdx b/i18n/en/docusaurus-plugin-content-docs/current/api-reference/interfaces/AssertViewOptsConfig.mdx new file mode 100644 index 0000000..4fc018a --- /dev/null +++ b/i18n/en/docusaurus-plugin-content-docs/current/api-reference/interfaces/AssertViewOptsConfig.mdx @@ -0,0 +1,11 @@ +[testplane](../README.mdx) / AssertViewOptsConfig + +# Interface: AssertViewOptsConfig + +## Properties + +| Property | Type | Default value | Description | Defined in | +| ------ | ------ | ------ | ------ | ------ | +| `allowViewportOverflow` | `boolean` | `false` | Disables check that element is outside of the viewport left, top, right or bottom bounds. **Remarks** By default Testplane throws an error if element is outside the viewport bounds. This option disables check that element is outside of the viewport left, top, right or bottom bounds. And in this case if browser option [compositeImage](https://github.com/gemini-testing/testplane#compositeimage) set to `false`, then only visible part of the element will be captured. But if [compositeImage](https://github.com/gemini-testing/testplane#compositeimage) set to `true` (default), then in the resulting screenshot will appear the whole element with not visible parts outside of the bottom bounds of viewport. | testplane-docs/.testplane/src/config/types.ts:45 | +| `captureElementFromTop` | `boolean` | `true` | Ability to set capture element from the top area or from current position. **Remarks** In the first case viewport will be scrolled to the top of the element. | testplane-docs/.testplane/src/config/types.ts:33 | +| `ignoreElements` | `string` \| `string`[] | `[]` | DOM-node selectors which will be ignored (painted with a black rectangle) when comparing images. | testplane-docs/.testplane/src/config/types.ts:24 | diff --git a/i18n/en/docusaurus-plugin-content-docs/current/api-reference/interfaces/AssertViewResultDiff.mdx b/i18n/en/docusaurus-plugin-content-docs/current/api-reference/interfaces/AssertViewResultDiff.mdx new file mode 100644 index 0000000..0846dbf --- /dev/null +++ b/i18n/en/docusaurus-plugin-content-docs/current/api-reference/interfaces/AssertViewResultDiff.mdx @@ -0,0 +1,19 @@ +[testplane](../README.mdx) / AssertViewResultDiff + +# Interface: AssertViewResultDiff + +## Properties + +| Property | Type | Defined in | +| ------ | ------ | ------ | +| `currImg` | [`ImageInfo`](ImageInfo.mdx) | testplane-docs/.testplane/src/types/index.ts:83 | +| `diffBuffer?` | `ArrayBuffer` | testplane-docs/.testplane/src/types/index.ts:84 | +| `diffClusters` | `CoordBounds`[] | testplane-docs/.testplane/src/types/index.ts:85 | +| `diffOpts` | [`DiffOptions`](DiffOptions.mdx) | testplane-docs/.testplane/src/types/index.ts:86 | +| `diffRatio` | `number` | testplane-docs/.testplane/src/types/index.ts:93 | +| `differentPixels` | `number` | testplane-docs/.testplane/src/types/index.ts:92 | +| `message` | `string` | testplane-docs/.testplane/src/types/index.ts:87 | +| `name` | `"ImageDiffError"` | testplane-docs/.testplane/src/types/index.ts:88 | +| `refImg` | [`RefImageInfo`](RefImageInfo.mdx) | testplane-docs/.testplane/src/types/index.ts:89 | +| `stack` | `string` | testplane-docs/.testplane/src/types/index.ts:90 | +| `stateName` | `string` | testplane-docs/.testplane/src/types/index.ts:91 | diff --git a/i18n/en/docusaurus-plugin-content-docs/current/api-reference/interfaces/AssertViewResultNoRefImage.mdx b/i18n/en/docusaurus-plugin-content-docs/current/api-reference/interfaces/AssertViewResultNoRefImage.mdx new file mode 100644 index 0000000..a6a86f0 --- /dev/null +++ b/i18n/en/docusaurus-plugin-content-docs/current/api-reference/interfaces/AssertViewResultNoRefImage.mdx @@ -0,0 +1,14 @@ +[testplane](../README.mdx) / AssertViewResultNoRefImage + +# Interface: AssertViewResultNoRefImage + +## Properties + +| Property | Type | Defined in | +| ------ | ------ | ------ | +| `currImg` | [`ImageInfo`](ImageInfo.mdx) | testplane-docs/.testplane/src/types/index.ts:97 | +| `message` | `string` | testplane-docs/.testplane/src/types/index.ts:98 | +| `name` | `"NoRefImageError"` | testplane-docs/.testplane/src/types/index.ts:99 | +| `refImg` | [`RefImageInfo`](RefImageInfo.mdx) | testplane-docs/.testplane/src/types/index.ts:100 | +| `stack` | `string` | testplane-docs/.testplane/src/types/index.ts:101 | +| `stateName` | `string` | testplane-docs/.testplane/src/types/index.ts:102 | diff --git a/i18n/en/docusaurus-plugin-content-docs/current/api-reference/interfaces/AssertViewResultSuccess.mdx b/i18n/en/docusaurus-plugin-content-docs/current/api-reference/interfaces/AssertViewResultSuccess.mdx new file mode 100644 index 0000000..66fbcf6 --- /dev/null +++ b/i18n/en/docusaurus-plugin-content-docs/current/api-reference/interfaces/AssertViewResultSuccess.mdx @@ -0,0 +1,10 @@ +[testplane](../README.mdx) / AssertViewResultSuccess + +# Interface: AssertViewResultSuccess + +## Properties + +| Property | Type | Defined in | +| ------ | ------ | ------ | +| `refImg` | [`RefImageInfo`](RefImageInfo.mdx) | testplane-docs/.testplane/src/types/index.ts:78 | +| `stateName` | `string` | testplane-docs/.testplane/src/types/index.ts:79 | diff --git a/i18n/en/docusaurus-plugin-content-docs/current/api-reference/interfaces/BeforeFileReadData.mdx b/i18n/en/docusaurus-plugin-content-docs/current/api-reference/interfaces/BeforeFileReadData.mdx new file mode 100644 index 0000000..72559ac --- /dev/null +++ b/i18n/en/docusaurus-plugin-content-docs/current/api-reference/interfaces/BeforeFileReadData.mdx @@ -0,0 +1,17 @@ +[testplane](../README.mdx) / BeforeFileReadData + +# Interface: BeforeFileReadData + +## Extends + +- [`AfterFileReadData`](AfterFileReadData.mdx) + +## Properties + +| Property | Type | Description | Inherited from | Defined in | +| ------ | ------ | ------ | ------ | ------ | +| `browser` | `string` | - | [`AfterFileReadData`](AfterFileReadData.mdx).`browser` | testplane-docs/.testplane/src/types/index.ts:176 | +| `file` | `string` | - | [`AfterFileReadData`](AfterFileReadData.mdx).`file` | testplane-docs/.testplane/src/types/index.ts:177 | +| ~~`hermione`~~ | [`GlobalHelper`](GlobalHelper.mdx) | **Deprecated** Use `testplane` instead | [`AfterFileReadData`](AfterFileReadData.mdx).`hermione` | testplane-docs/.testplane/src/types/index.ts:175 | +| `testParser` | `TestParserAPI` | - | - | testplane-docs/.testplane/src/types/index.ts:181 | +| `testplane` | [`GlobalHelper`](GlobalHelper.mdx) | - | [`AfterFileReadData`](AfterFileReadData.mdx).`testplane` | testplane-docs/.testplane/src/types/index.ts:171 | diff --git a/i18n/en/docusaurus-plugin-content-docs/current/api-reference/interfaces/BrowserHistory.mdx b/i18n/en/docusaurus-plugin-content-docs/current/api-reference/interfaces/BrowserHistory.mdx new file mode 100644 index 0000000..e60e2fe --- /dev/null +++ b/i18n/en/docusaurus-plugin-content-docs/current/api-reference/interfaces/BrowserHistory.mdx @@ -0,0 +1,9 @@ +[testplane](../README.mdx) / BrowserHistory + +# Interface: BrowserHistory + +## Properties + +| Property | Type | Defined in | +| ------ | ------ | ------ | +| `runGroup` | (`callstack`: `Callstack`, `name`: `string`, `fn`: () => `unknown`) => `Promise`\<`unknown`\> | testplane-docs/.testplane/src/types/index.ts:185 | diff --git a/i18n/en/docusaurus-plugin-content-docs/current/api-reference/interfaces/BrowserInfo.mdx b/i18n/en/docusaurus-plugin-content-docs/current/api-reference/interfaces/BrowserInfo.mdx new file mode 100644 index 0000000..cd0c869 --- /dev/null +++ b/i18n/en/docusaurus-plugin-content-docs/current/api-reference/interfaces/BrowserInfo.mdx @@ -0,0 +1,10 @@ +[testplane](../README.mdx) / BrowserInfo + +# Interface: BrowserInfo + +## Properties + +| Property | Type | Defined in | +| ------ | ------ | ------ | +| `browserId` | `string` | testplane-docs/.testplane/src/types/index.ts:32 | +| `sessionId` | `string` | testplane-docs/.testplane/src/types/index.ts:33 | diff --git a/i18n/en/docusaurus-plugin-content-docs/current/api-reference/interfaces/BuildDiffOptsConfig.mdx b/i18n/en/docusaurus-plugin-content-docs/current/api-reference/interfaces/BuildDiffOptsConfig.mdx new file mode 100644 index 0000000..af5bdf1 --- /dev/null +++ b/i18n/en/docusaurus-plugin-content-docs/current/api-reference/interfaces/BuildDiffOptsConfig.mdx @@ -0,0 +1,10 @@ +[testplane](../README.mdx) / BuildDiffOptsConfig + +# Interface: BuildDiffOptsConfig + +## Properties + +| Property | Type | Defined in | +| ------ | ------ | ------ | +| `ignoreAntialiasing` | `boolean` | testplane-docs/.testplane/src/config/types.ts:14 | +| `ignoreCaret` | `boolean` | testplane-docs/.testplane/src/config/types.ts:15 | diff --git a/i18n/en/docusaurus-plugin-content-docs/current/api-reference/interfaces/CommandHistory.mdx b/i18n/en/docusaurus-plugin-content-docs/current/api-reference/interfaces/CommandHistory.mdx new file mode 100644 index 0000000..6be0bf8 --- /dev/null +++ b/i18n/en/docusaurus-plugin-content-docs/current/api-reference/interfaces/CommandHistory.mdx @@ -0,0 +1,15 @@ +[testplane](../README.mdx) / CommandHistory + +# Interface: CommandHistory + +## Properties + +| Property | Type | Description | Defined in | +| ------ | ------ | ------ | ------ | +| `a` | `unknown`[] | Arguments: array of passed arguments | testplane-docs/.testplane/src/types/index.ts:111 | +| `c` | [`CommandHistory`](CommandHistory.mdx)[] | Children: array of children commands | testplane-docs/.testplane/src/types/index.ts:121 | +| `d` | `number` | Duration | testplane-docs/.testplane/src/types/index.ts:117 | +| `n` | `string` | Name: command name | testplane-docs/.testplane/src/types/index.ts:109 | +| `s` | `"b"` \| `"e"` | Scope: scope of execution (browser or element) | testplane-docs/.testplane/src/types/index.ts:119 | +| `te` | `number` | Time end | testplane-docs/.testplane/src/types/index.ts:115 | +| `ts` | `number` | Time start | testplane-docs/.testplane/src/types/index.ts:113 | diff --git a/i18n/en/docusaurus-plugin-content-docs/current/api-reference/interfaces/CommonConfig.mdx b/i18n/en/docusaurus-plugin-content-docs/current/api-reference/interfaces/CommonConfig.mdx new file mode 100644 index 0000000..662b570 --- /dev/null +++ b/i18n/en/docusaurus-plugin-content-docs/current/api-reference/interfaces/CommonConfig.mdx @@ -0,0 +1,146 @@ +[testplane](../README.mdx) / CommonConfig + +# Interface: CommonConfig + +## Extended by + +- [`Config`](../classes/Config.mdx) + +## Properties + +| Property | Type | Defined in | +| ------ | ------ | ------ | +| `antialiasingTolerance` | `number` | testplane-docs/.testplane/src/config/types.ts:133 | +| `assertViewOpts` | [`AssertViewOptsConfig`](AssertViewOptsConfig.mdx) | testplane-docs/.testplane/src/config/types.ts:136 | +| `automationProtocol` | `"webdriver"` \| `"devtools"` | testplane-docs/.testplane/src/config/types.ts:97 | +| `baseUrl` | `string` | testplane-docs/.testplane/src/config/types.ts:104 | +| `buildDiffOpts` | [`BuildDiffOptsConfig`](BuildDiffOptsConfig.mdx) | testplane-docs/.testplane/src/config/types.ts:135 | +| `calibrate` | `boolean` | testplane-docs/.testplane/src/config/types.ts:127 | +| `compareOpts` | [`CompareOptsConfig`](CompareOptsConfig.mdx) | testplane-docs/.testplane/src/config/types.ts:134 | +| `compositeImage` | `boolean` | testplane-docs/.testplane/src/config/types.ts:128 | +| `configPath?` | `string` | testplane-docs/.testplane/src/config/types.ts:96 | +| `desiredCapabilities` | `null` \| `Capabilities` | testplane-docs/.testplane/src/config/types.ts:98 | +| `devServer` | \{ `args`: `string`[]; `command`: `null` \| `string`; `cwd`: `null` \| `string`; `env`: `Record`\<`string`, `string`\>; `logs`: `boolean`; `readinessProbe`: `ReadinessProbe`; \} | testplane-docs/.testplane/src/config/types.ts:170 | +| `devServer.args` | `string`[] | testplane-docs/.testplane/src/config/types.ts:174 | +| `devServer.command` | `null` \| `string` | testplane-docs/.testplane/src/config/types.ts:171 | +| `devServer.cwd` | `null` \| `string` | testplane-docs/.testplane/src/config/types.ts:172 | +| `devServer.env` | `Record`\<`string`, `string`\> | testplane-docs/.testplane/src/config/types.ts:173 | +| `devServer.logs` | `boolean` | testplane-docs/.testplane/src/config/types.ts:175 | +| `devServer.readinessProbe` | `ReadinessProbe` | testplane-docs/.testplane/src/config/types.ts:176 | +| `expectOpts` | [`ExpectOptsConfig`](ExpectOptsConfig.mdx) | testplane-docs/.testplane/src/config/types.ts:137 | +| `gridUrl` | `string` | testplane-docs/.testplane/src/config/types.ts:103 | +| `headers` | `null` \| `Record`\<`string`, `string`\> | testplane-docs/.testplane/src/config/types.ts:142 | +| `headless` | `null` \| `boolean` \| `"old"` \| `"new"` | testplane-docs/.testplane/src/config/types.ts:153 | +| `httpTimeout` | `number` | testplane-docs/.testplane/src/config/types.ts:109 | +| `isolation` | `boolean` | testplane-docs/.testplane/src/config/types.ts:154 | +| `key` | `null` \| `string` | testplane-docs/.testplane/src/config/types.ts:149 | +| `lastFailed` | \{ `input`: `string` \| `string`[]; `only`: `boolean`; `output`: `string`; \} | testplane-docs/.testplane/src/config/types.ts:156 | +| `lastFailed.input` | `string` \| `string`[] | testplane-docs/.testplane/src/config/types.ts:158 | +| `lastFailed.only` | `boolean` | testplane-docs/.testplane/src/config/types.ts:157 | +| `lastFailed.output` | `string` | testplane-docs/.testplane/src/config/types.ts:159 | +| `meta` | \{\} | testplane-docs/.testplane/src/config/types.ts:138 | +| `openAndWaitOpts` | \{ `failOnNetworkError`: `boolean`; `ignoreNetworkErrorsPatterns`: (`string` \| `RegExp`)[]; `timeout`: `number`; `waitNetworkIdle`: `boolean`; `waitNetworkIdleTimeout`: `number`; \} | testplane-docs/.testplane/src/config/types.ts:162 | +| `openAndWaitOpts.failOnNetworkError` | `boolean` | testplane-docs/.testplane/src/config/types.ts:166 | +| `openAndWaitOpts.ignoreNetworkErrorsPatterns` | (`string` \| `RegExp`)[] | testplane-docs/.testplane/src/config/types.ts:167 | +| `openAndWaitOpts.timeout?` | `number` | testplane-docs/.testplane/src/config/types.ts:163 | +| `openAndWaitOpts.waitNetworkIdle` | `boolean` | testplane-docs/.testplane/src/config/types.ts:164 | +| `openAndWaitOpts.waitNetworkIdleTimeout` | `number` | testplane-docs/.testplane/src/config/types.ts:165 | +| `orientation` | `null` \| `"landscape"` \| `"portrait"` | testplane-docs/.testplane/src/config/types.ts:140 | +| `pageLoadTimeout` | `null` \| `number` | testplane-docs/.testplane/src/config/types.ts:111 | +| `region` | `null` \| `string` | testplane-docs/.testplane/src/config/types.ts:150 | +| `resetCursor` | `boolean` | testplane-docs/.testplane/src/config/types.ts:141 | +| `retry` | `number` | testplane-docs/.testplane/src/config/types.ts:107 | +| `saveHistoryMode` | `"all"` \| `"none"` \| `"onlyFailed"` | testplane-docs/.testplane/src/config/types.ts:117 | +| `screenshotDelay` | `number` | testplane-docs/.testplane/src/config/types.ts:131 | +| `screenshotMode` | `"auto"` \| `"fullpage"` \| `"viewport"` | testplane-docs/.testplane/src/config/types.ts:130 | +| `screenshotPath` | `null` \| `string` | testplane-docs/.testplane/src/config/types.ts:125 | +| `sessionEnvFlags` | `Record`\< \| `"isW3C"` \| `"isAndroid"` \| `"isMobile"` \| `"isIOS"` \| `"isSauce"` \| `"isSeleniumStandalone"` \| `"isChrome"`, `boolean`\> | testplane-docs/.testplane/src/config/types.ts:99 | +| `sessionQuitTimeout` | `null` \| `number` | testplane-docs/.testplane/src/config/types.ts:113 | +| `sessionRequestTimeout` | `null` \| `number` | testplane-docs/.testplane/src/config/types.ts:112 | +| `sessionsPerBrowser` | `number` | testplane-docs/.testplane/src/config/types.ts:105 | +| `strictSSL` | `null` \| `boolean` | testplane-docs/.testplane/src/config/types.ts:147 | +| `strictTestsOrder` | `boolean` | testplane-docs/.testplane/src/config/types.ts:129 | +| `system` | [`SystemConfig`](SystemConfig.mdx) | testplane-docs/.testplane/src/config/types.ts:152 | +| `takeScreenshotOnFails` | \{ `assertViewFail`: `boolean`; `testFail`: `boolean`; \} | testplane-docs/.testplane/src/config/types.ts:118 | +| `takeScreenshotOnFails.assertViewFail` | `boolean` | testplane-docs/.testplane/src/config/types.ts:120 | +| `takeScreenshotOnFails.testFail` | `boolean` | testplane-docs/.testplane/src/config/types.ts:119 | +| `takeScreenshotOnFailsMode` | `"fullpage"` \| `"viewport"` | testplane-docs/.testplane/src/config/types.ts:123 | +| `takeScreenshotOnFailsTimeout` | `null` \| `number` | testplane-docs/.testplane/src/config/types.ts:122 | +| `testTimeout` | `null` \| `number` | testplane-docs/.testplane/src/config/types.ts:114 | +| `testsPerSession` | `number` | testplane-docs/.testplane/src/config/types.ts:106 | +| `tolerance` | `number` | testplane-docs/.testplane/src/config/types.ts:132 | +| `transformRequest` | (`req`: `RequestOptions`) => `RequestOptions` | testplane-docs/.testplane/src/config/types.ts:144 | +| `transformResponse` | (`res`: `Response`, `req`: `RequestOptions`) => `Response` | testplane-docs/.testplane/src/config/types.ts:145 | +| `urlHttpTimeout` | `null` \| `number` | testplane-docs/.testplane/src/config/types.ts:110 | +| `user` | `null` \| `string` | testplane-docs/.testplane/src/config/types.ts:148 | +| `waitInterval` | `number` | testplane-docs/.testplane/src/config/types.ts:116 | +| `waitTimeout` | `number` | testplane-docs/.testplane/src/config/types.ts:115 | +| `windowSize` | `null` \| `string` \| \{ `height`: `number`; `width`: `number`; \} | testplane-docs/.testplane/src/config/types.ts:139 | + +## Methods + +### prepareBrowser() + +```ts +prepareBrowser(browser): null | void +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `browser` | `Browser` | + +#### Returns + +`null` \| `void` + +#### Defined in + +testplane-docs/.testplane/src/config/types.ts:124 + +*** + +### screenshotsDir() + +```ts +screenshotsDir(test): string +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `test` | [`Test`](../classes/Test.mdx) | + +#### Returns + +`string` + +#### Defined in + +testplane-docs/.testplane/src/config/types.ts:126 + +*** + +### shouldRetry() + +```ts +shouldRetry(testInfo): null | boolean +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `testInfo` | `object` | +| `testInfo.ctx` | [`Test`](../classes/Test.mdx) | +| `testInfo.retriesLeft` | `number` | + +#### Returns + +`null` \| `boolean` + +#### Defined in + +testplane-docs/.testplane/src/config/types.ts:108 diff --git a/i18n/en/docusaurus-plugin-content-docs/current/api-reference/interfaces/CompareOptsConfig.mdx b/i18n/en/docusaurus-plugin-content-docs/current/api-reference/interfaces/CompareOptsConfig.mdx new file mode 100644 index 0000000..cd6964b --- /dev/null +++ b/i18n/en/docusaurus-plugin-content-docs/current/api-reference/interfaces/CompareOptsConfig.mdx @@ -0,0 +1,11 @@ +[testplane](../README.mdx) / CompareOptsConfig + +# Interface: CompareOptsConfig + +## Properties + +| Property | Type | Defined in | +| ------ | ------ | ------ | +| `clustersSize` | `number` | testplane-docs/.testplane/src/config/types.ts:9 | +| `shouldCluster` | `boolean` | testplane-docs/.testplane/src/config/types.ts:8 | +| `stopOnFirstFail` | `boolean` | testplane-docs/.testplane/src/config/types.ts:10 | diff --git a/i18n/en/docusaurus-plugin-content-docs/current/api-reference/interfaces/DiffOptions.mdx b/i18n/en/docusaurus-plugin-content-docs/current/api-reference/interfaces/DiffOptions.mdx new file mode 100644 index 0000000..df740a3 --- /dev/null +++ b/i18n/en/docusaurus-plugin-content-docs/current/api-reference/interfaces/DiffOptions.mdx @@ -0,0 +1,25 @@ +[testplane](../README.mdx) / DiffOptions + +# Interface: DiffOptions + +## Extends + +- `LooksSameOptions` + +## Properties + +| Property | Type | Description | Inherited from | Defined in | +| ------ | ------ | ------ | ------ | ------ | +| `antialiasingTolerance?` | `number` | Sometimes the antialiasing algorithm can work incorrectly due to some features of the browser rendering engine. Use the option antialiasingTolerance to make the algorithm less strict. With this option you can specify the minimum difference in brightness (zero by default) between the darkest/lightest pixel (which is adjacent to the antialiasing pixel) and theirs adjacent pixels. We recommend that you don't increase this value above 10. If you need to increase more than 10 then this is definitely not antialiasing. | `LooksSameOptions.antialiasingTolerance` | testplane/node\_modules/looks-same/index.d.ts:139 | +| `clustersSize?` | `number` | Radius for every diff cluster | `LooksSameOptions.clustersSize` | testplane/node\_modules/looks-same/index.d.ts:152 | +| `createDiffImage?` | `boolean` | If you need both to compare images and create diff image | `LooksSameOptions.createDiffImage` | testplane/node\_modules/looks-same/index.d.ts:156 | +| `current` | `string` | - | - | testplane-docs/.testplane/src/types/index.ts:72 | +| `diffColor` | `string` | - | - | testplane-docs/.testplane/src/types/index.ts:74 | +| `ignoreAntialiasing?` | `boolean` | Some images has difference while comparing because of antialiasing. These diffs will be ignored by default. You can use ignoreAntialiasing option with false value to disable ignoring such diffs. In that way antialiased pixels will be marked as diffs. | `LooksSameOptions.ignoreAntialiasing` | testplane/node\_modules/looks-same/index.d.ts:130 | +| `ignoreCaret?` | `boolean` | Text caret in text input elements it is a pain for visual regression tasks, because it is always blinks. These diffs will be ignored by default. You can use `ignoreCaret` option with `false` value to disable ignoring such diffs. In that way text caret will be marked as diffs. | `LooksSameOptions.ignoreCaret` | testplane/node\_modules/looks-same/index.d.ts:124 | +| `pixelRatio?` | `number` | Some devices can have different proportion between physical and logical screen resolutions also known as pixel ratio. Default value for this proportion is 1. This param also affects the comparison result, so it can be set manually with pixelRatio option. | `LooksSameOptions.pixelRatio` | testplane/node\_modules/looks-same/index.d.ts:118 | +| `reference` | `string` | - | - | testplane-docs/.testplane/src/types/index.ts:73 | +| `shouldCluster?` | `boolean` | Responsible for diff bounds clustering | `LooksSameOptions.shouldCluster` | testplane/node\_modules/looks-same/index.d.ts:148 | +| `stopOnFirstFail?` | `boolean` | Responsible for diff area which will be returned when comparing images. Diff bounds will contain the whole diff if stopOnFirstFail is false and only first diff pixel - otherwise. | `LooksSameOptions.stopOnFirstFail` | testplane/node\_modules/looks-same/index.d.ts:144 | +| `strict?` | `boolean` | By default, it will detect only noticeable differences. If you wish to detect any difference, use strict options. | `LooksSameOptions.strict` | testplane/node\_modules/looks-same/index.d.ts:108 | +| `tolerance?` | `number` | You can also adjust the ΔE value that will be treated as error in non-strict mode. | `LooksSameOptions.tolerance` | testplane/node\_modules/looks-same/index.d.ts:112 | diff --git a/i18n/en/docusaurus-plugin-content-docs/current/api-reference/interfaces/ErrorDetails.mdx b/i18n/en/docusaurus-plugin-content-docs/current/api-reference/interfaces/ErrorDetails.mdx new file mode 100644 index 0000000..f5eeb87 --- /dev/null +++ b/i18n/en/docusaurus-plugin-content-docs/current/api-reference/interfaces/ErrorDetails.mdx @@ -0,0 +1,11 @@ +[testplane](../README.mdx) / ErrorDetails + +# Interface: ErrorDetails + +## Properties + +| Property | Type | Defined in | +| ------ | ------ | ------ | +| `data?` | `unknown` | testplane-docs/.testplane/src/types/index.ts:53 | +| `filePath` | `string` | testplane-docs/.testplane/src/types/index.ts:54 | +| `title` | `string` | testplane-docs/.testplane/src/types/index.ts:52 | diff --git a/i18n/en/docusaurus-plugin-content-docs/current/api-reference/interfaces/ExecutionThreadToolCtx.mdx b/i18n/en/docusaurus-plugin-content-docs/current/api-reference/interfaces/ExecutionThreadToolCtx.mdx new file mode 100644 index 0000000..47daa55 --- /dev/null +++ b/i18n/en/docusaurus-plugin-content-docs/current/api-reference/interfaces/ExecutionThreadToolCtx.mdx @@ -0,0 +1,14 @@ +[testplane](../README.mdx) / ExecutionThreadToolCtx + +# Interface: ExecutionThreadToolCtx + +## Properties + +| Property | Type | Defined in | +| ------ | ------ | ------ | +| `assertViewResults` | \{ `add`: (`result`) => `void`; `get`: () => [`AssertViewResult`](../type-aliases/AssertViewResult.mdx)[]; `hasFails`: () => `boolean`; `hasState`: (`stateName`) => `boolean`; `toRawObject`: () => [`AssertViewResult`](../type-aliases/AssertViewResult.mdx)[]; \} | testplane-docs/.testplane/src/types/index.ts:125 | +| `assertViewResults.add` | (`result`: [`AssertViewResult`](../type-aliases/AssertViewResult.mdx)) => `void` | testplane-docs/.testplane/src/types/index.ts:126 | +| `assertViewResults.get` | () => [`AssertViewResult`](../type-aliases/AssertViewResult.mdx)[] | testplane-docs/.testplane/src/types/index.ts:130 | +| `assertViewResults.hasFails` | () => `boolean` | testplane-docs/.testplane/src/types/index.ts:127 | +| `assertViewResults.hasState` | (`stateName`: `string`) => `boolean` | testplane-docs/.testplane/src/types/index.ts:128 | +| `assertViewResults.toRawObject` | () => [`AssertViewResult`](../type-aliases/AssertViewResult.mdx)[] | testplane-docs/.testplane/src/types/index.ts:129 | diff --git a/i18n/en/docusaurus-plugin-content-docs/current/api-reference/interfaces/ExpectOptsConfig.mdx b/i18n/en/docusaurus-plugin-content-docs/current/api-reference/interfaces/ExpectOptsConfig.mdx new file mode 100644 index 0000000..8ad07b9 --- /dev/null +++ b/i18n/en/docusaurus-plugin-content-docs/current/api-reference/interfaces/ExpectOptsConfig.mdx @@ -0,0 +1,10 @@ +[testplane](../README.mdx) / ExpectOptsConfig + +# Interface: ExpectOptsConfig + +## Properties + +| Property | Type | Defined in | +| ------ | ------ | ------ | +| `interval` | `number` | testplane-docs/.testplane/src/config/types.ts:50 | +| `wait` | `number` | testplane-docs/.testplane/src/config/types.ts:49 | diff --git a/i18n/en/docusaurus-plugin-content-docs/current/api-reference/interfaces/GlobalHelper.mdx b/i18n/en/docusaurus-plugin-content-docs/current/api-reference/interfaces/GlobalHelper.mdx new file mode 100644 index 0000000..14fb338 --- /dev/null +++ b/i18n/en/docusaurus-plugin-content-docs/current/api-reference/interfaces/GlobalHelper.mdx @@ -0,0 +1,14 @@ +[testplane](../README.mdx) / GlobalHelper + +# Interface: GlobalHelper + +## Properties + +| Property | Type | Defined in | +| ------ | ------ | ------ | +| `also` | `AlsoController` | testplane-docs/.testplane/src/types/index.ts:165 | +| `browser` | (`browserName`: `string`) => `BrowserVersionController` | testplane-docs/.testplane/src/types/index.ts:166 | +| `config` | `ConfigController` | testplane-docs/.testplane/src/types/index.ts:167 | +| `ctx` | [`TestplaneCtx`](TestplaneCtx.mdx) | testplane-docs/.testplane/src/types/index.ts:162 | +| `only` | `OnlyController` | testplane-docs/.testplane/src/types/index.ts:164 | +| `skip` | `SkipController` | testplane-docs/.testplane/src/types/index.ts:163 | diff --git a/i18n/en/docusaurus-plugin-content-docs/current/api-reference/interfaces/HermioneCtx.mdx b/i18n/en/docusaurus-plugin-content-docs/current/api-reference/interfaces/HermioneCtx.mdx new file mode 100644 index 0000000..4cc0a8c --- /dev/null +++ b/i18n/en/docusaurus-plugin-content-docs/current/api-reference/interfaces/HermioneCtx.mdx @@ -0,0 +1,15 @@ +[testplane](../README.mdx) / HermioneCtx + +# Interface: ~~HermioneCtx~~ + +## Deprecated + +Use `TestplaneCtx` instead + +## Extends + +- `Record`\<`string`, `unknown`\> + +## Extended by + +- [`TestplaneCtx`](TestplaneCtx.mdx) diff --git a/i18n/en/docusaurus-plugin-content-docs/current/api-reference/interfaces/ImageBase64.mdx b/i18n/en/docusaurus-plugin-content-docs/current/api-reference/interfaces/ImageBase64.mdx new file mode 100644 index 0000000..48a744d --- /dev/null +++ b/i18n/en/docusaurus-plugin-content-docs/current/api-reference/interfaces/ImageBase64.mdx @@ -0,0 +1,10 @@ +[testplane](../README.mdx) / ImageBase64 + +# Interface: ImageBase64 + +## Properties + +| Property | Type | Defined in | +| ------ | ------ | ------ | +| `base64` | `string` | testplane-docs/.testplane/src/types/index.ts:47 | +| `size` | [`ImageSize`](ImageSize.mdx) | testplane-docs/.testplane/src/types/index.ts:48 | diff --git a/i18n/en/docusaurus-plugin-content-docs/current/api-reference/interfaces/ImageInfo.mdx b/i18n/en/docusaurus-plugin-content-docs/current/api-reference/interfaces/ImageInfo.mdx new file mode 100644 index 0000000..5391b1e --- /dev/null +++ b/i18n/en/docusaurus-plugin-content-docs/current/api-reference/interfaces/ImageInfo.mdx @@ -0,0 +1,14 @@ +[testplane](../README.mdx) / ImageInfo + +# Interface: ImageInfo + +## Extended by + +- [`RefImageInfo`](RefImageInfo.mdx) + +## Properties + +| Property | Type | Defined in | +| ------ | ------ | ------ | +| `path` | `string` | testplane-docs/.testplane/src/types/index.ts:63 | +| `size` | [`ImageSize`](ImageSize.mdx) | testplane-docs/.testplane/src/types/index.ts:64 | diff --git a/i18n/en/docusaurus-plugin-content-docs/current/api-reference/interfaces/ImageSize.mdx b/i18n/en/docusaurus-plugin-content-docs/current/api-reference/interfaces/ImageSize.mdx new file mode 100644 index 0000000..9b34c8f --- /dev/null +++ b/i18n/en/docusaurus-plugin-content-docs/current/api-reference/interfaces/ImageSize.mdx @@ -0,0 +1,10 @@ +[testplane](../README.mdx) / ImageSize + +# Interface: ImageSize + +## Properties + +| Property | Type | Defined in | +| ------ | ------ | ------ | +| `height` | `number` | testplane-docs/.testplane/src/types/index.ts:43 | +| `width` | `number` | testplane-docs/.testplane/src/types/index.ts:42 | diff --git a/i18n/en/docusaurus-plugin-content-docs/current/api-reference/interfaces/InterceptData.mdx b/i18n/en/docusaurus-plugin-content-docs/current/api-reference/interfaces/InterceptData.mdx new file mode 100644 index 0000000..3cb78fc --- /dev/null +++ b/i18n/en/docusaurus-plugin-content-docs/current/api-reference/interfaces/InterceptData.mdx @@ -0,0 +1,10 @@ +[testplane](../README.mdx) / InterceptData + +# Interface: InterceptData + +## Properties + +| Property | Type | Defined in | +| ------ | ------ | ------ | +| `data?` | [`Test`](../classes/Test.mdx) | testplane-docs/.testplane/src/events/types.ts:6 | +| `event?` | [`InterceptedEvent`](../type-aliases/InterceptedEvent.mdx) | testplane-docs/.testplane/src/events/types.ts:5 | diff --git a/i18n/en/docusaurus-plugin-content-docs/current/api-reference/interfaces/MochaOpts.mdx b/i18n/en/docusaurus-plugin-content-docs/current/api-reference/interfaces/MochaOpts.mdx new file mode 100644 index 0000000..33e2cb8 --- /dev/null +++ b/i18n/en/docusaurus-plugin-content-docs/current/api-reference/interfaces/MochaOpts.mdx @@ -0,0 +1,11 @@ +[testplane](../README.mdx) / MochaOpts + +# Interface: MochaOpts + +## Properties + +| Property | Type | Description | Defined in | +| ------ | ------ | ------ | ------ | +| `grep?` | `string` \| `RegExp` | string or regexp to filter tests with. | testplane-docs/.testplane/src/config/types.ts:61 | +| `slow?` | `number` | milliseconds to wait before considering a test slow. | testplane-docs/.testplane/src/config/types.ts:55 | +| `timeout?` | `number` | timeout in milliseconds or time string like '1s'. | testplane-docs/.testplane/src/config/types.ts:58 | diff --git a/i18n/en/docusaurus-plugin-content-docs/current/api-reference/interfaces/ReadTestsOpts.mdx b/i18n/en/docusaurus-plugin-content-docs/current/api-reference/interfaces/ReadTestsOpts.mdx new file mode 100644 index 0000000..88f4fbc --- /dev/null +++ b/i18n/en/docusaurus-plugin-content-docs/current/api-reference/interfaces/ReadTestsOpts.mdx @@ -0,0 +1,21 @@ +[testplane](../README.mdx) / ReadTestsOpts + +# Interface: ReadTestsOpts + +## Extends + +- `Pick`\<[`RunOpts`](RunOpts.mdx), `"browsers"` \| `"sets"` \| `"grep"` \| `"replMode"`\> + +## Properties + +| Property | Type | Inherited from | Defined in | +| ------ | ------ | ------ | ------ | +| `browsers` | `string`[] | `Pick.browsers` | testplane-docs/.testplane/src/testplane.ts:23 | +| `grep` | `RegExp` | `Pick.grep` | testplane-docs/.testplane/src/testplane.ts:25 | +| `ignore` | `string` \| `string`[] | - | testplane-docs/.testplane/src/testplane.ts:49 | +| `replMode` | \{ `beforeTest`: `boolean`; `enabled`: `boolean`; `onFail`: `boolean`; \} | `Pick.replMode` | testplane-docs/.testplane/src/testplane.ts:33 | +| `replMode.beforeTest` | `boolean` | - | testplane-docs/.testplane/src/testplane.ts:35 | +| `replMode.enabled` | `boolean` | - | testplane-docs/.testplane/src/testplane.ts:34 | +| `replMode.onFail` | `boolean` | - | testplane-docs/.testplane/src/testplane.ts:36 | +| `sets` | `string`[] | `Pick.sets` | testplane-docs/.testplane/src/testplane.ts:24 | +| `silent` | `boolean` | - | testplane-docs/.testplane/src/testplane.ts:48 | diff --git a/i18n/en/docusaurus-plugin-content-docs/current/api-reference/interfaces/RefImageInfo.mdx b/i18n/en/docusaurus-plugin-content-docs/current/api-reference/interfaces/RefImageInfo.mdx new file mode 100644 index 0000000..3c77d75 --- /dev/null +++ b/i18n/en/docusaurus-plugin-content-docs/current/api-reference/interfaces/RefImageInfo.mdx @@ -0,0 +1,15 @@ +[testplane](../README.mdx) / RefImageInfo + +# Interface: RefImageInfo + +## Extends + +- [`ImageInfo`](ImageInfo.mdx) + +## Properties + +| Property | Type | Inherited from | Defined in | +| ------ | ------ | ------ | ------ | +| `path` | `string` | [`ImageInfo`](ImageInfo.mdx).`path` | testplane-docs/.testplane/src/types/index.ts:63 | +| `relativePath` | `string` | - | testplane-docs/.testplane/src/types/index.ts:68 | +| `size` | [`ImageSize`](ImageSize.mdx) | [`ImageInfo`](ImageInfo.mdx).`size` | testplane-docs/.testplane/src/types/index.ts:64 | diff --git a/i18n/en/docusaurus-plugin-content-docs/current/api-reference/interfaces/RootSuite.mdx b/i18n/en/docusaurus-plugin-content-docs/current/api-reference/interfaces/RootSuite.mdx new file mode 100644 index 0000000..ce72ca0 --- /dev/null +++ b/i18n/en/docusaurus-plugin-content-docs/current/api-reference/interfaces/RootSuite.mdx @@ -0,0 +1,744 @@ +[testplane](../README.mdx) / RootSuite + +# Interface: RootSuite + +## Extends + +- [`Suite`](../classes/Suite.mdx) + +## Properties + +| Property | Modifier | Type | Default value | Overrides | Inherited from | Defined in | +| ------ | ------ | ------ | ------ | ------ | ------ | ------ | +| `parent` | `public` | `null` \| [`Suite`](../classes/Suite.mdx) | `null` | - | [`Suite`](../classes/Suite.mdx).`parent` | testplane-docs/.testplane/src/test-reader/test-object/test-object.ts:6 | +| `root` | `public` | `true` | `undefined` | [`Suite`](../classes/Suite.mdx).[`root`](../classes/Suite.mdx#root) | - | testplane-docs/.testplane/src/types/index.ts:28 | + +## Accessors + +### afterEachHooks + +```ts +get afterEachHooks(): Hook[] +``` + +#### Returns + +`Hook`[] + +#### Inherited from + +[`Suite`](../classes/Suite.mdx).[`afterEachHooks`](../classes/Suite.mdx#aftereachhooks) + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/suite.ts:95 + +*** + +### beforeEachHooks + +```ts +get beforeEachHooks(): Hook[] +``` + +#### Returns + +`Hook`[] + +#### Inherited from + +[`Suite`](../classes/Suite.mdx).[`beforeEachHooks`](../classes/Suite.mdx#beforeeachhooks) + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/suite.ts:91 + +*** + +### browserId + +```ts +get browserId(): string +``` + +```ts +set browserId(id): void +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `id` | `string` | + +#### Returns + +`string` + +#### Inherited from + +[`Suite`](../classes/Suite.mdx).[`browserId`](../classes/Suite.mdx#browserid) + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/configurable-test-object.ts:93 + +*** + +### browserVersion + +```ts +get browserVersion(): undefined | string +``` + +```ts +set browserVersion(version): void +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `version` | `string` | + +#### Returns + +`undefined` \| `string` + +#### Inherited from + +[`Suite`](../classes/Suite.mdx).[`browserVersion`](../classes/Suite.mdx#browserversion) + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/configurable-test-object.ts:101 + +*** + +### disabled + +```ts +get disabled(): boolean +``` + +```ts +set disabled(val): void +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `val` | `boolean` | + +#### Returns + +`boolean` + +#### Inherited from + +[`Suite`](../classes/Suite.mdx).[`disabled`](../classes/Suite.mdx#disabled) + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/configurable-test-object.ts:69 + +*** + +### file + +```ts +get file(): string +``` + +#### Returns + +`string` + +#### Inherited from + +[`Suite`](../classes/Suite.mdx).[`file`](../classes/Suite.mdx#file) + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/configurable-test-object.ts:45 + +*** + +### hasBrowserVersionOverwritten + +```ts +get hasBrowserVersionOverwritten(): boolean +``` + +#### Returns + +`boolean` + +#### Inherited from + +[`Suite`](../classes/Suite.mdx).[`hasBrowserVersionOverwritten`](../classes/Suite.mdx#hasbrowserversionoverwritten) + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/configurable-test-object.ts:105 + +*** + +### id + +```ts +get id(): string +``` + +#### Returns + +`string` + +#### Inherited from + +[`Suite`](../classes/Suite.mdx).[`id`](../classes/Suite.mdx#id) + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/configurable-test-object.ts:41 + +*** + +### pending + +```ts +get pending(): boolean +``` + +```ts +set pending(val): void +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `val` | `boolean` | + +#### Returns + +`boolean` + +#### Inherited from + +[`Suite`](../classes/Suite.mdx).[`pending`](../classes/Suite.mdx#pending) + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/configurable-test-object.ts:53 + +*** + +### silentSkip + +```ts +get silentSkip(): boolean +``` + +```ts +set silentSkip(val): void +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `val` | `boolean` | + +#### Returns + +`boolean` + +#### Inherited from + +[`Suite`](../classes/Suite.mdx).[`silentSkip`](../classes/Suite.mdx#silentskip) + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/configurable-test-object.ts:77 + +*** + +### skipReason + +```ts +get skipReason(): string +``` + +```ts +set skipReason(reason): void +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `reason` | `string` | + +#### Returns + +`string` + +#### Inherited from + +[`Suite`](../classes/Suite.mdx).[`skipReason`](../classes/Suite.mdx#skipreason) + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/configurable-test-object.ts:61 + +*** + +### suites + +```ts +get suites(): Suite[] +``` + +#### Returns + +[`Suite`](../classes/Suite.mdx)[] + +#### Inherited from + +[`Suite`](../classes/Suite.mdx).[`suites`](../classes/Suite.mdx#suites) + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/suite.ts:83 + +*** + +### tests + +```ts +get tests(): Test[] +``` + +#### Returns + +[`Test`](../classes/Test.mdx)[] + +#### Inherited from + +[`Suite`](../classes/Suite.mdx).[`tests`](../classes/Suite.mdx#tests) + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/suite.ts:87 + +*** + +### timeout + +```ts +get timeout(): number +``` + +```ts +set timeout(timeout): void +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `timeout` | `number` | + +#### Returns + +`number` + +#### Inherited from + +[`Suite`](../classes/Suite.mdx).[`timeout`](../classes/Suite.mdx#timeout) + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/configurable-test-object.ts:85 + +*** + +### title + +```ts +get title(): string +``` + +#### Returns + +`string` + +#### Inherited from + +[`Suite`](../classes/Suite.mdx).[`title`](../classes/Suite.mdx#title) + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/test-object.ts:16 + +## Methods + +### addAfterEachHook() + +```ts +addAfterEachHook(hook): this +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `hook` | `Hook` | + +#### Returns + +`this` + +#### Inherited from + +[`Suite`](../classes/Suite.mdx).[`addAfterEachHook`](../classes/Suite.mdx#addaftereachhook) + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/suite.ts:41 + +*** + +### addBeforeEachHook() + +```ts +addBeforeEachHook(hook): this +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `hook` | `Hook` | + +#### Returns + +`this` + +#### Inherited from + +[`Suite`](../classes/Suite.mdx).[`addBeforeEachHook`](../classes/Suite.mdx#addbeforeeachhook) + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/suite.ts:37 + +*** + +### addSuite() + +```ts +addSuite(suite): this +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `suite` | [`Suite`](../classes/Suite.mdx) | + +#### Returns + +`this` + +#### Inherited from + +[`Suite`](../classes/Suite.mdx).[`addSuite`](../classes/Suite.mdx#addsuite) + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/suite.ts:29 + +*** + +### addTest() + +```ts +addTest(test): this +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `test` | [`Test`](../classes/Test.mdx) | + +#### Returns + +`this` + +#### Inherited from + +[`Suite`](../classes/Suite.mdx).[`addTest`](../classes/Suite.mdx#addtest) + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/suite.ts:33 + +*** + +### afterEach() + +```ts +afterEach(fn): this +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `fn` | `TestFunction`\<[`TestFunctionCtx`](TestFunctionCtx.mdx)\> | + +#### Returns + +`this` + +#### Inherited from + +[`Suite`](../classes/Suite.mdx).[`afterEach`](../classes/Suite.mdx#aftereach) + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/suite.ts:49 + +*** + +### assign() + +```ts +assign(src): this +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `src` | `this` | + +#### Returns + +`this` + +#### Inherited from + +[`Suite`](../classes/Suite.mdx).[`assign`](../classes/Suite.mdx#assign) + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/configurable-test-object.ts:20 + +*** + +### beforeEach() + +```ts +beforeEach(fn): this +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `fn` | `TestFunction`\<[`TestFunctionCtx`](TestFunctionCtx.mdx)\> | + +#### Returns + +`this` + +#### Inherited from + +[`Suite`](../classes/Suite.mdx).[`beforeEach`](../classes/Suite.mdx#beforeeach) + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/suite.ts:45 + +*** + +### disable() + +```ts +disable(): void +``` + +#### Returns + +`void` + +#### Inherited from + +[`Suite`](../classes/Suite.mdx).[`disable`](../classes/Suite.mdx#disable) + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/configurable-test-object.ts:31 + +*** + +### eachTest() + +```ts +eachTest(cb): void +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `cb` | (`test`) => `void` | + +#### Returns + +`void` + +#### Inherited from + +[`Suite`](../classes/Suite.mdx).[`eachTest`](../classes/Suite.mdx#eachtest) + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/suite.ts:60 + +*** + +### enable() + +```ts +enable(): void +``` + +#### Returns + +`void` + +#### Inherited from + +[`Suite`](../classes/Suite.mdx).[`enable`](../classes/Suite.mdx#enable) + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/configurable-test-object.ts:36 + +*** + +### filterTests() + +```ts +filterTests(cb): this +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `cb` | (`test`) => `unknown` | + +#### Returns + +`this` + +#### Inherited from + +[`Suite`](../classes/Suite.mdx).[`filterTests`](../classes/Suite.mdx#filtertests) + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/suite.ts:70 + +*** + +### fullTitle() + +```ts +fullTitle(): string +``` + +#### Returns + +`string` + +#### Inherited from + +[`Suite`](../classes/Suite.mdx).[`fullTitle`](../classes/Suite.mdx#fulltitle) + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/test-object.ts:30 + +*** + +### getTests() + +```ts +getTests(): Test[] +``` + +#### Returns + +[`Test`](../classes/Test.mdx)[] + +#### Inherited from + +[`Suite`](../classes/Suite.mdx).[`getTests`](../classes/Suite.mdx#gettests) + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/suite.ts:65 + +*** + +### skip() + +```ts +skip(__namedParameters): void +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `SkipData` | + +#### Returns + +`void` + +#### Inherited from + +[`Suite`](../classes/Suite.mdx).[`skip`](../classes/Suite.mdx#skip) + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/configurable-test-object.ts:26 + +*** + +### titlePath() + +```ts +titlePath(): string[] +``` + +#### Returns + +`string`[] + +#### Inherited from + +[`Suite`](../classes/Suite.mdx).[`titlePath`](../classes/Suite.mdx#titlepath) + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/test-object.ts:20 diff --git a/i18n/en/docusaurus-plugin-content-docs/current/api-reference/interfaces/RunOpts.mdx b/i18n/en/docusaurus-plugin-content-docs/current/api-reference/interfaces/RunOpts.mdx new file mode 100644 index 0000000..7cf2653 --- /dev/null +++ b/i18n/en/docusaurus-plugin-content-docs/current/api-reference/interfaces/RunOpts.mdx @@ -0,0 +1,22 @@ +[testplane](../README.mdx) / RunOpts + +# Interface: RunOpts + +## Properties + +| Property | Type | Defined in | +| ------ | ------ | ------ | +| `browsers` | `string`[] | testplane-docs/.testplane/src/testplane.ts:23 | +| `devtools` | `boolean` | testplane-docs/.testplane/src/testplane.ts:38 | +| `grep` | `RegExp` | testplane-docs/.testplane/src/testplane.ts:25 | +| `inspectMode` | \{ `inspect`: `boolean`; `inspectBrk`: `boolean`; \} | testplane-docs/.testplane/src/testplane.ts:28 | +| `inspectMode.inspect` | `boolean` | testplane-docs/.testplane/src/testplane.ts:29 | +| `inspectMode.inspectBrk` | `boolean` | testplane-docs/.testplane/src/testplane.ts:30 | +| `replMode` | \{ `beforeTest`: `boolean`; `enabled`: `boolean`; `onFail`: `boolean`; \} | testplane-docs/.testplane/src/testplane.ts:33 | +| `replMode.beforeTest` | `boolean` | testplane-docs/.testplane/src/testplane.ts:35 | +| `replMode.enabled` | `boolean` | testplane-docs/.testplane/src/testplane.ts:34 | +| `replMode.onFail` | `boolean` | testplane-docs/.testplane/src/testplane.ts:36 | +| `reporters` | `string`[] | testplane-docs/.testplane/src/testplane.ts:32 | +| `requireModules` | `string`[] | testplane-docs/.testplane/src/testplane.ts:27 | +| `sets` | `string`[] | testplane-docs/.testplane/src/testplane.ts:24 | +| `updateRefs` | `boolean` | testplane-docs/.testplane/src/testplane.ts:26 | diff --git a/i18n/en/docusaurus-plugin-content-docs/current/api-reference/interfaces/SetsConfig.mdx b/i18n/en/docusaurus-plugin-content-docs/current/api-reference/interfaces/SetsConfig.mdx new file mode 100644 index 0000000..b85b741 --- /dev/null +++ b/i18n/en/docusaurus-plugin-content-docs/current/api-reference/interfaces/SetsConfig.mdx @@ -0,0 +1,11 @@ +[testplane](../README.mdx) / SetsConfig + +# Interface: SetsConfig + +## Properties + +| Property | Type | Defined in | +| ------ | ------ | ------ | +| `browsers?` | `string`[] | testplane-docs/.testplane/src/config/types.ts:183 | +| `files` | `string` \| `string`[] | testplane-docs/.testplane/src/config/types.ts:181 | +| `ignoreFiles?` | `string`[] | testplane-docs/.testplane/src/config/types.ts:182 | diff --git a/i18n/en/docusaurus-plugin-content-docs/current/api-reference/interfaces/SystemConfig.mdx b/i18n/en/docusaurus-plugin-content-docs/current/api-reference/interfaces/SystemConfig.mdx new file mode 100644 index 0000000..dd63434 --- /dev/null +++ b/i18n/en/docusaurus-plugin-content-docs/current/api-reference/interfaces/SystemConfig.mdx @@ -0,0 +1,20 @@ +[testplane](../README.mdx) / SystemConfig + +# Interface: SystemConfig + +## Properties + +| Property | Type | Defined in | +| ------ | ------ | ------ | +| `ctx` | \{\} | testplane-docs/.testplane/src/config/types.ts:68 | +| `debug` | `boolean` | testplane-docs/.testplane/src/config/types.ts:65 | +| `diffColor` | `string` | testplane-docs/.testplane/src/config/types.ts:72 | +| `expectOpts` | [`ExpectOptsConfig`](ExpectOptsConfig.mdx) | testplane-docs/.testplane/src/config/types.ts:67 | +| `fileExtensions` | `string`[] | testplane-docs/.testplane/src/config/types.ts:75 | +| `mochaOpts` | [`MochaOpts`](MochaOpts.mdx) | testplane-docs/.testplane/src/config/types.ts:66 | +| `parallelLimit` | `number` | testplane-docs/.testplane/src/config/types.ts:74 | +| `patternsOnReject` | `string`[] | testplane-docs/.testplane/src/config/types.ts:69 | +| `tempDir` | `string` | testplane-docs/.testplane/src/config/types.ts:73 | +| `testRunEnv` | `"nodejs"` \| `"browser"` \| [`"browser"`, `BrowserTestRunEnvOptions`] | testplane-docs/.testplane/src/config/types.ts:76 | +| `testsPerWorker` | `number` | testplane-docs/.testplane/src/config/types.ts:71 | +| `workers` | `number` | testplane-docs/.testplane/src/config/types.ts:70 | diff --git a/i18n/en/docusaurus-plugin-content-docs/current/api-reference/interfaces/TestError.mdx b/i18n/en/docusaurus-plugin-content-docs/current/api-reference/interfaces/TestError.mdx new file mode 100644 index 0000000..e19e9d8 --- /dev/null +++ b/i18n/en/docusaurus-plugin-content-docs/current/api-reference/interfaces/TestError.mdx @@ -0,0 +1,17 @@ +[testplane](../README.mdx) / TestError + +# Interface: TestError + +## Extends + +- `Error` + +## Properties + +| Property | Type | Inherited from | Defined in | +| ------ | ------ | ------ | ------ | +| `details` | [`ErrorDetails`](ErrorDetails.mdx) | - | testplane-docs/.testplane/src/types/index.ts:59 | +| `message` | `string` | `Error.message` | testplane-docs/node\_modules/typescript/lib/lib.es5.d.ts:1077 | +| `name` | `string` | `Error.name` | testplane-docs/node\_modules/typescript/lib/lib.es5.d.ts:1076 | +| `screenshot?` | [`ImageBase64`](ImageBase64.mdx) | - | testplane-docs/.testplane/src/types/index.ts:58 | +| `stack?` | `string` | `Error.stack` | testplane-docs/node\_modules/typescript/lib/lib.es5.d.ts:1078 | diff --git a/i18n/en/docusaurus-plugin-content-docs/current/api-reference/interfaces/TestFunctionCtx.mdx b/i18n/en/docusaurus-plugin-content-docs/current/api-reference/interfaces/TestFunctionCtx.mdx new file mode 100644 index 0000000..f7f7092 --- /dev/null +++ b/i18n/en/docusaurus-plugin-content-docs/current/api-reference/interfaces/TestFunctionCtx.mdx @@ -0,0 +1,10 @@ +[testplane](../README.mdx) / TestFunctionCtx + +# Interface: TestFunctionCtx + +## Properties + +| Property | Type | Defined in | +| ------ | ------ | ------ | +| `browser` | `Browser` | testplane-docs/.testplane/src/test-reader/test-object/types.ts:22 | +| `currentTest` | [`Test`](../classes/Test.mdx) | testplane-docs/.testplane/src/test-reader/test-object/types.ts:23 | diff --git a/i18n/en/docusaurus-plugin-content-docs/current/api-reference/interfaces/TestResult.mdx b/i18n/en/docusaurus-plugin-content-docs/current/api-reference/interfaces/TestResult.mdx new file mode 100644 index 0000000..eb227eb --- /dev/null +++ b/i18n/en/docusaurus-plugin-content-docs/current/api-reference/interfaces/TestResult.mdx @@ -0,0 +1,470 @@ +[testplane](../README.mdx) / TestResult + +# Interface: TestResult + +## Extends + +- [`Test`](../classes/Test.mdx) + +## Extended by + +- [`TestResultWithRetries`](TestResultWithRetries.mdx) + +## Properties + +| Property | Modifier | Type | Default value | Description | Overrides | Inherited from | Defined in | +| ------ | ------ | ------ | ------ | ------ | ------ | ------ | ------ | +| `assertViewResults` | `public` | [`AssertViewResult`](../type-aliases/AssertViewResult.mdx)[] | `undefined` | - | - | - | testplane-docs/.testplane/src/types/index.ts:135 | +| `description?` | `public` | `string` | `undefined` | - | - | - | testplane-docs/.testplane/src/types/index.ts:136 | +| `duration` | `public` | `number` | `undefined` | - | - | - | testplane-docs/.testplane/src/types/index.ts:137 | +| `err?` | `public` | [`TestError`](TestError.mdx) | `undefined` | - | [`Test`](../classes/Test.mdx).`err` | - | testplane-docs/.testplane/src/types/index.ts:138 | +| `fn` | `public` | `TestFunction`\<[`TestFunctionCtx`](TestFunctionCtx.mdx)\> | `undefined` | - | - | [`Test`](../classes/Test.mdx).`fn` | testplane-docs/.testplane/src/test-reader/test-object/test.ts:10 | +| ~~`hermioneCtx`~~ | `public` | [`ExecutionThreadToolCtx`](ExecutionThreadToolCtx.mdx) | `undefined` | **Deprecated** Use `testplaneCtx` instead | - | - | testplane-docs/.testplane/src/types/index.ts:143 | +| `history` | `public` | [`CommandHistory`](CommandHistory.mdx) | `undefined` | - | - | - | testplane-docs/.testplane/src/types/index.ts:144 | +| `meta` | `public` | \{\} | `undefined` | - | - | - | testplane-docs/.testplane/src/types/index.ts:145 | +| `parent` | `public` | `null` \| [`Suite`](../classes/Suite.mdx) | `null` | - | - | [`Test`](../classes/Test.mdx).`parent` | testplane-docs/.testplane/src/test-reader/test-object/test-object.ts:6 | +| `sessionId` | `public` | `string` | `undefined` | - | - | - | testplane-docs/.testplane/src/types/index.ts:146 | +| `startTime` | `public` | `number` | `undefined` | - | - | - | testplane-docs/.testplane/src/types/index.ts:147 | +| `testplaneCtx` | `public` | [`ExecutionThreadToolCtx`](ExecutionThreadToolCtx.mdx) | `undefined` | - | - | - | testplane-docs/.testplane/src/types/index.ts:139 | + +## Accessors + +### browserId + +```ts +get browserId(): string +``` + +```ts +set browserId(id): void +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `id` | `string` | + +#### Returns + +`string` + +#### Inherited from + +[`Test`](../classes/Test.mdx).[`browserId`](../classes/Test.mdx#browserid) + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/configurable-test-object.ts:93 + +*** + +### browserVersion + +```ts +get browserVersion(): undefined | string +``` + +```ts +set browserVersion(version): void +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `version` | `string` | + +#### Returns + +`undefined` \| `string` + +#### Inherited from + +[`Test`](../classes/Test.mdx).[`browserVersion`](../classes/Test.mdx#browserversion) + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/configurable-test-object.ts:101 + +*** + +### disabled + +```ts +get disabled(): boolean +``` + +```ts +set disabled(val): void +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `val` | `boolean` | + +#### Returns + +`boolean` + +#### Inherited from + +[`Test`](../classes/Test.mdx).[`disabled`](../classes/Test.mdx#disabled) + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/configurable-test-object.ts:69 + +*** + +### file + +```ts +get file(): string +``` + +#### Returns + +`string` + +#### Inherited from + +[`Test`](../classes/Test.mdx).[`file`](../classes/Test.mdx#file) + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/configurable-test-object.ts:45 + +*** + +### hasBrowserVersionOverwritten + +```ts +get hasBrowserVersionOverwritten(): boolean +``` + +#### Returns + +`boolean` + +#### Inherited from + +[`Test`](../classes/Test.mdx).[`hasBrowserVersionOverwritten`](../classes/Test.mdx#hasbrowserversionoverwritten) + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/configurable-test-object.ts:105 + +*** + +### id + +```ts +get id(): string +``` + +#### Returns + +`string` + +#### Inherited from + +[`Test`](../classes/Test.mdx).[`id`](../classes/Test.mdx#id) + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/configurable-test-object.ts:41 + +*** + +### pending + +```ts +get pending(): boolean +``` + +```ts +set pending(val): void +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `val` | `boolean` | + +#### Returns + +`boolean` + +#### Inherited from + +[`Test`](../classes/Test.mdx).[`pending`](../classes/Test.mdx#pending) + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/configurable-test-object.ts:53 + +*** + +### silentSkip + +```ts +get silentSkip(): boolean +``` + +```ts +set silentSkip(val): void +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `val` | `boolean` | + +#### Returns + +`boolean` + +#### Inherited from + +[`Test`](../classes/Test.mdx).[`silentSkip`](../classes/Test.mdx#silentskip) + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/configurable-test-object.ts:77 + +*** + +### skipReason + +```ts +get skipReason(): string +``` + +```ts +set skipReason(reason): void +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `reason` | `string` | + +#### Returns + +`string` + +#### Inherited from + +[`Test`](../classes/Test.mdx).[`skipReason`](../classes/Test.mdx#skipreason) + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/configurable-test-object.ts:61 + +*** + +### timeout + +```ts +get timeout(): number +``` + +```ts +set timeout(timeout): void +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `timeout` | `number` | + +#### Returns + +`number` + +#### Inherited from + +[`Test`](../classes/Test.mdx).[`timeout`](../classes/Test.mdx#timeout) + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/configurable-test-object.ts:85 + +*** + +### title + +```ts +get title(): string +``` + +#### Returns + +`string` + +#### Inherited from + +[`Test`](../classes/Test.mdx).[`title`](../classes/Test.mdx#title) + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/test-object.ts:16 + +## Methods + +### assign() + +```ts +assign(src): this +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `src` | `this` | + +#### Returns + +`this` + +#### Inherited from + +[`Test`](../classes/Test.mdx).[`assign`](../classes/Test.mdx#assign) + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/configurable-test-object.ts:20 + +*** + +### clone() + +```ts +clone(): Test +``` + +#### Returns + +[`Test`](../classes/Test.mdx) + +#### Inherited from + +[`Test`](../classes/Test.mdx).[`clone`](../classes/Test.mdx#clone) + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/test.ts:23 + +*** + +### disable() + +```ts +disable(): void +``` + +#### Returns + +`void` + +#### Inherited from + +[`Test`](../classes/Test.mdx).[`disable`](../classes/Test.mdx#disable) + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/configurable-test-object.ts:31 + +*** + +### enable() + +```ts +enable(): void +``` + +#### Returns + +`void` + +#### Inherited from + +[`Test`](../classes/Test.mdx).[`enable`](../classes/Test.mdx#enable) + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/configurable-test-object.ts:36 + +*** + +### fullTitle() + +```ts +fullTitle(): string +``` + +#### Returns + +`string` + +#### Inherited from + +[`Test`](../classes/Test.mdx).[`fullTitle`](../classes/Test.mdx#fulltitle) + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/test-object.ts:30 + +*** + +### skip() + +```ts +skip(__namedParameters): void +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `SkipData` | + +#### Returns + +`void` + +#### Inherited from + +[`Test`](../classes/Test.mdx).[`skip`](../classes/Test.mdx#skip) + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/configurable-test-object.ts:26 + +*** + +### titlePath() + +```ts +titlePath(): string[] +``` + +#### Returns + +`string`[] + +#### Inherited from + +[`Test`](../classes/Test.mdx).[`titlePath`](../classes/Test.mdx#titlepath) + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/test-object.ts:20 diff --git a/i18n/en/docusaurus-plugin-content-docs/current/api-reference/interfaces/TestResultWithRetries.mdx b/i18n/en/docusaurus-plugin-content-docs/current/api-reference/interfaces/TestResultWithRetries.mdx new file mode 100644 index 0000000..17a76c6 --- /dev/null +++ b/i18n/en/docusaurus-plugin-content-docs/current/api-reference/interfaces/TestResultWithRetries.mdx @@ -0,0 +1,467 @@ +[testplane](../README.mdx) / TestResultWithRetries + +# Interface: TestResultWithRetries + +## Extends + +- [`TestResult`](TestResult.mdx) + +## Properties + +| Property | Modifier | Type | Default value | Description | Inherited from | Defined in | +| ------ | ------ | ------ | ------ | ------ | ------ | ------ | +| `assertViewResults` | `public` | [`AssertViewResult`](../type-aliases/AssertViewResult.mdx)[] | `undefined` | - | [`TestResult`](TestResult.mdx).`assertViewResults` | testplane-docs/.testplane/src/types/index.ts:135 | +| `description?` | `public` | `string` | `undefined` | - | [`TestResult`](TestResult.mdx).`description` | testplane-docs/.testplane/src/types/index.ts:136 | +| `duration` | `public` | `number` | `undefined` | - | [`TestResult`](TestResult.mdx).`duration` | testplane-docs/.testplane/src/types/index.ts:137 | +| `err?` | `public` | [`TestError`](TestError.mdx) | `undefined` | - | [`TestResult`](TestResult.mdx).`err` | testplane-docs/.testplane/src/types/index.ts:138 | +| `fn` | `public` | `TestFunction`\<[`TestFunctionCtx`](TestFunctionCtx.mdx)\> | `undefined` | - | [`TestResult`](TestResult.mdx).`fn` | testplane-docs/.testplane/src/test-reader/test-object/test.ts:10 | +| ~~`hermioneCtx`~~ | `public` | [`ExecutionThreadToolCtx`](ExecutionThreadToolCtx.mdx) | `undefined` | **Deprecated** Use `testplaneCtx` instead | [`TestResult`](TestResult.mdx).`hermioneCtx` | testplane-docs/.testplane/src/types/index.ts:143 | +| `history` | `public` | [`CommandHistory`](CommandHistory.mdx) | `undefined` | - | [`TestResult`](TestResult.mdx).`history` | testplane-docs/.testplane/src/types/index.ts:144 | +| `meta` | `public` | \{\} | `undefined` | - | [`TestResult`](TestResult.mdx).`meta` | testplane-docs/.testplane/src/types/index.ts:145 | +| `parent` | `public` | `null` \| [`Suite`](../classes/Suite.mdx) | `null` | - | [`TestResult`](TestResult.mdx).`parent` | testplane-docs/.testplane/src/test-reader/test-object/test-object.ts:6 | +| `retriesLeft` | `public` | `number` | `undefined` | - | - | testplane-docs/.testplane/src/types/index.ts:151 | +| `sessionId` | `public` | `string` | `undefined` | - | [`TestResult`](TestResult.mdx).`sessionId` | testplane-docs/.testplane/src/types/index.ts:146 | +| `startTime` | `public` | `number` | `undefined` | - | [`TestResult`](TestResult.mdx).`startTime` | testplane-docs/.testplane/src/types/index.ts:147 | +| `testplaneCtx` | `public` | [`ExecutionThreadToolCtx`](ExecutionThreadToolCtx.mdx) | `undefined` | - | [`TestResult`](TestResult.mdx).`testplaneCtx` | testplane-docs/.testplane/src/types/index.ts:139 | + +## Accessors + +### browserId + +```ts +get browserId(): string +``` + +```ts +set browserId(id): void +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `id` | `string` | + +#### Returns + +`string` + +#### Inherited from + +[`TestResult`](TestResult.mdx).[`browserId`](TestResult.mdx#browserid) + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/configurable-test-object.ts:93 + +*** + +### browserVersion + +```ts +get browserVersion(): undefined | string +``` + +```ts +set browserVersion(version): void +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `version` | `string` | + +#### Returns + +`undefined` \| `string` + +#### Inherited from + +[`TestResult`](TestResult.mdx).[`browserVersion`](TestResult.mdx#browserversion) + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/configurable-test-object.ts:101 + +*** + +### disabled + +```ts +get disabled(): boolean +``` + +```ts +set disabled(val): void +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `val` | `boolean` | + +#### Returns + +`boolean` + +#### Inherited from + +[`TestResult`](TestResult.mdx).[`disabled`](TestResult.mdx#disabled) + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/configurable-test-object.ts:69 + +*** + +### file + +```ts +get file(): string +``` + +#### Returns + +`string` + +#### Inherited from + +[`TestResult`](TestResult.mdx).[`file`](TestResult.mdx#file) + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/configurable-test-object.ts:45 + +*** + +### hasBrowserVersionOverwritten + +```ts +get hasBrowserVersionOverwritten(): boolean +``` + +#### Returns + +`boolean` + +#### Inherited from + +[`TestResult`](TestResult.mdx).[`hasBrowserVersionOverwritten`](TestResult.mdx#hasbrowserversionoverwritten) + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/configurable-test-object.ts:105 + +*** + +### id + +```ts +get id(): string +``` + +#### Returns + +`string` + +#### Inherited from + +[`TestResult`](TestResult.mdx).[`id`](TestResult.mdx#id) + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/configurable-test-object.ts:41 + +*** + +### pending + +```ts +get pending(): boolean +``` + +```ts +set pending(val): void +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `val` | `boolean` | + +#### Returns + +`boolean` + +#### Inherited from + +[`TestResult`](TestResult.mdx).[`pending`](TestResult.mdx#pending) + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/configurable-test-object.ts:53 + +*** + +### silentSkip + +```ts +get silentSkip(): boolean +``` + +```ts +set silentSkip(val): void +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `val` | `boolean` | + +#### Returns + +`boolean` + +#### Inherited from + +[`TestResult`](TestResult.mdx).[`silentSkip`](TestResult.mdx#silentskip) + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/configurable-test-object.ts:77 + +*** + +### skipReason + +```ts +get skipReason(): string +``` + +```ts +set skipReason(reason): void +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `reason` | `string` | + +#### Returns + +`string` + +#### Inherited from + +[`TestResult`](TestResult.mdx).[`skipReason`](TestResult.mdx#skipreason) + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/configurable-test-object.ts:61 + +*** + +### timeout + +```ts +get timeout(): number +``` + +```ts +set timeout(timeout): void +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `timeout` | `number` | + +#### Returns + +`number` + +#### Inherited from + +[`TestResult`](TestResult.mdx).[`timeout`](TestResult.mdx#timeout) + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/configurable-test-object.ts:85 + +*** + +### title + +```ts +get title(): string +``` + +#### Returns + +`string` + +#### Inherited from + +[`TestResult`](TestResult.mdx).[`title`](TestResult.mdx#title) + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/test-object.ts:16 + +## Methods + +### assign() + +```ts +assign(src): this +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `src` | `this` | + +#### Returns + +`this` + +#### Inherited from + +[`TestResult`](TestResult.mdx).[`assign`](TestResult.mdx#assign) + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/configurable-test-object.ts:20 + +*** + +### clone() + +```ts +clone(): Test +``` + +#### Returns + +[`Test`](../classes/Test.mdx) + +#### Inherited from + +[`TestResult`](TestResult.mdx).[`clone`](TestResult.mdx#clone) + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/test.ts:23 + +*** + +### disable() + +```ts +disable(): void +``` + +#### Returns + +`void` + +#### Inherited from + +[`TestResult`](TestResult.mdx).[`disable`](TestResult.mdx#disable) + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/configurable-test-object.ts:31 + +*** + +### enable() + +```ts +enable(): void +``` + +#### Returns + +`void` + +#### Inherited from + +[`TestResult`](TestResult.mdx).[`enable`](TestResult.mdx#enable) + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/configurable-test-object.ts:36 + +*** + +### fullTitle() + +```ts +fullTitle(): string +``` + +#### Returns + +`string` + +#### Inherited from + +[`TestResult`](TestResult.mdx).[`fullTitle`](TestResult.mdx#fulltitle) + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/test-object.ts:30 + +*** + +### skip() + +```ts +skip(__namedParameters): void +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `SkipData` | + +#### Returns + +`void` + +#### Inherited from + +[`TestResult`](TestResult.mdx).[`skip`](TestResult.mdx#skip) + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/configurable-test-object.ts:26 + +*** + +### titlePath() + +```ts +titlePath(): string[] +``` + +#### Returns + +`string`[] + +#### Inherited from + +[`TestResult`](TestResult.mdx).[`titlePath`](TestResult.mdx#titlepath) + +#### Defined in + +testplane-docs/.testplane/src/test-reader/test-object/test-object.ts:20 diff --git a/i18n/en/docusaurus-plugin-content-docs/current/api-reference/interfaces/TestplaneCtx.mdx b/i18n/en/docusaurus-plugin-content-docs/current/api-reference/interfaces/TestplaneCtx.mdx new file mode 100644 index 0000000..3d91be2 --- /dev/null +++ b/i18n/en/docusaurus-plugin-content-docs/current/api-reference/interfaces/TestplaneCtx.mdx @@ -0,0 +1,11 @@ +[testplane](../README.mdx) / TestplaneCtx + +# Interface: ~~TestplaneCtx~~ + +## Deprecated + +Use `TestplaneCtx` instead + +## Extends + +- [`HermioneCtx`](HermioneCtx.mdx) diff --git a/i18n/en/docusaurus-plugin-content-docs/current/api-reference/interfaces/WdioBrowser.mdx b/i18n/en/docusaurus-plugin-content-docs/current/api-reference/interfaces/WdioBrowser.mdx new file mode 100644 index 0000000..f321ad4 --- /dev/null +++ b/i18n/en/docusaurus-plugin-content-docs/current/api-reference/interfaces/WdioBrowser.mdx @@ -0,0 +1,10465 @@ +[testplane](../README.mdx) / WdioBrowser + +# Interface: ~~WdioBrowser~~ + +## Deprecated + +use `WebdriverIO.Browser` instead + +## Extends + +- `Omit`\<`BrowserBase`, `"on"` \| `"once"`\>.`BidiEventHandler`.`BidiHandler`.`ProtocolCommands`.`BrowserCommandsType` + +## Properties + +| Property | Type | Description | Inherited from | Defined in | +| ------ | ------ | ------ | ------ | ------ | +| ~~`$`~~ | (...`args`: [`Selector`]) => `ChainablePromiseElement`\<`Element`\> | - | `BrowserCommandsType.$` | | +| ~~`$$`~~ | (...`args`: [`HTMLElement`[] \| `Selector` \| `ElementReference`[] \| `Element`[]]) => `ChainablePromiseArray`\<`ElementArray`\> | - | `BrowserCommandsType.$$` | | +| ~~`CDP_SESSIONS`~~ | `Record`\<`string`, `CDPSession`\> | - | `BrowserCommandsType.CDP_SESSIONS` | testplane/node\_modules/webdriverio/build/commands/browser/mock.d.ts:6 | +| ~~`SESSION_MOCKS`~~ | `Record`\<`string`, `Set`\<`Interception`\>\> | - | `BrowserCommandsType.SESSION_MOCKS` | testplane/node\_modules/webdriverio/build/commands/browser/mock.d.ts:5 | +| ~~`action`~~ | (`this`: `Browser`, `type`: `"key"`, `opts`?: `Pick`\<`BaseActionParams`, `"id"`\>) => `KeyAction`(`this`: `Browser`, `type`: `"pointer"`, `opts`?: `BaseActionParams`) => `PointerAction`(`this`: `Browser`, `type`: `"wheel"`, `opts`?: `Pick`\<`BaseActionParams`, `"id"`\>) => `WheelAction` | - | `BrowserCommandsType.action` | testplane/node\_modules/webdriverio/build/commands/browser/action.d.ts:151 | +| ~~`actions`~~ | (`this`: `Browser`, `actions`: (`KeyAction` \| `PointerAction` \| `WheelAction`)[]) => `Promise`\<`void`\> | - | `BrowserCommandsType.actions` | testplane/node\_modules/webdriverio/build/commands/browser/actions.d.ts:28 | +| ~~`call`~~ | \<`T`\>(`fn`: () => `T`) => `T` \| `Promise`\<`T`\> | - | `BrowserCommandsType.call` | testplane/node\_modules/webdriverio/build/commands/browser/call.d.ts:43 | +| ~~`capabilities`~~ | `RemoteCapability` | Applied capabilities used in the current session. Note: these can differ from the actual requested capabilities if the remote end couldn't provide an exact match. | `Omit.capabilities` | testplane/node\_modules/webdriverio/build/types.d.ts:154 | +| ~~`commandList`~~ | `string`[] | - | `Omit.commandList` | testplane/node\_modules/webdriverio/build/types.d.ts:169 | +| ~~`custom$`~~ | (...`args`: [`string`, `...strategyArguments: any[]`]) => `ChainablePromiseElement`\<`Element`\> | - | `BrowserCommandsType.custom$` | | +| ~~`custom$$`~~ | (...`args`: [`string`, `...strategyArguments: any[]`]) => `ChainablePromiseArray`\<`ElementArray`\> | - | `BrowserCommandsType.custom$$` | | +| ~~`debug`~~ | (`this`: `Browser`, `commandTimeout`?: `number`) => `Promise`\<`unknown`\> | - | `BrowserCommandsType.debug` | testplane/node\_modules/webdriverio/build/commands/browser/debug.d.ts:31 | +| ~~`deleteCookies`~~ | (`this`: `Browser`, `names`?: `string` \| `string`[]) => `Promise`\<`void`\> \| `Promise`\<`void`[]\> | - | `BrowserCommandsType.deleteCookies` | testplane/node\_modules/webdriverio/build/commands/browser/deleteCookies.d.ts:11 | +| ~~`downloadFile`~~ | (`this`: `Browser`, `fileName`: `string`, `targetDirectory`: `string`) => `Promise`\<`object`\> | - | `BrowserCommandsType.downloadFile` | testplane/node\_modules/webdriverio/build/commands/browser/downloadFile.d.ts:43 | +| ~~`emulate`~~ | \<`Scope`\>(`this`: `Browser`, `scope`: `Scope`, `options`: `EmulationOptions`\[`Scope`\]) => `Promise`\<`void`\> | - | `BrowserCommandsType.emulate` | testplane/node\_modules/webdriverio/build/commands/browser/emulate.d.ts:34 | +| ~~`execute`~~ | \<`ReturnValue`, `InnerArguments`\>(`this`: `Browser` \| `MultiRemoteBrowser` \| `Element`, `script`: `string` \| (...`innerArgs`) => `ReturnValue`, ...`args`: `InnerArguments`) => `Promise`\<`ReturnValue`\> | - | `BrowserCommandsType.execute` | testplane/node\_modules/webdriverio/build/commands/browser/execute.d.ts:36 | +| ~~`executeAsync`~~ | \<`ReturnValue`, `InnerArguments`\>(`this`: `Browser` \| `Element`, `script`: `string` \| (...`args`) => `void`, ...`args`: `InnerArguments`) => `Promise`\<`ReturnValue`\> | - | `BrowserCommandsType.executeAsync` | testplane/node\_modules/webdriverio/build/commands/browser/executeAsync.d.ts:44 | +| ~~`getCookies`~~ | (`this`: `Browser`, `names`?: `string` \| `string`[]) => `Promise`\<`Cookie`[]\> | - | `BrowserCommandsType.getCookies` | testplane/node\_modules/webdriverio/build/commands/browser/getCookies.d.ts:33 | +| ~~`getPuppeteer`~~ | (`this`: `Browser`) => `Promise`\<`PuppeteerBrowser`\> | - | `BrowserCommandsType.getPuppeteer` | testplane/node\_modules/webdriverio/build/commands/browser/getPuppeteer.d.ts:37 | +| ~~`getWindowSize`~~ | (`this`: `Browser`) => `Promise`\<`BrowserSize`\> | - | `BrowserCommandsType.getWindowSize` | testplane/node\_modules/webdriverio/build/commands/browser/getWindowSize.d.ts:23 | +| ~~`isAndroid`~~ | `boolean` | - | `Omit.isAndroid` | testplane/node\_modules/webdriver/build/types.d.ts:16 | +| ~~`isBidi`~~ | `boolean` | - | `Omit.isBidi` | testplane/node\_modules/webdriver/build/types.d.ts:22 | +| ~~`isChromium`~~ | `boolean` | - | `Omit.isChromium` | testplane/node\_modules/webdriver/build/types.d.ts:14 | +| ~~`isDevTools`~~ | `boolean` | - | `Omit.isDevTools` | testplane/node\_modules/webdriver/build/types.d.ts:21 | +| ~~`isFirefox`~~ | `boolean` | - | `Omit.isFirefox` | testplane/node\_modules/webdriver/build/types.d.ts:15 | +| ~~`isIOS`~~ | `boolean` | - | `Omit.isIOS` | testplane/node\_modules/webdriver/build/types.d.ts:18 | +| ~~`isMobile`~~ | `boolean` | - | `Omit.isMobile` | testplane/node\_modules/webdriver/build/types.d.ts:17 | +| ~~`isMultiremote`~~ | `false` | - | `Omit.isMultiremote` | testplane/node\_modules/webdriverio/build/types.d.ts:183 | +| ~~`isSauce`~~ | `boolean` | - | `Omit.isSauce` | testplane/node\_modules/webdriver/build/types.d.ts:19 | +| ~~`isSeleniumStandalone`~~ | `boolean` | - | `Omit.isSeleniumStandalone` | testplane/node\_modules/webdriver/build/types.d.ts:20 | +| ~~`isW3C`~~ | `boolean` | - | `Omit.isW3C` | testplane/node\_modules/webdriver/build/types.d.ts:13 | +| ~~`keys`~~ | (`this`: `Browser`, `value`: `string` \| `string`[]) => `Promise`\<`void`\> | - | `BrowserCommandsType.keys` | testplane/node\_modules/webdriverio/build/commands/browser/keys.d.ts:22 | +| ~~`mock`~~ | (`this`: `Browser`, `url`: `string` \| `RegExp`, `filterOptions`?: `MockFilterOptions`) => `Promise`\<`Mock`\> | - | `BrowserCommandsType.mock` | testplane/node\_modules/webdriverio/build/commands/browser/mock.d.ts:113 | +| ~~`mockClearAll`~~ | () => `Promise`\<`void`\> | - | `BrowserCommandsType.mockClearAll` | testplane/node\_modules/webdriverio/build/commands/browser/mockClearAll.d.ts:27 | +| ~~`mockRestoreAll`~~ | () => `Promise`\<`void`\> | - | `BrowserCommandsType.mockRestoreAll` | testplane/node\_modules/webdriverio/build/commands/browser/mockRestoreAll.d.ts:25 | +| ~~`newWindow`~~ | (`this`: `Browser`, `url`: `string`, `__namedParameters`?: `NewWindowOptions`) => `Promise`\<`string`\> | - | `BrowserCommandsType.newWindow` | testplane/node\_modules/webdriverio/build/commands/browser/newWindow.d.ts:40 | +| ~~`options`~~ | `WebdriverIO` \| `Testrunner` | Applied WebdriverIO options (options that aren't officially part of WebdriverIO are stripped out of this object). | `Omit.options` | testplane/node\_modules/webdriverio/build/types.d.ts:163 | +| ~~`pause`~~ | (`this`: `Browser`, `milliseconds`?: `number`) => `Promise`\<`unknown`\> | - | `BrowserCommandsType.pause` | testplane/node\_modules/webdriverio/build/commands/browser/pause.d.ts:22 | +| ~~`puppeteer?`~~ | `Browser` | Puppeteer instance | `Omit.puppeteer` | testplane/node\_modules/webdriverio/build/types.d.ts:167 | +| ~~`react$`~~ | (...`args`: [`string`, `ReactSelectorOptions?`]) => `ChainablePromiseElement`\<`Element`\> | - | `BrowserCommandsType.react$` | | +| ~~`react$$`~~ | (...`args`: [`string`, `ReactSelectorOptions?`]) => `ChainablePromiseArray`\<`ElementArray`\> | - | `BrowserCommandsType.react$$` | | +| ~~`reloadSession`~~ | (`this`: `Browser`, `newCapabilities`?: `Capabilities`) => `Promise`\<`string`\> | - | `BrowserCommandsType.reloadSession` | testplane/node\_modules/webdriverio/build/commands/browser/reloadSession.d.ts:51 | +| ~~`requestedCapabilities`~~ | `RemoteCapability` | Requested capabilities defined in the config object. | `Omit.requestedCapabilities` | testplane/node\_modules/webdriverio/build/types.d.ts:158 | +| ~~`savePDF`~~ | (`this`: `Browser`, `filepath`: `string`, `options`?: `PDFPrintOptions`) => `Promise`\<`Buffer`\> | - | `BrowserCommandsType.savePDF` | testplane/node\_modules/webdriverio/build/commands/browser/savePDF.d.ts:44 | +| ~~`saveRecordingScreen`~~ | (`this`: `Browser`, `filepath`: `string`) => `Promise`\<`Buffer`\> | - | `BrowserCommandsType.saveRecordingScreen` | testplane/node\_modules/webdriverio/build/commands/browser/saveRecordingScreen.d.ts:27 | +| ~~`saveScreenshot`~~ | (`this`: `Browser`, `filepath`: `string`) => `Promise`\<`Buffer`\> | - | `BrowserCommandsType.saveScreenshot` | testplane/node\_modules/webdriverio/build/commands/browser/saveScreenshot.d.ts:28 | +| ~~`scroll`~~ | (`this`: `Browser`, `x`?: `number`, `y`?: `number`) => `void` \| `Promise`\<`void`\> | - | `BrowserCommandsType.scroll` | testplane/node\_modules/webdriverio/build/commands/browser/scroll.d.ts:24 | +| ~~`sessionId`~~ | `string` | Session id for the current running session | `Omit.sessionId` | testplane/node\_modules/webdriverio/build/types.d.ts:149 | +| ~~`setCookies`~~ | (`this`: `Browser`, `cookieObjs`: `Cookie` \| `Cookie`[]) => `Promise`\<`void`\> | - | `BrowserCommandsType.setCookies` | testplane/node\_modules/webdriverio/build/commands/browser/setCookies.d.ts:56 | +| ~~`setTimeout`~~ | (`this`: `Browser`, `timeouts`: `Partial`\<`Timeouts`\>) => `Promise`\<`void`\> | - | `BrowserCommandsType.setTimeout` | testplane/node\_modules/webdriverio/build/commands/browser/setTimeout.d.ts:37 | +| ~~`setWindowSize`~~ | (`this`: `Browser`, `width`: `number`, `height`: `number`) => `Promise`\<`void`\> | - | `BrowserCommandsType.setWindowSize` | testplane/node\_modules/webdriverio/build/commands/browser/setWindowSize.d.ts:19 | +| ~~`shadow$`~~ | (...`args`: [`string`]) => `ChainablePromiseElement`\<`Element`\> | - | `BrowserCommandsType.shadow$` | | +| ~~`shadow$$`~~ | (...`args`: [`string`]) => `ChainablePromiseArray`\<`ElementArray`\> | - | `BrowserCommandsType.shadow$$` | | +| ~~`strategies`~~ | `Map`\<`any`, `any`\> | - | `Omit.strategies` | testplane/node\_modules/webdriverio/build/types.d.ts:168 | +| ~~`switchWindow`~~ | (`this`: `Browser`, `matcher`: `string` \| `RegExp`) => `Promise`\<`string`\> | - | `BrowserCommandsType.switchWindow` | testplane/node\_modules/webdriverio/build/commands/browser/switchWindow.d.ts:29 | +| ~~`throttle`~~ | (`this`: `Browser`, `params`: `ThrottleOptions`) => `Promise`\<`void`\> | - | `BrowserCommandsType.throttle` | testplane/node\_modules/webdriverio/build/commands/browser/throttle.d.ts:5 | +| ~~`throttleNetwork`~~ | (`this`: `Browser`, `params`: `ThrottleOptions`) => `Promise`\<`null`\> | - | `BrowserCommandsType.throttleNetwork` | testplane/node\_modules/webdriverio/build/commands/browser/throttleNetwork.d.ts:2 | +| ~~`touchAction`~~ | (`this`: `Browser`, `actions`: `TouchActions`) => `Promise`\<`void`\> | - | `BrowserCommandsType.touchAction` | testplane/node\_modules/webdriverio/build/commands/browser/touchAction.d.ts:73 | +| ~~`uploadFile`~~ | (`this`: `Browser`, `localPath`: `string`) => `Promise`\<`string`\> | - | `BrowserCommandsType.uploadFile` | testplane/node\_modules/webdriverio/build/commands/browser/uploadFile.d.ts:31 | +| ~~`url`~~ | (`this`: `Browser`, `path`: `string`) => `Promise`\<`string`\> | - | `BrowserCommandsType.url` | testplane/node\_modules/webdriverio/build/commands/browser/url.d.ts:37 | +| ~~`waitUntil`~~ | \<`ReturnValue`\>(`this`: `Browser` \| `Element`, `condition`: () => `ReturnValue` \| `Promise`\<`ReturnValue`\>, `__namedParameters`?: `Partial`\<`WaitUntilOptions`\>) => `Promise`\<`Exclude`\<`ReturnValue`, `boolean`\>\> | - | `BrowserCommandsType.waitUntil` | testplane/node\_modules/webdriverio/build/commands/browser/waitUntil.d.ts:21 | + +## Accessors + +### ~~isConnected~~ + +```ts +get isConnected(): boolean +``` + +#### Returns + +`boolean` + +#### Inherited from + +`BidiHandler.isConnected` + +#### Defined in + +testplane/node\_modules/webdriver/build/bidi/core.d.ts:12 + +*** + +### ~~socket~~ + +```ts +get socket(): WebSocket +``` + +#### Returns + +`WebSocket` + +#### Inherited from + +`BidiHandler.socket` + +#### Defined in + +testplane/node\_modules/webdriver/build/bidi/core.d.ts:11 + +## Methods + +### ~~\[captureRejectionSymbol\]()?~~ + +```ts +optional [captureRejectionSymbol]( + error, + event, ... + args): void +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `error` | `Error` | +| `event` | `string` | +| ...`args` | `any`[] | + +#### Returns + +`void` + +#### Inherited from + +`Omit.[captureRejectionSymbol]` + +#### Defined in + +testplane/node\_modules/@types/node/events.d.ts:115 + +*** + +### ~~\_getWindowSize()~~ + +```ts +_getWindowSize(): Promise +``` + +Jsonwp Protocol Command + +Get the size of the current focused window. + +#### Returns + +`Promise`\<`ProtocolCommandResponse`\> + +#### Ref + +https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#get-sessionsessionidwindowwindowhandlesize + +#### Deprecated + +This command is deprecated and likely not supported by any browser. + +#### Inherited from + +`ProtocolCommands._getWindowSize` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/jsonwp.d.ts:193 + +*** + +### ~~\_setWindowSize()~~ + +```ts +_setWindowSize(width, height): Promise +``` + +Jsonwp Protocol Command + +Change the size of the current focused window. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `width` | `number` | +| `height` | `number` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#post-sessionsessionidwindowwindowhandlesize + +#### Deprecated + +This command is deprecated and likely not supported by any browser. + +#### Inherited from + +`ProtocolCommands._setWindowSize` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/jsonwp.d.ts:202 + +*** + +### ~~acceptAlert()~~ + +```ts +acceptAlert(): Promise +``` + +Webdriver Protocol Command + +The Accept Alert command accepts a simple dialog if present, otherwise error. + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://w3c.github.io/webdriver/#dfn-accept-alert + +#### Inherited from + +`ProtocolCommands.acceptAlert` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:450 + +*** + +### ~~activateApp()~~ + +```ts +activateApp(appId): Promise +``` + +Appium Protocol Command + +Activate the given app onto the device + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `appId` | `string` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://appium.github.io/appium.io/docs/en/commands/device/app/activate-app/ + +#### Inherited from + +`ProtocolCommands.activateApp` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/appium.d.ts:154 + +*** + +### ~~activateIME()~~ + +```ts +activateIME(engine): Promise +``` + +Jsonwp Protocol Command + +No description available, please see reference link. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `engine` | `string` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidimeactivate + +#### Deprecated + +This command is deprecated and likely not supported by any browser. + +#### Inherited from + +`ProtocolCommands.activateIME` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/jsonwp.d.ts:525 + +*** + +### ~~addCommand()~~ + +```ts +addCommand( + name, + func, + attachToElement?, + proto?, + instances?): void +``` + +add command to `browser` or `element` scope + +#### Type Parameters + +| Type Parameter | Default type | +| ------ | ------ | +| `IsElement` *extends* `boolean` | `false` | + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `name` | `string` | +| `func` | `AddCommandFn` \| `AddCommandFnScoped`\<[`WdioBrowser`](WdioBrowser.mdx), `IsElement`\> | +| `attachToElement`? | `IsElement` | +| `proto`? | `Record`\<`string`, `any`\> | +| `instances`? | `Record`\<`string`, `Browser` \| `MultiRemoteBrowser`\> | + +#### Returns + +`void` + +#### Inherited from + +`Omit.addCommand` + +#### Defined in + +testplane/node\_modules/webdriverio/build/types.d.ts:135 + +*** + +### ~~addCookie()~~ + +```ts +addCookie(cookie): Promise +``` + +Webdriver Protocol Command + +The Add Cookie command adds a single cookie to the cookie store associated with the active document's address. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `cookie` | `object` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://w3c.github.io/webdriver/#dfn-adding-a-cookie + +#### Inherited from + +`ProtocolCommands.addCookie` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:394 + +*** + +### ~~addCredential()~~ + +```ts +addCredential( + authenticatorId, + credentialId, + isResidentCredential, + rpId, + privateKey, + userHandle, + signCount, +largeBlob?): Promise +``` + +Webdriver Protocol Command + +Injects a Public Key Credential Source into an existing Virtual Authenticator. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `authenticatorId` | `string` | +| `credentialId` | `string` | +| `isResidentCredential` | `boolean` | +| `rpId` | `string` | +| `privateKey` | `string` | +| `userHandle` | `string` | +| `signCount` | `number` | +| `largeBlob`? | `string` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://www.w3.org/TR/webauthn-2/#sctn-automation-add-credential + +#### Inherited from + +`ProtocolCommands.addCredential` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:593 + +*** + +### ~~addListener()~~ + +```ts +addListener(eventName, listener): this +``` + +Alias for `emitter.on(eventName, listener)`. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `eventName` | `string` \| `symbol` | +| `listener` | (...`args`) => `void` | + +#### Returns + +`this` + +#### Since + +v0.1.26 + +#### Inherited from + +`Omit.addListener` + +#### Defined in + +testplane/node\_modules/@types/node/events.d.ts:475 + +*** + +### ~~addLocatorStrategy()~~ + +```ts +addLocatorStrategy(name, func): void +``` + +create custom selector + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `name` | `string` | +| `func` | (`selector`, `root`) => `CustomLocatorReturnValue` \| (`selector`) => `CustomLocatorReturnValue` | + +#### Returns + +`void` + +#### Inherited from + +`Omit.addLocatorStrategy` + +#### Defined in + +testplane/node\_modules/webdriverio/build/types.d.ts:143 + +*** + +### ~~addVirtualAuthenticator()~~ + +```ts +addVirtualAuthenticator( + protocol?, + transport?, + hasResidentKey?, + hasUserVerification?, + isUserConsenting?, + isUserVerified?, + extensions?, +uvm?): Promise +``` + +Webdriver Protocol Command + +Creates a software [Virtual Authenticator](https://www.w3.org/TR/webauthn-2/#virtual-authenticators). + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `protocol`? | `string` | +| `transport`? | `string` | +| `hasResidentKey`? | `boolean` | +| `hasUserVerification`? | `boolean` | +| `isUserConsenting`? | `boolean` | +| `isUserVerified`? | `boolean` | +| `extensions`? | `string`[] | +| `uvm`? | `object`[] | + +#### Returns + +`Promise`\<`string`\> + +#### Ref + +https://www.w3.org/TR/webauthn-2/#sctn-automation-add-virtual-authenticator + +#### Inherited from + +`ProtocolCommands.addVirtualAuthenticator` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:577 + +*** + +### ~~assertPerformance()~~ + +```ts +assertPerformance(name, metrics?): Promise +``` + +Saucelabs Protocol Command + +Assert against the performance baseline of your app. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `name` | `string` | +| `metrics`? | `string`[] | + +#### Returns + +`Promise`\<`ProtocolCommandResponse`\> + +#### Ref + +https://wiki.saucelabs.com/display/DOCS/Custom+Sauce+Labs+WebDriver+Extensions+for+Network+and+Log+Commands + +#### Example + +```js +// test performance for a page +browser.url('https://webdriver.io') +const hasRegression = browser.assertPerformance({ + name: 'my performance test', // make sure that the name is also set in the sauce options in your capabilities + metrics: ['score', 'firstPaint'] +}) +``` + +#### Inherited from + +`ProtocolCommands.assertPerformance` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/saucelabs.d.ts:147 + +*** + +### ~~back()~~ + +```ts +back(): Promise +``` + +Webdriver Protocol Command + +The Back command causes the browser to traverse one step backward in the joint session history of the current top-level browsing context. This is equivalent to pressing the back button in the browser chrome or calling `window.history.back`. + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://w3c.github.io/webdriver/#dfn-back + +#### Inherited from + +`ProtocolCommands.back` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:66 + +*** + +### ~~background()~~ + +```ts +background(seconds): Promise +``` + +Appium Protocol Command + +Send the currently running app for this session to the background. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `seconds` | `null` \| `number` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://appium.github.io/appium.io/docs/en/commands/device/app/background-app/ + +#### Deprecated + +Use `driver.execute('mobile: backgroundApp', { ... })` instead + +#### Inherited from + +`ProtocolCommands.background` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/appium.d.ts:349 + +*** + +### ~~browserClose()~~ + +```ts +browserClose(params): Promise +``` + +WebDriver Bidi command to send command method "browser.close" with parameters. + +#### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `params` | `EmptyParams` | `remote.EmptyParams` [command parameter](https://w3c.github.io/webdriver-bidi/#command-browser-close) | + +#### Returns + +`Promise`\<`EmptyResult`\> + +`Promise` + +#### Url + +https://w3c.github.io/webdriver-bidi/#command-browser-close + +#### Inherited from + +`BidiHandler.browserClose` + +#### Defined in + +testplane/node\_modules/webdriver/build/bidi/handler.d.ts:60 + +*** + +### ~~browsingContextActivate()~~ + +```ts +browsingContextActivate(params): Promise +``` + +WebDriver Bidi command to send command method "browsingContext.activate" with parameters. + +#### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `params` | `BrowsingContextActivateParameters` | `remote.BrowsingContextActivateParameters` [command parameter](https://w3c.github.io/webdriver-bidi/#command-browsingContext-activate) | + +#### Returns + +`Promise`\<`EmptyResult`\> + +`Promise` + +#### Url + +https://w3c.github.io/webdriver-bidi/#command-browsingContext-activate + +#### Inherited from + +`BidiHandler.browsingContextActivate` + +#### Defined in + +testplane/node\_modules/webdriver/build/bidi/handler.d.ts:67 + +*** + +### ~~browsingContextCaptureScreenshot()~~ + +```ts +browsingContextCaptureScreenshot(params): Promise +``` + +WebDriver Bidi command to send command method "browsingContext.captureScreenshot" with parameters. + +#### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `params` | `BrowsingContextCaptureScreenshotParameters` | `remote.BrowsingContextCaptureScreenshotParameters` [command parameter](https://w3c.github.io/webdriver-bidi/#command-browsingContext-captureScreenshot) | + +#### Returns + +`Promise`\<`BrowsingContextCaptureScreenshotResult`\> + +`Promise` + +#### Url + +https://w3c.github.io/webdriver-bidi/#command-browsingContext-captureScreenshot + +#### Inherited from + +`BidiHandler.browsingContextCaptureScreenshot` + +#### Defined in + +testplane/node\_modules/webdriver/build/bidi/handler.d.ts:74 + +*** + +### ~~browsingContextClose()~~ + +```ts +browsingContextClose(params): Promise +``` + +WebDriver Bidi command to send command method "browsingContext.close" with parameters. + +#### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `params` | `BrowsingContextCloseParameters` | `remote.BrowsingContextCloseParameters` [command parameter](https://w3c.github.io/webdriver-bidi/#command-browsingContext-close) | + +#### Returns + +`Promise`\<`EmptyResult`\> + +`Promise` + +#### Url + +https://w3c.github.io/webdriver-bidi/#command-browsingContext-close + +#### Inherited from + +`BidiHandler.browsingContextClose` + +#### Defined in + +testplane/node\_modules/webdriver/build/bidi/handler.d.ts:81 + +*** + +### ~~browsingContextCreate()~~ + +```ts +browsingContextCreate(params): Promise +``` + +WebDriver Bidi command to send command method "browsingContext.create" with parameters. + +#### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `params` | `BrowsingContextCreateParameters` | `remote.BrowsingContextCreateParameters` [command parameter](https://w3c.github.io/webdriver-bidi/#command-browsingContext-create) | + +#### Returns + +`Promise`\<`BrowsingContextCreateResult`\> + +`Promise` + +#### Url + +https://w3c.github.io/webdriver-bidi/#command-browsingContext-create + +#### Inherited from + +`BidiHandler.browsingContextCreate` + +#### Defined in + +testplane/node\_modules/webdriver/build/bidi/handler.d.ts:88 + +*** + +### ~~browsingContextGetTree()~~ + +```ts +browsingContextGetTree(params): Promise +``` + +WebDriver Bidi command to send command method "browsingContext.getTree" with parameters. + +#### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `params` | `BrowsingContextGetTreeParameters` | `remote.BrowsingContextGetTreeParameters` [command parameter](https://w3c.github.io/webdriver-bidi/#command-browsingContext-getTree) | + +#### Returns + +`Promise`\<`BrowsingContextGetTreeResult`\> + +`Promise` + +#### Url + +https://w3c.github.io/webdriver-bidi/#command-browsingContext-getTree + +#### Inherited from + +`BidiHandler.browsingContextGetTree` + +#### Defined in + +testplane/node\_modules/webdriver/build/bidi/handler.d.ts:95 + +*** + +### ~~browsingContextHandleUserPrompt()~~ + +```ts +browsingContextHandleUserPrompt(params): Promise +``` + +WebDriver Bidi command to send command method "browsingContext.handleUserPrompt" with parameters. + +#### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `params` | `BrowsingContextHandleUserPromptParameters` | `remote.BrowsingContextHandleUserPromptParameters` [command parameter](https://w3c.github.io/webdriver-bidi/#command-browsingContext-handleUserPrompt) | + +#### Returns + +`Promise`\<`EmptyResult`\> + +`Promise` + +#### Url + +https://w3c.github.io/webdriver-bidi/#command-browsingContext-handleUserPrompt + +#### Inherited from + +`BidiHandler.browsingContextHandleUserPrompt` + +#### Defined in + +testplane/node\_modules/webdriver/build/bidi/handler.d.ts:102 + +*** + +### ~~browsingContextLocateNodes()~~ + +```ts +browsingContextLocateNodes(params): Promise +``` + +WebDriver Bidi command to send command method "browsingContext.locateNodes" with parameters. + +#### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `params` | `BrowsingContextLocateNodesParameters` | `remote.BrowsingContextLocateNodesParameters` [command parameter](https://w3c.github.io/webdriver-bidi/#command-browsingContext-locateNodes) | + +#### Returns + +`Promise`\<`BrowsingContextLocateNodesResult`\> + +`Promise` + +#### Url + +https://w3c.github.io/webdriver-bidi/#command-browsingContext-locateNodes + +#### Inherited from + +`BidiHandler.browsingContextLocateNodes` + +#### Defined in + +testplane/node\_modules/webdriver/build/bidi/handler.d.ts:109 + +*** + +### ~~browsingContextNavigate()~~ + +```ts +browsingContextNavigate(params): Promise +``` + +WebDriver Bidi command to send command method "browsingContext.navigate" with parameters. + +#### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `params` | `BrowsingContextNavigateParameters` | `remote.BrowsingContextNavigateParameters` [command parameter](https://w3c.github.io/webdriver-bidi/#command-browsingContext-navigate) | + +#### Returns + +`Promise`\<`BrowsingContextNavigateResult`\> + +`Promise` + +#### Url + +https://w3c.github.io/webdriver-bidi/#command-browsingContext-navigate + +#### Inherited from + +`BidiHandler.browsingContextNavigate` + +#### Defined in + +testplane/node\_modules/webdriver/build/bidi/handler.d.ts:116 + +*** + +### ~~browsingContextPrint()~~ + +```ts +browsingContextPrint(params): Promise +``` + +WebDriver Bidi command to send command method "browsingContext.print" with parameters. + +#### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `params` | `BrowsingContextPrintParameters` | `remote.BrowsingContextPrintParameters` [command parameter](https://w3c.github.io/webdriver-bidi/#command-browsingContext-print) | + +#### Returns + +`Promise`\<`BrowsingContextPrintResult`\> + +`Promise` + +#### Url + +https://w3c.github.io/webdriver-bidi/#command-browsingContext-print + +#### Inherited from + +`BidiHandler.browsingContextPrint` + +#### Defined in + +testplane/node\_modules/webdriver/build/bidi/handler.d.ts:123 + +*** + +### ~~browsingContextReload()~~ + +```ts +browsingContextReload(params): Promise +``` + +WebDriver Bidi command to send command method "browsingContext.reload" with parameters. + +#### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `params` | `BrowsingContextReloadParameters` | `remote.BrowsingContextReloadParameters` [command parameter](https://w3c.github.io/webdriver-bidi/#command-browsingContext-reload) | + +#### Returns + +`Promise`\<`EmptyResult`\> + +`Promise` + +#### Url + +https://w3c.github.io/webdriver-bidi/#command-browsingContext-reload + +#### Inherited from + +`BidiHandler.browsingContextReload` + +#### Defined in + +testplane/node\_modules/webdriver/build/bidi/handler.d.ts:130 + +*** + +### ~~browsingContextSetViewport()~~ + +```ts +browsingContextSetViewport(params): Promise +``` + +WebDriver Bidi command to send command method "browsingContext.setViewport" with parameters. + +#### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `params` | `BrowsingContextSetViewportParameters` | `remote.BrowsingContextSetViewportParameters` [command parameter](https://w3c.github.io/webdriver-bidi/#command-browsingContext-setViewport) | + +#### Returns + +`Promise`\<`EmptyResult`\> + +`Promise` + +#### Url + +https://w3c.github.io/webdriver-bidi/#command-browsingContext-setViewport + +#### Inherited from + +`BidiHandler.browsingContextSetViewport` + +#### Defined in + +testplane/node\_modules/webdriver/build/bidi/handler.d.ts:137 + +*** + +### ~~browsingContextTraverseHistory()~~ + +```ts +browsingContextTraverseHistory(params): Promise +``` + +WebDriver Bidi command to send command method "browsingContext.traverseHistory" with parameters. + +#### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `params` | `BrowsingContextTraverseHistoryParameters` | `remote.BrowsingContextTraverseHistoryParameters` [command parameter](https://w3c.github.io/webdriver-bidi/#command-browsingContext-traverseHistory) | + +#### Returns + +`Promise`\<`BrowsingContextTraverseHistoryResult`\> + +`Promise` + +#### Url + +https://w3c.github.io/webdriver-bidi/#command-browsingContext-traverseHistory + +#### Inherited from + +`BidiHandler.browsingContextTraverseHistory` + +#### Defined in + +testplane/node\_modules/webdriver/build/bidi/handler.d.ts:144 + +*** + +### ~~buttonDown()~~ + +```ts +buttonDown(button?): Promise +``` + +Jsonwp Protocol Command + +Click and hold the left mouse button (at the coordinates set by the last moveto command). Note that the next mouse-related command that should follow is buttonup . Any other mouse command (such as click or another call to buttondown) will yield undefined behaviour. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `button`? | `number` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidbuttondown + +#### Deprecated + +This command is deprecated and likely not supported by any browser. Use the "action" command instead to execute a click gesture! + +#### Inherited from + +`ProtocolCommands.buttonDown` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/jsonwp.d.ts:561 + +*** + +### ~~buttonUp()~~ + +```ts +buttonUp(button?): Promise +``` + +Jsonwp Protocol Command + +Releases the mouse button previously held (where the mouse is currently at). Must be called once for every buttondown command issued. See the note in click and buttondown about implications of out-of-order commands. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `button`? | `number` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidbuttonup + +#### Deprecated + +This command is deprecated and likely not supported by any browser. Use the "action" command instead to execute a click gesture! + +#### Inherited from + +`ProtocolCommands.buttonUp` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/jsonwp.d.ts:570 + +*** + +### ~~clearLocalStorage()~~ + +```ts +clearLocalStorage(): Promise +``` + +Jsonwp Protocol Command + +Clear the storage. + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#get-sessionsessionidlocal_storage + +#### Deprecated + +This command is deprecated and likely not supported by any browser. Use the "execute" command instead to interact with the session storage interface! + +#### Inherited from + +`ProtocolCommands.clearLocalStorage` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/jsonwp.d.ts:669 + +*** + +### ~~clearMockCalls()~~ + +```ts +clearMockCalls(mockId, restore?): Promise +``` + +Saucelabs Protocol Command + +Clear list of mock calls. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `mockId` | `string` | +| `restore`? | `boolean` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://wiki.saucelabs.com/display/DOCS/Custom+Sauce+Labs+WebDriver+Extensions+for+Network+and+Log+Commands + +#### Inherited from + +`ProtocolCommands.clearMockCalls` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/saucelabs.d.ts:185 + +*** + +### ~~clearSessionStorage()~~ + +```ts +clearSessionStorage(): Promise +``` + +Jsonwp Protocol Command + +Clear the storage. + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#delete-sessionsessionidsession_storage + +#### Deprecated + +This command is deprecated and likely not supported by any browser. Use the "execute" command instead to interact with the session storage interface! + +#### Inherited from + +`ProtocolCommands.clearSessionStorage` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/jsonwp.d.ts:723 + +*** + +### ~~closeApp()~~ + +```ts +closeApp(): Promise +``` + +Appium Protocol Command + +Close an app on device. + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://appium.github.io/appium.io/docs/en/commands/device/app/close-app/ + +#### Deprecated + +Use `driver.execute('mobile: terminateApp', { ... })` instead + +#### Inherited from + +`ProtocolCommands.closeApp` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/appium.d.ts:340 + +*** + +### ~~closeWindow()~~ + +```ts +closeWindow(): Promise +``` + +Webdriver Protocol Command + +The Close Window command closes the current top-level browsing context. Once done, if there are no more top-level browsing contexts open, the WebDriver session itself is closed. + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://w3c.github.io/webdriver/#dfn-close-window + +#### Inherited from + +`ProtocolCommands.closeWindow` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:106 + +*** + +### ~~compareImages()~~ + +```ts +compareImages( + mode, + firstImage, + secondImage, +options): Promise +``` + +Appium Protocol Command + +This feature conducts image comparisons utilizing the capabilities of the OpenCV framework. Please note that for this functionality to work, both the OpenCV framework and the opencv4nodejs module must be installed on the machine where the Appium server is operational. ***Furthermore, you'll need to have the [`images-plugin`](https://github.com/appium/appium/tree/master/packages/images-plugin) plugin installed to use this feature with Appium 2.0.*** + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `mode` | `string` | +| `firstImage` | `string` | +| `secondImage` | `string` | +| `options` | `object` | + +#### Returns + +`Promise`\<`ProtocolCommandResponse`\> + +#### Ref + +https://appium.github.io/appium.io/docs/en/writing-running-appium/image-comparison/ + +#### Inherited from + +`ProtocolCommands.compareImages` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/appium.d.ts:563 + +*** + +### ~~connect()~~ + +```ts +connect(): Promise +``` + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +`BidiHandler.connect` + +#### Defined in + +testplane/node\_modules/webdriver/build/bidi/core.d.ts:10 + +*** + +### ~~createMockSensor()~~ + +```ts +createMockSensor( + mockSensorType, + maxSamplingFrequency, +minSamplingFrequency): Promise +``` + +Webdriver Protocol Command + +Creates a mock sensor to emulate sensors like Ambient Light Sensor. __Note:__ this feature has not landed in all browsers yet. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `mockSensorType` | `string` | +| `maxSamplingFrequency` | `number` | +| `minSamplingFrequency` | `number` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://w3c.github.io/sensors/#create-mock-sensor-command + +#### Inherited from + +`ProtocolCommands.createMockSensor` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:537 + +*** + +### ~~createWindow()~~ + +```ts +createWindow(type): Promise +``` + +Webdriver Protocol Command + +Create a new top-level browsing context. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `type` | `"tab"` \| `"window"` | + +#### Returns + +`Promise`\<`WindowHandle`\> + +#### Ref + +https://w3c.github.io/webdriver/#new-window + +#### Inherited from + +`ProtocolCommands.createWindow` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:122 + +*** + +### ~~deactivateIME()~~ + +```ts +deactivateIME(): Promise +``` + +Jsonwp Protocol Command + +No description available, please see reference link. + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidimedeactivate + +#### Deprecated + +This command is deprecated and likely not supported by any browser. + +#### Inherited from + +`ProtocolCommands.deactivateIME` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/jsonwp.d.ts:516 + +*** + +### ~~deleteAllCookies()~~ + +```ts +deleteAllCookies(): Promise +``` + +Webdriver Protocol Command + +The Delete All Cookies command allows deletion of all cookies associated with the active document's address. + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://w3c.github.io/webdriver/#dfn-delete-all-cookies + +#### Inherited from + +`ProtocolCommands.deleteAllCookies` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:402 + +*** + +### ~~deleteCookie()~~ + +```ts +deleteCookie(name): Promise +``` + +Webdriver Protocol Command + +The Delete Cookie command allows you to delete either a single cookie by parameter name, or all the cookies associated with the active document's address if name is undefined. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `name` | `string` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://w3c.github.io/webdriver/#dfn-delete-cookie + +#### Inherited from + +`ProtocolCommands.deleteCookie` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:418 + +*** + +### ~~deleteDownloadableFiles()~~ + +```ts +deleteDownloadableFiles(): Promise +``` + +Selenium Protocol Command + +Remove all downloadable files from remote machine on which the browser is running. + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://www.seleniumhq.org/ + +#### Inherited from + +`ProtocolCommands.deleteDownloadableFiles` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/selenium.d.ts:34 + +*** + +### ~~deleteLocalStorageItem()~~ + +```ts +deleteLocalStorageItem(key): Promise +``` + +Jsonwp Protocol Command + +No description available, please see reference link. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `key` | `string` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#delete-sessionsessionidlocal_storagekeykey + +#### Deprecated + +This command is deprecated and likely not supported by any browser. Use the "execute" command instead to interact with the session storage interface! + +#### Inherited from + +`ProtocolCommands.deleteLocalStorageItem` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/jsonwp.d.ts:687 + +*** + +### ~~deleteMockSensor()~~ + +```ts +deleteMockSensor(type): Promise +``` + +Webdriver Protocol Command + +The Delete Session command closes any top-level browsing contexts associated with the current session, terminates the connection, and finally closes the current session. __Note:__ this feature has not landed in all browsers yet. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `type` | `string` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://w3c.github.io/sensors/#delete-mock-sensor-command + +#### Inherited from + +`ProtocolCommands.deleteMockSensor` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:561 + +*** + +### ~~deleteNetworkConditions()~~ + +```ts +deleteNetworkConditions(): Promise +``` + +Chromium Protocol Command + +Disable any network throttling which might have been set. Equivalent of setting the `No throttling` preset. + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://github.com/bayandin/chromedriver/blob/v2.45/window_commands.cc#L1724-L1745 + +#### Inherited from + +`ProtocolCommands.deleteNetworkConditions` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/chromium.d.ts:155 + +*** + +### ~~deleteSession()~~ + +```ts +deleteSession(deleteSessionOpts?): Promise +``` + +Webdriver Protocol Command + +The Delete Session command closes any top-level browsing contexts associated with the current session, terminates the connection, and finally closes the current session. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `deleteSessionOpts`? | `DeleteSessionOpts` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://w3c.github.io/webdriver/#dfn-delete-session + +#### Inherited from + +`ProtocolCommands.deleteSession` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:18 + +*** + +### ~~deleteSessionStorageItem()~~ + +```ts +deleteSessionStorageItem(key): Promise +``` + +Jsonwp Protocol Command + +Remove the storage item for the given key. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `key` | `string` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#delete-sessionsessionidsession_storagekeykey + +#### Deprecated + +This command is deprecated and likely not supported by any browser. Use the "execute" command instead to interact with the session storage interface! + +#### Inherited from + +`ProtocolCommands.deleteSessionStorageItem` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/jsonwp.d.ts:741 + +*** + +### ~~dismissAlert()~~ + +```ts +dismissAlert(): Promise +``` + +Webdriver Protocol Command + +The Dismiss Alert command dismisses a simple dialog if present, otherwise error. A request to dismiss an alert user prompt, which may not necessarily have a dismiss button, has the same effect as accepting it. + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://w3c.github.io/webdriver/#dfn-dismiss-alert + +#### Inherited from + +`ProtocolCommands.dismissAlert` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:442 + +*** + +### ~~download()~~ + +```ts +download(name): Promise +``` + +Selenium Protocol Command + +Download a file from remote machine on which the browser is running. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `name` | `string` | + +#### Returns + +`Promise`\<`ProtocolCommandResponse`\> + +#### Ref + +https://www.seleniumhq.org/ + +#### Inherited from + +`ProtocolCommands.download` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/selenium.d.ts:26 + +*** + +### ~~elementClear()~~ + +```ts +elementClear(elementId): Promise +``` + +Webdriver Protocol Command + +The Element Clear command scrolls into view an editable or resettable element and then attempts to clear its selected files or text content. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `elementId` | `string` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://w3c.github.io/webdriver/#dfn-element-clear + +#### Inherited from + +`ProtocolCommands.elementClear` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:346 + +*** + +### ~~elementClick()~~ + +```ts +elementClick(elementId): Promise +``` + +Webdriver Protocol Command + +The Element Click command scrolls into view the element if it is not already pointer-interactable, and clicks its in-view center point. If the element's center point is obscured by another element, an element click intercepted error is returned. If the element is outside the viewport, an element not interactable error is returned. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `elementId` | `string` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://w3c.github.io/webdriver/#dfn-element-click + +#### Inherited from + +`ProtocolCommands.elementClick` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:338 + +*** + +### ~~elementEquals()~~ + +```ts +elementEquals(elementId, otherElementId): Promise +``` + +Jsonwp Protocol Command + +Compare elements with each other. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `elementId` | `string` | +| `otherElementId` | `string` | + +#### Returns + +`Promise`\<`boolean`\> + +#### Ref + +https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidelementidequalsother + +#### Deprecated + +This command is deprecated and likely not supported by any browser. + +#### Inherited from + +`ProtocolCommands.elementEquals` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/jsonwp.d.ts:350 + +*** + +### ~~elementHover()~~ + +```ts +elementHover(elementId): Promise +``` + +Chromium Protocol Command + +Enable hover state for an element, which is reset upon next interaction. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `elementId` | `string` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://github.com/bayandin/chromedriver/blob/v2.45/element_commands.cc#L126-L146 + +#### Inherited from + +`ProtocolCommands.elementHover` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/chromium.d.ts:220 + +*** + +### ~~elementSendKeys()~~ + +```ts +elementSendKeys(elementId, text): Promise +``` + +Webdriver Protocol Command + +The Element Send Keys command scrolls into view the form control element and then sends the provided keys to the element. In case the element is not keyboard-interactable, an element not interactable error is returned.

The key input state used for input may be cleared mid-way through "typing" by sending the null key, which is U+E000 (NULL). + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `elementId` | `string` | +| `text` | `string` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://w3c.github.io/webdriver/#dfn-element-send-keys + +#### Inherited from + +`ProtocolCommands.elementSendKeys` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:354 + +*** + +### ~~elementSubmit()~~ + +```ts +elementSubmit(elementId): Promise +``` + +Jsonwp Protocol Command + +No description available, please see reference link. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `elementId` | `string` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidelementidsubmit + +#### Deprecated + +This command is deprecated and likely not supported by any browser. + +#### Inherited from + +`ProtocolCommands.elementSubmit` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/jsonwp.d.ts:359 + +*** + +### ~~emit()~~ + +```ts +emit(eventName, ...args): boolean +``` + +Synchronously calls each of the listeners registered for the event named`eventName`, in the order they were registered, passing the supplied arguments +to each. + +Returns `true` if the event had listeners, `false` otherwise. + +```js +const EventEmitter = require('events'); +const myEmitter = new EventEmitter(); + +// First listener +myEmitter.on('event', function firstListener() { + console.log('Helloooo! first listener'); +}); +// Second listener +myEmitter.on('event', function secondListener(arg1, arg2) { + console.log(`event with parameters ${arg1}, ${arg2} in second listener`); +}); +// Third listener +myEmitter.on('event', function thirdListener(...args) { + const parameters = args.join(', '); + console.log(`event with parameters ${parameters} in third listener`); +}); + +console.log(myEmitter.listeners('event')); + +myEmitter.emit('event', 1, 2, 3, 4, 5); + +// Prints: +// [ +// [Function: firstListener], +// [Function: secondListener], +// [Function: thirdListener] +// ] +// Helloooo! first listener +// event with parameters 1, 2 in second listener +// event with parameters 1, 2, 3, 4, 5 in third listener +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `eventName` | `string` \| `symbol` | +| ...`args` | `any`[] | + +#### Returns + +`boolean` + +#### Since + +v0.1.26 + +#### Inherited from + +`Omit.emit` + +#### Defined in + +testplane/node\_modules/@types/node/events.d.ts:731 + +*** + +### ~~endCoverage()~~ + +```ts +endCoverage(intent, path): Promise +``` + +Appium Protocol Command + +Get test coverage data. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `intent` | `string` | +| `path` | `string` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://appium.github.io/appium.io/docs/en/commands/device/app/end-test-coverage/ + +#### Inherited from + +`ProtocolCommands.endCoverage` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/appium.d.ts:357 + +*** + +### ~~eventNames()~~ + +```ts +eventNames(): (string | symbol)[] +``` + +Returns an array listing the events for which the emitter has registered +listeners. The values in the array are strings or `Symbol`s. + +```js +const EventEmitter = require('events'); +const myEE = new EventEmitter(); +myEE.on('foo', () => {}); +myEE.on('bar', () => {}); + +const sym = Symbol('symbol'); +myEE.on(sym, () => {}); + +console.log(myEE.eventNames()); +// Prints: [ 'foo', 'bar', Symbol(symbol) ] +``` + +#### Returns + +(`string` \| `symbol`)[] + +#### Since + +v6.0.0 + +#### Inherited from + +`Omit.eventNames` + +#### Defined in + +testplane/node\_modules/@types/node/events.d.ts:794 + +*** + +### ~~executeAsyncScript()~~ + +```ts +executeAsyncScript(script, args): Promise +``` + +Webdriver Protocol Command + +The Execute Async Script command causes JavaScript to execute as an anonymous function. Unlike the Execute Script command, the result of the function is ignored. Instead an additional argument is provided as the final argument to the function. This is a function that, when called, returns its first argument as the response. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `script` | `string` | +| `args` | ( \| `undefined` \| `null` \| `string` \| `number` \| `boolean` \| `object`)[] | + +#### Returns + +`Promise`\<`any`\> + +#### Ref + +https://w3c.github.io/webdriver/#dfn-execute-async-script + +#### Inherited from + +`ProtocolCommands.executeAsyncScript` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:378 + +*** + +### ~~executeDriverScript()~~ + +```ts +executeDriverScript( + script, + type?, +timeout?): Promise +``` + +Appium Protocol Command + +This command enables you to specify a WebdriverIO script as a string and transmit it to the Appium server for local execution on the server itself. This approach helps minimize potential latency associated with each command. ***To utilize this command with Appium 2.0, you must have the [`execute-driver-plugin`](https://github.com/appium/appium/tree/master/packages/execute-driver-plugin) plugin installed.*** + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `script` | `string` | +| `type`? | `string` | +| `timeout`? | `number` | + +#### Returns + +`Promise`\<`ProtocolCommandResponse`\> + +#### Ref + +https://github.com/appium/appium/blob/master/docs/en/commands/session/execute-driver.md + +#### Inherited from + +`ProtocolCommands.executeDriverScript` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/appium.d.ts:539 + +*** + +### ~~executeScript()~~ + +```ts +executeScript(script, args): Promise +``` + +Webdriver Protocol Command + +The Execute Script command executes a JavaScript function in the context of the current browsing context and returns the return value of the function. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `script` | `string` | +| `args` | ( \| `undefined` \| `null` \| `string` \| `number` \| `boolean` \| `object`)[] | + +#### Returns + +`Promise`\<`any`\> + +#### Ref + +https://w3c.github.io/webdriver/#dfn-execute-script + +#### Inherited from + +`ProtocolCommands.executeScript` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:370 + +*** + +### ~~file()~~ + +```ts +file(file): Promise +``` + +Chromium Protocol Command + +Upload a file to remote machine on which the browser is running. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `file` | `string` | + +#### Returns + +`Promise`\<`string`\> + +#### Ref + +https://github.com/bayandin/chromedriver/blob/v2.45/session_commands.cc#L1037-L1065 + +#### Inherited from + +`ProtocolCommands.file` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/chromium.d.ts:179 + +*** + +### ~~findElement()~~ + +```ts +findElement(using, value): Promise +``` + +Webdriver Protocol Command + +The Find Element command is used to find an element in the current browsing context that can be used for future commands. This command returns JSON representation of the element that can be passed to $ command to transform the reference to an extended WebdriverIO element. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `using` | `string` | +| `value` | `string` | + +#### Returns + +`Promise`\<`ElementReference`\> + +#### Ref + +https://w3c.github.io/webdriver/#dfn-find-element + +#### Inherited from + +`ProtocolCommands.findElement` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:202 + +*** + +### ~~findElementFromElement()~~ + +```ts +findElementFromElement( + elementId, + using, +value): Promise +``` + +Webdriver Protocol Command + +The Find Element From Element command is used to find an element from a web element in the current browsing context that can be used for future commands. This command returns JSON representation of the element that can be passed to $ command to transform the reference to an extended WebdriverIO element (See findElement). + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `elementId` | `string` | +| `using` | `string` | +| `value` | `string` | + +#### Returns + +`Promise`\<`ElementReference`\> + +#### Ref + +https://w3c.github.io/webdriver/#dfn-find-element-from-element + +#### Inherited from + +`ProtocolCommands.findElementFromElement` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:234 + +*** + +### ~~findElementFromShadowRoot()~~ + +```ts +findElementFromShadowRoot( + shadowId, + using, +value): Promise +``` + +Webdriver Protocol Command + +The Find Element From Shadow Root command is used to find an element within the shadow root of an element that can be used for future commands. This command returns JSON representation of the element that can be passed to $ command to transform the reference to an extended WebdriverIO element. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `shadowId` | `string` | +| `using` | `string` | +| `value` | `string` | + +#### Returns + +`Promise`\<`ElementReference`\> + +#### Ref + +https://w3c.github.io/webdriver/#find-element-from-shadow-root + +#### Inherited from + +`ProtocolCommands.findElementFromShadowRoot` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:210 + +*** + +### ~~findElements()~~ + +```ts +findElements(using, value): Promise +``` + +Webdriver Protocol Command + +The Find Elements command is used to find elements in the current browsing context that can be used for future commands. This command returns array of JSON representation of the elements that can be passed to $ command to transform the reference to an extended WebdriverIO element (See findElement). + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `using` | `string` | +| `value` | `string` | + +#### Returns + +`Promise`\<`ElementReference`[]\> + +#### Ref + +https://w3c.github.io/webdriver/#dfn-find-elements + +#### Inherited from + +`ProtocolCommands.findElements` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:218 + +*** + +### ~~findElementsFromElement()~~ + +```ts +findElementsFromElement( + elementId, + using, +value): Promise +``` + +Webdriver Protocol Command + +The Find Elements From Element command is used to find elements from a web element in the current browsing context that can be used for future commands. This command returns array of JSON representation of the elements that can be passed to $ command to transform the reference to an extended WebdriverIO element (See findElement). + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `elementId` | `string` | +| `using` | `string` | +| `value` | `string` | + +#### Returns + +`Promise`\<`ElementReference`[]\> + +#### Ref + +https://w3c.github.io/webdriver/#dfn-find-elements-from-element + +#### Inherited from + +`ProtocolCommands.findElementsFromElement` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:242 + +*** + +### ~~findElementsFromShadowRoot()~~ + +```ts +findElementsFromShadowRoot( + shadowId, + using, +value): Promise +``` + +Webdriver Protocol Command + +The Find Elements command is used to find elements within the shadow root of an element that can be used for future commands. This command returns array of JSON representation of the elements that can be passed to $ command to transform the reference to an extended WebdriverIO element (See findElement). + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `shadowId` | `string` | +| `using` | `string` | +| `value` | `string` | + +#### Returns + +`Promise`\<`ElementReference`[]\> + +#### Ref + +https://w3c.github.io/webdriver/#find-elements-from-shadow-root + +#### Inherited from + +`ProtocolCommands.findElementsFromShadowRoot` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:226 + +*** + +### ~~fingerPrint()~~ + +```ts +fingerPrint(fingerprintId): Promise +``` + +Appium Protocol Command + +Authenticate users by using their finger print scans on supported emulators. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `fingerprintId` | `number` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://appium.github.io/appium.io/docs/en/commands/device/authentication/finger-print/ + +#### Inherited from + +`ProtocolCommands.fingerPrint` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/appium.d.ts:461 + +*** + +### ~~forward()~~ + +```ts +forward(): Promise +``` + +Webdriver Protocol Command + +The Forward command causes the browser to traverse one step forwards in the joint session history of the current top-level browsing context. + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://w3c.github.io/webdriver/#dfn-forward + +#### Inherited from + +`ProtocolCommands.forward` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:74 + +*** + +### ~~freeze()~~ + +```ts +freeze(): Promise +``` + +Chromium Protocol Command + +Freeze the current page. Extension for [Page Lifecycle API](https://developers.google.com/web/updates/2018/07/page-lifecycle-api). + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://github.com/bayandin/chromedriver/blob/v2.45/window_commands.cc#L625-L633 + +#### Inherited from + +`ProtocolCommands.freeze` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/chromium.d.ts:236 + +*** + +### ~~fullPageScreenshot()~~ + +```ts +fullPageScreenshot(): Promise +``` + +Gecko Protocol Command + +Captures a screenshot of the entire page. + +#### Returns + +`Promise`\<`string`\> + +#### Ref + +https://phabricator.services.mozilla.com/source/mozilla-central/browse/default/testing/geckodriver/src/command.rs$43-46 + +#### Inherited from + +`ProtocolCommands.fullPageScreenshot` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/gecko.d.ts:9 + +*** + +### ~~fullscreenWindow()~~ + +```ts +fullscreenWindow(): Promise +``` + +Webdriver Protocol Command + +The Fullscreen Window command invokes the window manager-specific “full screen” operation, if any, on the window containing the current top-level browsing context. This typically increases the window to the size of the physical display and can hide browser chrome elements such as toolbars. + +#### Returns + +`Promise`\<`RectReturn`\> + +#### Ref + +https://w3c.github.io/webdriver/#dfn-fullscreen-window + +#### Inherited from + +`ProtocolCommands.fullscreenWindow` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:194 + +*** + +### ~~generateTestReport()~~ + +```ts +generateTestReport(message, group): Promise +``` + +Webdriver Protocol Command + +Generates a report for testing. Extension for [Reporting API](https://developers.google.com/web/updates/2018/09/reportingapi). __Note:__ this feature has not landed in all browsers yet. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | +| `group` | `string` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://w3c.github.io/reporting/#automation + +#### Inherited from + +`ProtocolCommands.generateTestReport` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:529 + +*** + +### ~~getActiveElement()~~ + +```ts +getActiveElement(): Promise +``` + +Webdriver Protocol Command + +Get Active Element returns the active element of the current browsing context’s document element. This command returns JSON representation of the element that can be passed to $ command to transform the reference to an extended WebdriverIO element (See findElement). + +#### Returns + +`Promise`\<`string`\> + +#### Ref + +https://w3c.github.io/webdriver/#dfn-get-active-element + +#### Inherited from + +`ProtocolCommands.getActiveElement` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:258 + +*** + +### ~~getActiveEngine()~~ + +```ts +getActiveEngine(): Promise +``` + +Jsonwp Protocol Command + +No description available, please see reference link. + +#### Returns + +`Promise`\<`string`\> + +#### Ref + +https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidimeactive_engine + +#### Deprecated + +This command is deprecated and likely not supported by any browser. + +#### Inherited from + +`ProtocolCommands.getActiveEngine` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/jsonwp.d.ts:498 + +*** + +### ~~getAlertText()~~ + +```ts +getAlertText(): Promise +``` + +Webdriver Protocol Command + +The Get Alert Text command returns the message of the current user prompt. If there is no current user prompt, it returns an error. + +#### Returns + +`Promise`\<`string`\> + +#### Ref + +https://w3c.github.io/webdriver/#dfn-get-alert-text + +#### Inherited from + +`ProtocolCommands.getAlertText` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:458 + +*** + +### ~~getAllCookies()~~ + +```ts +getAllCookies(): Promise +``` + +Webdriver Protocol Command + +The Get All Cookies command returns all cookies associated with the address of the current browsing context’s active document. + +#### Returns + +`Promise`\<`Cookie`[]\> + +#### Ref + +https://w3c.github.io/webdriver/#dfn-get-all-cookies + +#### Inherited from + +`ProtocolCommands.getAllCookies` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:386 + +*** + +### ~~getApplicationCacheStatus()~~ + +```ts +getApplicationCacheStatus(): Promise +``` + +Jsonwp Protocol Command + +Get the status of the html5 application cache. + +#### Returns + +`Promise`\<`number`\> + +#### Ref + +https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidapplication_cachestatus + +#### Deprecated + +This command is deprecated and likely not supported by any browser. + +#### Inherited from + +`ProtocolCommands.getApplicationCacheStatus` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/jsonwp.d.ts:777 + +*** + +### ~~getAvailableEngines()~~ + +```ts +getAvailableEngines(): Promise +``` + +Jsonwp Protocol Command + +No description available, please see reference link. + +#### Returns + +`Promise`\<`string`[]\> + +#### Ref + +https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidimeavailable_engines + +#### Deprecated + +This command is deprecated and likely not supported by any browser. + +#### Inherited from + +`ProtocolCommands.getAvailableEngines` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/jsonwp.d.ts:489 + +*** + +### ~~getCastIssueMessage()~~ + +```ts +getCastIssueMessage(): Promise +``` + +Chromium Protocol Command + +Returns error message if there is any issue in a Cast session. + +#### Returns + +`Promise`\<`string`\> + +#### Ref + +https://chromium.googlesource.com/chromium/src/+/refs/tags/73.0.3683.121/chrome/test/chromedriver/server/http_handler.cc#751 + +#### Inherited from + +`ProtocolCommands.getCastIssueMessage` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/chromium.d.ts:276 + +*** + +### ~~getCastSinks()~~ + +```ts +getCastSinks(): Promise +``` + +Chromium Protocol Command + +Returns the list of cast sinks (Cast devices) available to the Chrome media router. + +#### Returns + +`Promise`\<`string`[]\> + +#### Ref + +https://chromium.googlesource.com/chromium/src/+/refs/tags/73.0.3683.121/chrome/test/chromedriver/server/http_handler.cc#748 + +#### Inherited from + +`ProtocolCommands.getCastSinks` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/chromium.d.ts:252 + +*** + +### ~~getClipboard()~~ + +```ts +getClipboard(contentType?): Promise +``` + +Appium Protocol Command + +Get the content of the system clipboard + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `contentType`? | `string` | + +#### Returns + +`Promise`\<`string`\> + +#### Ref + +https://appium.github.io/appium.io/docs/en/commands/device/clipboard/get-clipboard/ + +#### Inherited from + +`ProtocolCommands.getClipboard` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/appium.d.ts:477 + +*** + +### ~~getContext()~~ + +```ts +getContext(): Promise +``` + +Appium Protocol Command + +No description available, please see reference link. + +#### Returns + +`Promise`\<`Context`\> + +#### Ref + +https://github.com/SeleniumHQ/mobile-spec/blob/master/spec-draft.md#webviews-and-other-contexts + +#### Inherited from + +`ProtocolCommands.getContext` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/appium.d.ts:10 + +*** + +### ~~getContexts()~~ + +```ts +getContexts(): Promise +``` + +Appium Protocol Command + +No description available, please see reference link. + +#### Returns + +`Promise`\<`Context`[]\> + +#### Ref + +https://github.com/SeleniumHQ/mobile-spec/blob/master/spec-draft.md#webviews-and-other-contexts + +#### Inherited from + +`ProtocolCommands.getContexts` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/appium.d.ts:26 + +*** + +### ~~getCredentials()~~ + +```ts +getCredentials(authenticatorId): Promise +``` + +Webdriver Protocol Command + +Returns one Credential Parameters object for every Public Key Credential Source stored in a Virtual Authenticator, regardless of whether they were stored using Add Credential or `navigator.credentials.create()`. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `authenticatorId` | `string` | + +#### Returns + +`Promise`\<`Credential`[]\> + +#### Ref + +https://www.w3.org/TR/webauthn-2/#sctn-automation-get-credentials + +#### Inherited from + +`ProtocolCommands.getCredentials` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:601 + +*** + +### ~~getCurrentActivity()~~ + +```ts +getCurrentActivity(): Promise +``` + +Appium Protocol Command + +Get the name of the current Android activity. + +#### Returns + +`Promise`\<`string`\> + +#### Ref + +https://appium.github.io/appium.io/docs/en/commands/device/activity/current-activity/ + +#### Inherited from + +`ProtocolCommands.getCurrentActivity` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/appium.d.ts:130 + +*** + +### ~~getCurrentPackage()~~ + +```ts +getCurrentPackage(): Promise +``` + +Appium Protocol Command + +Get the name of the current Android package. + +#### Returns + +`Promise`\<`string`\> + +#### Ref + +https://appium.github.io/appium.io/docs/en/commands/device/activity/current-package/ + +#### Inherited from + +`ProtocolCommands.getCurrentPackage` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/appium.d.ts:138 + +*** + +### ~~getDeviceTime()~~ + +```ts +getDeviceTime(): Promise +``` + +Appium Protocol Command + +Get the time on the device. + +#### Returns + +`Promise`\<`string`\> + +#### Ref + +https://appium.github.io/appium.io/docs/en/commands/device/system/system-time/ + +#### Inherited from + +`ProtocolCommands.getDeviceTime` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/appium.d.ts:298 + +*** + +### ~~getDisplayDensity()~~ + +```ts +getDisplayDensity(): Promise +``` + +Appium Protocol Command + +Get display density from device. + +#### Returns + +`Promise`\<`any`\> + +#### Ref + +https://github.com/appium/appium-base-driver/blob/master/docs/mjsonwp/protocol-methods.md#appium-extension-endpoints + +#### Inherited from + +`ProtocolCommands.getDisplayDensity` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/appium.d.ts:306 + +*** + +### ~~getDownloadableFiles()~~ + +```ts +getDownloadableFiles(): Promise +``` + +Selenium Protocol Command + +List files from remote machine available for download. + +#### Returns + +`Promise`\<`ProtocolCommandResponse`\> + +#### Ref + +https://www.seleniumhq.org/ + +#### Inherited from + +`ProtocolCommands.getDownloadableFiles` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/selenium.d.ts:18 + +*** + +### ~~getElementAttribute()~~ + +```ts +getElementAttribute(elementId, name): Promise +``` + +Webdriver Protocol Command + +The Get Element Attribute command will return the attribute of a web element. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `elementId` | `string` | +| `name` | `string` | + +#### Returns + +`Promise`\<`string`\> + +#### Ref + +https://w3c.github.io/webdriver/#dfn-get-element-attribute + +#### Inherited from + +`ProtocolCommands.getElementAttribute` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:282 + +*** + +### ~~getElementCSSValue()~~ + +```ts +getElementCSSValue(elementId, propertyName): Promise +``` + +Webdriver Protocol Command + +The Get Element CSS Value command retrieves the computed value of the given CSS property of the given web element. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `elementId` | `string` | +| `propertyName` | `string` | + +#### Returns + +`Promise`\<`string`\> + +#### Ref + +https://w3c.github.io/webdriver/#dfn-get-element-css-value + +#### Inherited from + +`ProtocolCommands.getElementCSSValue` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:298 + +*** + +### ~~getElementComputedLabel()~~ + +```ts +getElementComputedLabel(elementId): Promise +``` + +Webdriver Protocol Command + +Get the accessible name of the element. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `elementId` | `string` | + +#### Returns + +`Promise`\<`string`\> + +#### Ref + +https://w3c.github.io/webdriver/#get-computed-label + +#### Inherited from + +`ProtocolCommands.getElementComputedLabel` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:498 + +*** + +### ~~getElementComputedRole()~~ + +```ts +getElementComputedRole(elementId): Promise +``` + +Webdriver Protocol Command + +Get the computed WAI-ARIA role of an element. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `elementId` | `string` | + +#### Returns + +`Promise`\<`string`\> + +#### Ref + +https://w3c.github.io/webdriver/#get-computed-role + +#### Inherited from + +`ProtocolCommands.getElementComputedRole` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:490 + +*** + +### ~~getElementLocation()~~ + +```ts +getElementLocation(elementId): Promise +``` + +Jsonwp Protocol Command + +Determine an element's location on the page. The point `(0, 0)` refers to the upper-left corner of the page. The element's coordinates are returned as a JSON object with `x` and `y` properties. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `elementId` | `string` | + +#### Returns + +`Promise`\<`ProtocolCommandResponse`\> + +#### Ref + +https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidelementidlocation + +#### Deprecated + +This command is deprecated and likely not supported by any browser. + +#### Inherited from + +`ProtocolCommands.getElementLocation` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/jsonwp.d.ts:307 + +*** + +### ~~getElementLocationInView()~~ + +```ts +getElementLocationInView(elementId): Promise +``` + +Jsonwp Protocol Command + +Determine an element's location on the screen once it has been scrolled into view.

__Note:__ This is considered an internal command and should only be used to determine an element's location for correctly generating native events. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `elementId` | `string` | + +#### Returns + +`Promise`\<`ProtocolCommandResponse`\> + +#### Ref + +https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidelementidlocation_in_view + +#### Deprecated + +This command is deprecated and likely not supported by any browser. + +#### Inherited from + +`ProtocolCommands.getElementLocationInView` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/jsonwp.d.ts:316 + +*** + +### ~~getElementProperty()~~ + +```ts +getElementProperty(elementId, name): Promise +``` + +Webdriver Protocol Command + +The Get Element Property command will return the result of getting a property of an element. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `elementId` | `string` | +| `name` | `string` | + +#### Returns + +`Promise`\<`string`\> + +#### Ref + +https://w3c.github.io/webdriver/#dfn-get-element-property + +#### Inherited from + +`ProtocolCommands.getElementProperty` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:290 + +*** + +### ~~getElementRect()~~ + +```ts +getElementRect(elementId): Promise +``` + +Webdriver Protocol Command + +The Get Element Rect command returns the dimensions and coordinates of the given web element. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `elementId` | `string` | + +#### Returns + +`Promise`\<`RectReturn`\> + +#### Ref + +https://w3c.github.io/webdriver/#dfn-get-element-rect + +#### Inherited from + +`ProtocolCommands.getElementRect` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:322 + +*** + +### ~~getElementShadowRoot()~~ + +```ts +getElementShadowRoot(elementId): Promise +``` + +Webdriver Protocol Command + +Get the shadow root object of an element. The result object can be used to fetch elements within this shadow root using e.g. findElementFromShadowRoots or findElementsFromShadowRoots. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `elementId` | `string` | + +#### Returns + +`Promise`\<`ShadowElementReference`\> + +#### Ref + +https://w3c.github.io/webdriver/#dfn-get-active-element + +#### Inherited from + +`ProtocolCommands.getElementShadowRoot` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:250 + +*** + +### ~~getElementSize()~~ + +```ts +getElementSize(elementId): Promise +``` + +Jsonwp Protocol Command + +Determine an element's size in pixels. The size will be returned as a JSON object with `width` and `height` properties. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `elementId` | `string` | + +#### Returns + +`Promise`\<`ProtocolCommandResponse`\> + +#### Ref + +https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidelementidsize + +#### Deprecated + +This command is deprecated and likely not supported by any browser. Use the "getElementRect" command instead of "getElementSize"! + +#### Inherited from + +`ProtocolCommands.getElementSize` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/jsonwp.d.ts:325 + +*** + +### ~~getElementTagName()~~ + +```ts +getElementTagName(elementId): Promise +``` + +Webdriver Protocol Command + +The Get Element Tag Name command returns the qualified element name of the given web element. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `elementId` | `string` | + +#### Returns + +`Promise`\<`string`\> + +#### Ref + +https://w3c.github.io/webdriver/#dfn-get-element-tag-name + +#### Inherited from + +`ProtocolCommands.getElementTagName` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:314 + +*** + +### ~~getElementText()~~ + +```ts +getElementText(elementId): Promise +``` + +Webdriver Protocol Command + +The Get Element Text command intends to return an element’s text "as rendered". An element's rendered text is also used for locating a elements by their link text and partial link text. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `elementId` | `string` | + +#### Returns + +`Promise`\<`string`\> + +#### Ref + +https://w3c.github.io/webdriver/#dfn-get-element-text + +#### Inherited from + +`ProtocolCommands.getElementText` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:306 + +*** + +### ~~getElementValue()~~ + +```ts +getElementValue(elementId): Promise +``` + +Chromium Protocol Command + +Retrieves the value of a given form control element. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `elementId` | `string` | + +#### Returns + +`Promise`\<`null` \| `string`\> + +#### Ref + +https://github.com/bayandin/chromedriver/blob/v2.45/element_commands.cc#L431-L443 + +#### Inherited from + +`ProtocolCommands.getElementValue` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/chromium.d.ts:212 + +*** + +### ~~getEvents()~~ + +```ts +getEvents(type): Promise +``` + +Appium Protocol Command + +Get events stored in appium server. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `type` | `string`[] | + +#### Returns + +`Promise`\<`ProtocolCommandResponse`\> + +#### Ref + +https://github.com/appium/appium/blob/master/docs/en/commands/session/events/get-events.md + +#### Inherited from + +`ProtocolCommands.getEvents` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/appium.d.ts:547 + +*** + +### ~~getGeoLocation()~~ + +```ts +getGeoLocation(): Promise +``` + +Jsonwp Protocol Command + +Get the current geo location. + +#### Returns + +`Promise`\<`ProtocolCommandResponse`\> + +#### Ref + +https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#get-sessionsessionidlocation + +#### Deprecated + +This command is deprecated and likely not supported by any browser. + +#### Inherited from + +`ProtocolCommands.getGeoLocation` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/jsonwp.d.ts:633 + +*** + +### ~~getHubConfig()~~ + +```ts +getHubConfig(): Promise +``` + +Selenium Protocol Command + +Receive hub config remotely. + +#### Returns + +`Promise`\<`ProtocolCommandResponse`\> + +#### Ref + +https://github.com/nicegraham/selenium-grid2-api#gridapihub + +#### Inherited from + +`ProtocolCommands.getHubConfig` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/selenium.d.ts:42 + +*** + +### ~~getLocalStorage()~~ + +```ts +getLocalStorage(): Promise +``` + +Jsonwp Protocol Command + +Get all keys of the storage. + +#### Returns + +`Promise`\<`string`[]\> + +#### Ref + +https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#get-sessionsessionidlocal_storage + +#### Deprecated + +This command is deprecated and likely not supported by any browser. Use the "execute" command instead to interact with the session storage interface! + +#### Inherited from + +`ProtocolCommands.getLocalStorage` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/jsonwp.d.ts:651 + +*** + +### ~~getLocalStorageItem()~~ + +```ts +getLocalStorageItem(key): Promise +``` + +Jsonwp Protocol Command + +Get the storage item for the given key. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `key` | `string` | + +#### Returns + +`Promise`\<`string`\> + +#### Ref + +https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#get-sessionsessionidlocal_storagekeykey + +#### Deprecated + +This command is deprecated and likely not supported by any browser. Use the "execute" command instead to interact with the session storage interface! + +#### Inherited from + +`ProtocolCommands.getLocalStorageItem` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/jsonwp.d.ts:678 + +*** + +### ~~getLocalStorageSize()~~ + +```ts +getLocalStorageSize(): Promise +``` + +Jsonwp Protocol Command + +Get the number of items in the storage. + +#### Returns + +`Promise`\<`number`\> + +#### Ref + +https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidlocal_storagesize + +#### Deprecated + +This command is deprecated and likely not supported by any browser. Use the "execute" command instead to interact with the session storage interface! + +#### Inherited from + +`ProtocolCommands.getLocalStorageSize` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/jsonwp.d.ts:696 + +*** + +### ~~getLogTypes()~~ + +```ts +getLogTypes(): Promise +``` + +Jsonwp Protocol Command + +Get available log types. + +#### Returns + +`Promise`\<`string`[]\> + +#### Ref + +https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidlogtypes + +#### Deprecated + +This command is deprecated and likely not supported by any browser. Use the "devtools" instead to get logs! + +#### Inherited from + +`ProtocolCommands.getLogTypes` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/jsonwp.d.ts:768 + +*** + +### ~~getLogs()~~ + +```ts +getLogs(type): Promise +``` + +Jsonwp Protocol Command + +Get the log for a given log type. Log buffer is reset after each request. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `type` | `string` | + +#### Returns + +`Promise`\<`object`[]\> + +#### Ref + +https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidlog + +#### Deprecated + +This command is deprecated and likely not supported by any browser. Use the "devtools" instead to get logs! + +#### Inherited from + +`ProtocolCommands.getLogs` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/jsonwp.d.ts:759 + +*** + +### ~~getMaxListeners()~~ + +```ts +getMaxListeners(): number +``` + +Returns the current max listener value for the `EventEmitter` which is either +set by `emitter.setMaxListeners(n)` or defaults to defaultMaxListeners. + +#### Returns + +`number` + +#### Since + +v1.0.0 + +#### Inherited from + +`Omit.getMaxListeners` + +#### Defined in + +testplane/node\_modules/@types/node/events.d.ts:647 + +*** + +### ~~getMockCalls()~~ + +```ts +getMockCalls(mockId): Promise +``` + +Saucelabs Protocol Command + +Receive request information about requests that match the mocked resource. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `mockId` | `string` | + +#### Returns + +`Promise`\<`ProtocolCommandResponse`\> + +#### Ref + +https://wiki.saucelabs.com/display/DOCS/Custom+Sauce+Labs+WebDriver+Extensions+for+Network+and+Log+Commands + +#### Inherited from + +`ProtocolCommands.getMockCalls` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/saucelabs.d.ts:177 + +*** + +### ~~getMockSensor()~~ + +```ts +getMockSensor(type): Promise +``` + +Webdriver Protocol Command + +Retrieves information about a given type of mock sensor. __Note:__ this feature has not landed in all browsers yet. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `type` | `string` | + +#### Returns + +`Promise`\<`ProtocolCommandResponse`\> + +#### Ref + +https://w3c.github.io/sensors/#get-mock-sensor-command + +#### Inherited from + +`ProtocolCommands.getMockSensor` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:545 + +*** + +### ~~getMozContext()~~ + +```ts +getMozContext(): Promise +``` + +Gecko Protocol Command + +Get the context that is currently in effect, e.g. `CHROME` or `CONTENT`. + +#### Returns + +`Promise`\<`string`\> + +#### Ref + +https://github.com/SeleniumHQ/selenium/blob/586affe0cf675b1d5c8abc756defa4a46d95391b/javascript/node/selenium-webdriver/firefox.js#L615-L622 + +#### Example + +```js +console.log(await browser.getMozContext()); // outputs: 'CHROME' +``` + +#### Inherited from + +`ProtocolCommands.getMozContext` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/gecko.d.ts:21 + +*** + +### ~~getNamedCookie()~~ + +```ts +getNamedCookie(name): Promise +``` + +Webdriver Protocol Command + +The Get Named Cookie command returns the cookie with the requested name from the associated cookies in the cookie store of the current browsing context's active document. If no cookie is found, a no such cookie error is returned. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `name` | `string` | + +#### Returns + +`Promise`\<`Cookie`\> + +#### Ref + +https://w3c.github.io/webdriver/#dfn-get-named-cookie + +#### Inherited from + +`ProtocolCommands.getNamedCookie` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:410 + +*** + +### ~~getNetworkConditions()~~ + +```ts +getNetworkConditions(): Promise +``` + +Chromium Protocol Command + +Get current network conditions used for emulation. + +#### Returns + +`Promise`\<`ProtocolCommandResponse`\> + +#### Ref + +https://github.com/bayandin/chromedriver/blob/v2.45/session_commands.cc#L839-L859 + +#### Inherited from + +`ProtocolCommands.getNetworkConditions` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/chromium.d.ts:119 + +*** + +### ~~getNetworkConnection()~~ + +```ts +getNetworkConnection(): Promise +``` + +Chromium Protocol Command + +Get the connection type for network emulation. This command is only applicable when remote end replies with `networkConnectionEnabled` capability set to `true`. + +#### Returns + +`Promise`\<`number`\> + +#### Ref + +https://github.com/SeleniumHQ/mobile-spec/blob/master/spec-draft.md#device-modes + +#### Example + +```js +const browser = remote({ + capabilities: { + browserName: 'chrome', + 'goog:chromeOptions': { + // Network emulation requires device mode, which is only enabled when mobile emulation is on + mobileEmulation: { deviceName: 'iPad' }, + }, + } +}); +console.log(browser.getNetworkConnection()); // outputs: 6 (Both Wi-Fi and data) +``` + +#### Inherited from + +`ProtocolCommands.getNetworkConnection` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/chromium.d.ts:90 + +*** + +### ~~getOrientation()~~ + +```ts +getOrientation(): Promise +``` + +Jsonwp Protocol Command + +No description available, please see reference link. + +#### Returns + +`Promise`\<`string`\> + +#### Ref + +https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#get-sessionsessionidorientation + +#### Deprecated + +This command is deprecated and likely not supported by any browser. + +#### Inherited from + +`ProtocolCommands.getOrientation` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/jsonwp.d.ts:534 + +*** + +### ~~getPageIndex()~~ + +```ts +getPageIndex(): Promise +``` + +Mjsonwp Protocol Command + +No description available, please see reference link. + +#### Returns + +`Promise`\<`string`\> + +#### Ref + +https://github.com/appium/appium-base-driver/blob/master/docs/mjsonwp/protocol-methods.md#mobile-json-wire-protocol-endpoints + +#### Deprecated + +In Appium 2.0, this method is marked as deprecated and currently has no available alternatives. + +#### Inherited from + +`ProtocolCommands.getPageIndex` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/mjsonwp.d.ts:10 + +*** + +### ~~getPageLogs()~~ + +```ts +getPageLogs(type): Promise +``` + +Saucelabs Protocol Command + +Get webpage specific log information based on the last page load. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `type` | `string` | + +#### Returns + +`Promise`\<`ProtocolCommandResponse`\> + +#### Ref + +https://wiki.saucelabs.com/display/DOCS/Custom+Sauce+Labs+WebDriver+Extensions+for+Network+and+Log+Commands#CustomSauceLabsWebDriverExtensionsforNetworkandLogCommands-ExtendedDebuggingTools + +#### Examples + +```js +// Get Network Logs +console.log(browser.getPageLogs('sauce:network')); +// +// outputs: +// [{ +// "url": "https://app.saucelabs.com/dashboard", +// "statusCode": 200, +// "method": "GET", +// "requestHeaders": { +// ... +// }, +// "responseHeaders": { +// ... +// }, +// "timing": { +// ... +// } +// }, {, +// ... +// }] +// +```* + +```js +// Get Performance Logs (needs capturePerformance capability see: https://wiki.saucelabs.com/display/DOCS/Measure+Page+Load+Performance+Using+Test+Automation#MeasurePageLoadPerformanceUsingTestAutomation-EnableYourScript) +console.log(browser.getPageLogs('sauce:performance')); +// +// outputs: +// { +// "speedIndex": 1472.023, +// "timeToFirstInteractive": 1243.214, +// "firstMeaningfulPaint": 892.643, +// ... +// } +// +``` + +#### Inherited from + +`ProtocolCommands.getPageLogs` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/saucelabs.d.ts:48 + +*** + +### ~~getPageSource()~~ + +```ts +getPageSource(): Promise +``` + +Webdriver Protocol Command + +The Get Page Source command returns a string serialization of the DOM of the current browsing context active document. + +#### Returns + +`Promise`\<`string`\> + +#### Ref + +https://w3c.github.io/webdriver/#dfn-get-page-source + +#### Inherited from + +`ProtocolCommands.getPageSource` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:362 + +*** + +### ~~getPerformanceData()~~ + +```ts +getPerformanceData( + packageName, + dataType, +dataReadTimeout?): Promise +``` + +Appium Protocol Command + +Returns the information of the system state which is supported to read as like cpu, memory, network traffic, and battery. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `packageName` | `string` | +| `dataType` | `string` | +| `dataReadTimeout`? | `number` | + +#### Returns + +`Promise`\<`string`[]\> + +#### Ref + +https://appium.github.io/appium.io/docs/en/commands/device/performance-data/get-performance-data/ + +#### Inherited from + +`ProtocolCommands.getPerformanceData` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/appium.d.ts:90 + +*** + +### ~~getPerformanceDataTypes()~~ + +```ts +getPerformanceDataTypes(): Promise +``` + +Appium Protocol Command + +Returns the information types of the system state which is supported to read as like cpu, memory, network traffic, and battery. + +#### Returns + +`Promise`\<`string`[]\> + +#### Ref + +https://appium.github.io/appium.io/docs/en/commands/device/performance-data/performance-data-types/ + +#### Inherited from + +`ProtocolCommands.getPerformanceDataTypes` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/appium.d.ts:82 + +*** + +### ~~getSession()~~ + +```ts +getSession(): Promise +``` + +Jsonwp Protocol Command + +Retrieve the capabilities of the specified session. + +#### Returns + +`Promise`\<`ProtocolCommandResponse`\> + +#### Ref + +https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#get-sessionsessionid + +#### Deprecated + +This command is deprecated and likely not supported by any browser. + +#### Inherited from + +`ProtocolCommands.getSession` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/jsonwp.d.ts:36 + +*** + +### ~~getSessionStorage()~~ + +```ts +getSessionStorage(): Promise +``` + +Jsonwp Protocol Command + +Get all keys of the storage. + +#### Returns + +`Promise`\<`string`[]\> + +#### Ref + +https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#get-sessionsessionidsession_storage + +#### Deprecated + +This command is deprecated and likely not supported by any browser. Use the "execute" command instead to interact with the session storage interface! + +#### Inherited from + +`ProtocolCommands.getSessionStorage` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/jsonwp.d.ts:705 + +*** + +### ~~getSessionStorageItem()~~ + +```ts +getSessionStorageItem(key): Promise +``` + +Jsonwp Protocol Command + +Get the storage item for the given key. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `key` | `string` | + +#### Returns + +`Promise`\<`string`\> + +#### Ref + +https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#get-sessionsessionidsession_storagekeykey + +#### Deprecated + +This command is deprecated and likely not supported by any browser. Use the "execute" command instead to interact with the session storage interface! + +#### Inherited from + +`ProtocolCommands.getSessionStorageItem` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/jsonwp.d.ts:732 + +*** + +### ~~getSessionStorageSize()~~ + +```ts +getSessionStorageSize(): Promise +``` + +Jsonwp Protocol Command + +Get the number of items in the storage. + +#### Returns + +`Promise`\<`number`\> + +#### Ref + +https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidsession_storagesize + +#### Deprecated + +This command is deprecated and likely not supported by any browser. Use the "execute" command instead to interact with the session storage interface! + +#### Inherited from + +`ProtocolCommands.getSessionStorageSize` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/jsonwp.d.ts:750 + +*** + +### ~~getSessions()~~ + +```ts +getSessions(): Promise +``` + +Jsonwp Protocol Command + +Returns a list of the currently active sessions. Each session will be returned as a list of JSON objects containing `id` and `capabilities`. + +#### Returns + +`Promise`\<`object`[]\> + +#### Ref + +https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessions + +#### Deprecated + +This command is deprecated and likely not supported by any browser. + +#### Inherited from + +`ProtocolCommands.getSessions` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/jsonwp.d.ts:27 + +*** + +### ~~getSettings()~~ + +```ts +getSettings(): Promise +``` + +Appium Protocol Command + +Retrieve the current settings on the device. + +#### Returns + +`Promise`\<`SettingsReturn`\> + +#### Ref + +https://appium.github.io/appium.io/docs/en/commands/session/settings/get-settings/ + +#### Inherited from + +`ProtocolCommands.getSettings` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/appium.d.ts:389 + +*** + +### ~~getStrings()~~ + +```ts +getStrings(language?, stringFile?): Promise +``` + +Appium Protocol Command + +Get app strings. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `language`? | `string` | +| `stringFile`? | `string` | + +#### Returns + +`Promise`\<`StringsReturn`\> + +#### Ref + +https://appium.github.io/appium.io/docs/en/commands/device/app/get-app-strings/ + +#### Inherited from + +`ProtocolCommands.getStrings` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/appium.d.ts:365 + +*** + +### ~~getSystemBars()~~ + +```ts +getSystemBars(): Promise +``` + +Appium Protocol Command + +Retrieve visibility and bounds information of the status and navigation bars. + +#### Returns + +`Promise`\<`object`[]\> + +#### Ref + +https://appium.github.io/appium.io/docs/en/commands/device/system/system-bars/ + +#### Inherited from + +`ProtocolCommands.getSystemBars` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/appium.d.ts:290 + +*** + +### ~~getTimeouts()~~ + +```ts +getTimeouts(): Promise +``` + +Webdriver Protocol Command + +The Get Timeouts command gets timeout durations associated with the current session. + +#### Returns + +`Promise`\<`Timeouts`\> + +#### Ref + +https://w3c.github.io/webdriver/#dfn-get-timeouts + +#### Inherited from + +`ProtocolCommands.getTimeouts` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:34 + +*** + +### ~~getTitle()~~ + +```ts +getTitle(): Promise +``` + +Webdriver Protocol Command + +The Get Title command returns the document title of the current top-level browsing context, equivalent to calling `document.title`. + +#### Returns + +`Promise`\<`string`\> + +#### Ref + +https://w3c.github.io/webdriver/#dfn-get-title + +#### Inherited from + +`ProtocolCommands.getTitle` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:90 + +*** + +### ~~getUrl()~~ + +```ts +getUrl(): Promise +``` + +Webdriver Protocol Command + +The Get Current URL command returns the URL of the current top-level browsing context. + +#### Returns + +`Promise`\<`string`\> + +#### Ref + +https://w3c.github.io/webdriver/#dfn-get-current-url + +#### Inherited from + +`ProtocolCommands.getUrl` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:50 + +*** + +### ~~getWindowHandle()~~ + +```ts +getWindowHandle(): Promise +``` + +Webdriver Protocol Command + +The Get Window Handle command returns the window handle for the current top-level browsing context. It can be used as an argument to Switch To Window. + +#### Returns + +`Promise`\<`string`\> + +#### Ref + +https://w3c.github.io/webdriver/#dfn-get-window-handle + +#### Inherited from + +`ProtocolCommands.getWindowHandle` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:98 + +*** + +### ~~getWindowHandles()~~ + +```ts +getWindowHandles(): Promise +``` + +Webdriver Protocol Command + +The Get Window Handles command returns a list of window handles for every open top-level browsing context. The order in which the window handles are returned is arbitrary. + +#### Returns + +`Promise`\<`string`[]\> + +#### Ref + +https://w3c.github.io/webdriver/#dfn-get-window-handles + +#### Inherited from + +`ProtocolCommands.getWindowHandles` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:130 + +*** + +### ~~getWindowPosition()~~ + +```ts +getWindowPosition(): Promise +``` + +Jsonwp Protocol Command + +Get the position of the current focussed window. + +#### Returns + +`Promise`\<`ProtocolCommandResponse`\> + +#### Ref + +https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#get-sessionsessionidwindowwindowhandleposition + +#### Deprecated + +This command is deprecated and likely not supported by any browser. + +#### Inherited from + +`ProtocolCommands.getWindowPosition` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/jsonwp.d.ts:175 + +*** + +### ~~getWindowRect()~~ + +```ts +getWindowRect(): Promise +``` + +Webdriver Protocol Command + +The Get Window Rect command returns the size and position on the screen of the operating system window corresponding to the current top-level browsing context. + +#### Returns + +`Promise`\<`RectReturn`\> + +#### Ref + +https://w3c.github.io/webdriver/#dfn-get-window-rect + +#### Inherited from + +`ProtocolCommands.getWindowRect` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:162 + +*** + +### ~~gridProxyDetails()~~ + +```ts +gridProxyDetails(id): Promise +``` + +Selenium Protocol Command + +Get proxy details. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `id` | `string` | + +#### Returns + +`Promise`\<`ProtocolCommandResponse`\> + +#### Ref + +https://github.com/nicegraham/selenium-grid2-api#gridapiproxy + +#### Inherited from + +`ProtocolCommands.gridProxyDetails` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/selenium.d.ts:58 + +*** + +### ~~gridTestSession()~~ + +```ts +gridTestSession(session): Promise +``` + +Selenium Protocol Command + +Get the details of the Selenium Grid node running a session. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `session` | `string` | + +#### Returns + +`Promise`\<`ProtocolCommandResponse`\> + +#### Ref + +https://github.com/nicegraham/selenium-grid2-api#gridapitestsession + +#### Inherited from + +`ProtocolCommands.gridTestSession` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/selenium.d.ts:50 + +*** + +### ~~gsmCall()~~ + +```ts +gsmCall(phoneNumber, action): Promise +``` + +Appium Protocol Command + +Make GSM call (Emulator only). + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `phoneNumber` | `string` | +| `action` | `string` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://appium.github.io/appium.io/docs/en/commands/device/network/gsm-call/ + +#### Inherited from + +`ProtocolCommands.gsmCall` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/appium.d.ts:413 + +*** + +### ~~gsmSignal()~~ + +```ts +gsmSignal(signalStrength, signalStrengh?): Promise +``` + +Appium Protocol Command + +Set GSM signal strength (Emulator only). + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `signalStrength` | `string` | +| `signalStrengh`? | `string` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://appium.github.io/appium.io/docs/en/commands/device/network/gsm-signal/ + +#### Inherited from + +`ProtocolCommands.gsmSignal` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/appium.d.ts:421 + +*** + +### ~~gsmVoice()~~ + +```ts +gsmVoice(state): Promise +``` + +Appium Protocol Command + +Set GSM voice state (Emulator only). + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `state` | `string` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://appium.github.io/appium.io/docs/en/commands/device/network/gsm-voice/ + +#### Inherited from + +`ProtocolCommands.gsmVoice` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/appium.d.ts:445 + +*** + +### ~~hideKeyboard()~~ + +```ts +hideKeyboard( + strategy?, + key?, + keyCode?, +keyName?): Promise +``` + +Appium Protocol Command + +Hide soft keyboard. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `strategy`? | `string` | +| `key`? | `string` | +| `keyCode`? | `string` | +| `keyName`? | `string` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://appium.github.io/appium.io/docs/en/commands/device/keys/hide-keyboard/ + +#### Inherited from + +`ProtocolCommands.hideKeyboard` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/appium.d.ts:194 + +*** + +### ~~inputPerformActions()~~ + +```ts +inputPerformActions(params): Promise +``` + +WebDriver Bidi command to send command method "input.performActions" with parameters. + +#### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `params` | `InputPerformActionsParameters` | `remote.InputPerformActionsParameters` [command parameter](https://w3c.github.io/webdriver-bidi/#command-input-performActions) | + +#### Returns + +`Promise`\<`EmptyResult`\> + +`Promise` + +#### Url + +https://w3c.github.io/webdriver-bidi/#command-input-performActions + +#### Inherited from + +`BidiHandler.inputPerformActions` + +#### Defined in + +testplane/node\_modules/webdriver/build/bidi/handler.d.ts:242 + +*** + +### ~~inputReleaseActions()~~ + +```ts +inputReleaseActions(params): Promise +``` + +WebDriver Bidi command to send command method "input.releaseActions" with parameters. + +#### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `params` | `InputReleaseActionsParameters` | `remote.InputReleaseActionsParameters` [command parameter](https://w3c.github.io/webdriver-bidi/#command-input-releaseActions) | + +#### Returns + +`Promise`\<`EmptyResult`\> + +`Promise` + +#### Url + +https://w3c.github.io/webdriver-bidi/#command-input-releaseActions + +#### Inherited from + +`BidiHandler.inputReleaseActions` + +#### Defined in + +testplane/node\_modules/webdriver/build/bidi/handler.d.ts:249 + +*** + +### ~~installAddOn()~~ + +```ts +installAddOn(addon, temporary): Promise +``` + +Gecko Protocol Command + +Installs a new addon with the current session. This function will return an ID that may later be used to uninstall the addon using `uninstallAddon`. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `addon` | `string` | +| `temporary` | `boolean` | + +#### Returns + +`Promise`\<`string`\> + +#### Ref + +https://github.com/SeleniumHQ/selenium/blob/586affe0cf675b1d5c8abc756defa4a46d95391b/javascript/node/selenium-webdriver/firefox.js#L647-L668 + +#### Example + +```js +// Create a buffer of the add on .zip file +const extension = await fs.promises.readFile('/path/to/extension.zip') +// Load extension in Firefox +const id = await browser.installAddOn(extension.toString('base64'), false); +``` + +#### Inherited from + +`ProtocolCommands.installAddOn` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/gecko.d.ts:50 + +*** + +### ~~installApp()~~ + +```ts +installApp(appPath): Promise +``` + +Appium Protocol Command + +Install the given app onto the device. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `appPath` | `string` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://appium.github.io/appium.io/docs/en/commands/device/app/install-app/ + +#### Inherited from + +`ProtocolCommands.installApp` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/appium.d.ts:146 + +*** + +### ~~interceptRequest()~~ + +```ts +interceptRequest(rule): Promise +``` + +Saucelabs Protocol Command + +Allows modifying any request made by the browser. You can blacklist, modify, or redirect these as required for your tests. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `rule` | `object` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://wiki.saucelabs.com/display/DOCS/Custom+Sauce+Labs+WebDriver+Extensions+for+Network+and+Log+Commands#CustomSauceLabsWebDriverExtensionsforNetworkandLogCommands-InterceptNetworkRequests + +#### Examples + +```js +// redirect a request +browser.interceptRequest({ + url: 'https://saucelabs.com', + redirect: 'https://google.com' +}) +```* + +```js +// Blacklist requests to 3rd party vendors +browser.interceptRequest({ + url: 'https://api.segment.io/v1/p', + error: 'Failed' +}) +```* + +```js +// Modify requests to REST API (Mock REST API response) +browser.interceptRequest({ + url: 'http://sampleapp.appspot.com/api/todos', + response: { + headers: { + 'x-custom-headers': 'foobar' + }, + body: [{ + title: 'My custom todo', + order: 1, + completed: false, + url: 'http://todo-backend-express.herokuapp.com/15727' + }] + } +}) +``` + +#### Inherited from + +`ProtocolCommands.interceptRequest` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/saucelabs.d.ts:130 + +*** + +### ~~isAlertOpen()~~ + +```ts +isAlertOpen(): Promise +``` + +Chromium Protocol Command + +Whether a simple dialog is currently open. + +#### Returns + +`Promise`\<`boolean`\> + +#### Ref + +https://github.com/bayandin/chromedriver/blob/v2.45/alert_commands.cc#L42-L49 + +#### Example + +```js +console.log(browser.isAlertOpen()); // outputs: false +browser.execute('window.alert()'); +console.log(browser.isAlertOpen()); // outputs: true +``` + +#### Inherited from + +`ProtocolCommands.isAlertOpen` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/chromium.d.ts:16 + +*** + +### ~~isAppInstalled()~~ + +```ts +isAppInstalled(appId): Promise +``` + +Appium Protocol Command + +Check whether the specified app is installed on the device. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `appId` | `string` | + +#### Returns + +`Promise`\<`boolean`\> + +#### Ref + +https://appium.github.io/appium.io/docs/en/commands/device/app/is-app-installed/ + +#### Inherited from + +`ProtocolCommands.isAppInstalled` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/appium.d.ts:178 + +*** + +### ~~isAutoReporting()~~ + +```ts +isAutoReporting(): Promise +``` + +Chromium Protocol Command + +Whether it should automatically raises errors on browser logs. + +#### Returns + +`Promise`\<`boolean`\> + +#### Ref + +https://codereview.chromium.org/101203012 + +#### Inherited from + +`ProtocolCommands.isAutoReporting` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/chromium.d.ts:24 + +*** + +### ~~isElementDisplayed()~~ + +```ts +isElementDisplayed(elementId): Promise +``` + +Webdriver Protocol Command + +Is Element Displayed determines the visibility of an element which is guided by what is perceptually visible to the human eye. In this context, an element's displayedness does not relate to the `visibility` or `display` style properties. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `elementId` | `string` | + +#### Returns + +`Promise`\<`boolean`\> + +#### Ref + +https://w3c.github.io/webdriver/#element-displayedness + +#### Inherited from + +`ProtocolCommands.isElementDisplayed` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:274 + +*** + +### ~~isElementEnabled()~~ + +```ts +isElementEnabled(elementId): Promise +``` + +Webdriver Protocol Command + +Is Element Enabled determines if the referenced element is enabled or not. This operation only makes sense on form controls. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `elementId` | `string` | + +#### Returns + +`Promise`\<`boolean`\> + +#### Ref + +https://w3c.github.io/webdriver/#dfn-is-element-enabled + +#### Inherited from + +`ProtocolCommands.isElementEnabled` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:330 + +*** + +### ~~isElementSelected()~~ + +```ts +isElementSelected(elementId): Promise +``` + +Webdriver Protocol Command + +Is Element Selected determines if the referenced element is selected or not. This operation only makes sense on input elements of the Checkbox- and Radio Button states, or option elements. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `elementId` | `string` | + +#### Returns + +`Promise`\<`boolean`\> + +#### Ref + +https://w3c.github.io/webdriver/#dfn-is-element-selected + +#### Inherited from + +`ProtocolCommands.isElementSelected` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:266 + +*** + +### ~~isIMEActivated()~~ + +```ts +isIMEActivated(): Promise +``` + +Jsonwp Protocol Command + +No description available, please see reference link. + +#### Returns + +`Promise`\<`boolean`\> + +#### Ref + +https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidimeactivated + +#### Deprecated + +This command is deprecated and likely not supported by any browser. + +#### Inherited from + +`ProtocolCommands.isIMEActivated` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/jsonwp.d.ts:507 + +*** + +### ~~isKeyboardShown()~~ + +```ts +isKeyboardShown(): Promise +``` + +Appium Protocol Command + +Whether or not the soft keyboard is shown. + +#### Returns + +`Promise`\<`boolean`\> + +#### Ref + +https://appium.github.io/appium.io/docs/en/commands/device/keys/is-keyboard-shown/ + +#### Inherited from + +`ProtocolCommands.isKeyboardShown` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/appium.d.ts:202 + +*** + +### ~~isLoading()~~ + +```ts +isLoading(): Promise +``` + +Chromium Protocol Command + +Determines load status for active window handle. + +#### Returns + +`Promise`\<`boolean`\> + +#### Ref + +https://github.com/bayandin/chromedriver/blob/v2.45/session_commands.cc#L783-L802 + +#### Example + +```js +console.log(browser.isLoading()); // outputs: false +browser.newWindow('https://webdriver.io'); +console.log(browser.isLoading()); // outputs: true +``` + +#### Inherited from + +`ProtocolCommands.isLoading` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/chromium.d.ts:61 + +*** + +### ~~isLocked()~~ + +```ts +isLocked(): Promise +``` + +Appium Protocol Command + +Check whether the device is locked or not. + +#### Returns + +`Promise`\<`boolean`\> + +#### Ref + +https://appium.github.io/appium.io/docs/en/commands/device/interactions/is-locked/ + +#### Inherited from + +`ProtocolCommands.isLocked` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/appium.d.ts:58 + +*** + +### ~~jankinessCheck()~~ + +```ts +jankinessCheck(): Promise +``` + +Saucelabs Protocol Command + +Perform a scroll test that evaluates the jankiness of the application. + +#### Returns + +`Promise`\<`ProtocolCommandResponse`\> + +#### Ref + +https://wiki.saucelabs.com/display/DOCS/Custom+Sauce+Labs+WebDriver+Extensions+for+Network+and+Log+Commands + +#### Example + +```js +// test performance for a page +browser.url('https://webdriver.io') +browser.jankinessCheck() +``` + +#### Inherited from + +`ProtocolCommands.jankinessCheck` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/saucelabs.d.ts:161 + +*** + +### ~~launchApp()~~ + +```ts +launchApp(): Promise +``` + +Appium Protocol Command + +Launch an app on device. + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://appium.github.io/appium.io/docs/en/commands/device/app/launch-app/ + +#### Deprecated + +For iOS, utilize `driver.execute('mobile: launchApp', { ... })`, and for Android, make use of `driver.execute('mobile: activateApp', { ... })`. + +#### Inherited from + +`ProtocolCommands.launchApp` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/appium.d.ts:331 + +*** + +### ~~launchChromeApp()~~ + +```ts +launchChromeApp(id): Promise +``` + +Chromium Protocol Command + +Launches a Chrome app by specified id. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `id` | `string` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://github.com/bayandin/chromedriver/blob/v2.45/session_commands.cc#L521-L539 + +#### Example + +```js +import fs from 'fs' +const browser = remote({ + capabilities: { + browserName: 'chrome', + 'goog:chromeOptions': { + // Install upon starting browser in order to launch it + extensions: [ + // Entry should be a base64-encoded packed Chrome app (.crx) + fs.readFileSync('/absolute/path/app.crx').toString('base64') + ] + } + } +}); +browser.launchChromeApp('aohghmighlieiainnegkcijnfilokake')); // Google Docs (https://chrome.google.com/webstore/detail/docs/aohghmighlieiainnegkcijnfilokake) +``` + +#### Inherited from + +`ProtocolCommands.launchChromeApp` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/chromium.d.ts:204 + +*** + +### ~~listenerCount()~~ + +```ts +listenerCount(eventName, listener?): number +``` + +Returns the number of listeners listening to the event named `eventName`. + +If `listener` is provided, it will return how many times the listener +is found in the list of the listeners of the event. + +#### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `eventName` | `string` \| `symbol` | The name of the event being listened for | +| `listener`? | `Function` | The event handler function | + +#### Returns + +`number` + +#### Since + +v3.2.0 + +#### Inherited from + +`Omit.listenerCount` + +#### Defined in + +testplane/node\_modules/@types/node/events.d.ts:741 + +*** + +### ~~listeners()~~ + +```ts +listeners(eventName): Function[] +``` + +Returns a copy of the array of listeners for the event named `eventName`. + +```js +server.on('connection', (stream) => { + console.log('someone connected!'); +}); +console.log(util.inspect(server.listeners('connection'))); +// Prints: [ [Function] ] +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `eventName` | `string` \| `symbol` | + +#### Returns + +`Function`[] + +#### Since + +v0.1.26 + +#### Inherited from + +`Omit.listeners` + +#### Defined in + +testplane/node\_modules/@types/node/events.d.ts:660 + +*** + +### ~~lock()~~ + +```ts +lock(seconds?): Promise +``` + +Appium Protocol Command + +Lock the device. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `seconds`? | `number` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://appium.github.io/appium.io/docs/en/commands/device/interactions/lock/ + +#### Inherited from + +`ProtocolCommands.lock` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/appium.d.ts:42 + +*** + +### ~~logEvent()~~ + +```ts +logEvent(vendor, event): Promise +``` + +Appium Protocol Command + +Store a custom event. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `vendor` | `string` | +| `event` | `string` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://github.com/appium/appium/blob/master/docs/en/commands/session/events/log-event.md + +#### Inherited from + +`ProtocolCommands.logEvent` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/appium.d.ts:555 + +*** + +### ~~longPressKeyCode()~~ + +```ts +longPressKeyCode( + keycode, + metastate?, +flags?): Promise +``` + +Appium Protocol Command + +Press and hold a particular key code on the device. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `keycode` | `number` | +| `metastate`? | `number` | +| `flags`? | `number` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://appium.github.io/appium.io/docs/en/commands/device/keys/long-press-keycode/ + +#### Inherited from + +`ProtocolCommands.longPressKeyCode` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/appium.d.ts:106 + +*** + +### ~~manageSeleniumHubLifecycle()~~ + +```ts +manageSeleniumHubLifecycle(action): Promise +``` + +Selenium Protocol Command + +Manage lifecycle of hub node. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `action` | `string` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://github.com/nicegraham/selenium-grid2-api#lifecycle-manager + +#### Inherited from + +`ProtocolCommands.manageSeleniumHubLifecycle` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/selenium.d.ts:66 + +*** + +### ~~maximizeWindow()~~ + +```ts +maximizeWindow(): Promise +``` + +Webdriver Protocol Command + +The Maximize Window command invokes the window manager-specific "maximize" operation, if any, on the window containing the current top-level browsing context. This typically increases the window to the maximum available size without going full-screen. + +#### Returns + +`Promise`\<`RectReturn`\> + +#### Ref + +https://w3c.github.io/webdriver/#dfn-maximize-window + +#### Inherited from + +`ProtocolCommands.maximizeWindow` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:178 + +*** + +### ~~minimizeWindow()~~ + +```ts +minimizeWindow(): Promise +``` + +Webdriver Protocol Command + +The Minimize Window command invokes the window manager-specific "minimize" operation, if any, on the window containing the current top-level browsing context. This typically hides the window in the system tray. + +#### Returns + +`Promise`\<`RectReturn`\> + +#### Ref + +https://w3c.github.io/webdriver/#dfn-minimize-window + +#### Inherited from + +`ProtocolCommands.minimizeWindow` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:186 + +*** + +### ~~mockRequest()~~ + +```ts +mockRequest(url, filterOptions?): Promise +``` + +Saucelabs Protocol Command + +Mocks a network resource. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `url` | `string` | +| `filterOptions`? | `object` | + +#### Returns + +`Promise`\<`ProtocolCommandResponse`\> + +#### Ref + +https://wiki.saucelabs.com/display/DOCS/Custom+Sauce+Labs+WebDriver+Extensions+for+Network+and+Log+Commands + +#### Inherited from + +`ProtocolCommands.mockRequest` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/saucelabs.d.ts:169 + +*** + +### ~~moveToElement()~~ + +```ts +moveToElement( + element?, + xoffset?, +yoffset?): Promise +``` + +Jsonwp Protocol Command + +No description available, please see reference link. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `element`? | `null` \| `string` | +| `xoffset`? | `number` | +| `yoffset`? | `number` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidmoveto + +#### Deprecated + +This command is deprecated and likely not supported by any browser. Use the "action" command instead to execute a "move to" gesture! + +#### Inherited from + +`ProtocolCommands.moveToElement` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/jsonwp.d.ts:552 + +*** + +### ~~multiTouchPerform()~~ + +```ts +multiTouchPerform(actions): Promise +``` + +Appium Protocol Command + +This functionality is only available from within a native context. Perform a multi touch action sequence. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `actions` | `object`[] | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://appium.github.io/appium.io/docs/en/commands/interactions/touch/multi-touch-perform/ + +#### Inherited from + +`ProtocolCommands.multiTouchPerform` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/appium.d.ts:531 + +*** + +### ~~navigateTo()~~ + +```ts +navigateTo(url): Promise +``` + +Webdriver Protocol Command + +The navigateTo (go) command is used to cause the user agent to navigate the current top-level browsing context a new location. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `url` | `string` | + +#### Returns + +`Promise`\<`string`\> + +#### Ref + +https://w3c.github.io/webdriver/#dfn-navigate-to + +#### Inherited from + +`ProtocolCommands.navigateTo` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:58 + +*** + +### ~~networkAddIntercept()~~ + +```ts +networkAddIntercept(params): Promise +``` + +WebDriver Bidi command to send command method "network.addIntercept" with parameters. + +#### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `params` | `NetworkAddInterceptParameters` | `remote.NetworkAddInterceptParameters` [command parameter](https://w3c.github.io/webdriver-bidi/#command-network-addIntercept) | + +#### Returns + +`Promise`\<`NetworkAddInterceptResult`\> + +`Promise` + +#### Url + +https://w3c.github.io/webdriver-bidi/#command-network-addIntercept + +#### Inherited from + +`BidiHandler.networkAddIntercept` + +#### Defined in + +testplane/node\_modules/webdriver/build/bidi/handler.d.ts:151 + +*** + +### ~~networkContinueRequest()~~ + +```ts +networkContinueRequest(params): Promise +``` + +WebDriver Bidi command to send command method "network.continueRequest" with parameters. + +#### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `params` | `NetworkContinueRequestParameters` | `remote.NetworkContinueRequestParameters` [command parameter](https://w3c.github.io/webdriver-bidi/#command-network-continueRequest) | + +#### Returns + +`Promise`\<`EmptyResult`\> + +`Promise` + +#### Url + +https://w3c.github.io/webdriver-bidi/#command-network-continueRequest + +#### Inherited from + +`BidiHandler.networkContinueRequest` + +#### Defined in + +testplane/node\_modules/webdriver/build/bidi/handler.d.ts:158 + +*** + +### ~~networkContinueResponse()~~ + +```ts +networkContinueResponse(params): Promise +``` + +WebDriver Bidi command to send command method "network.continueResponse" with parameters. + +#### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `params` | `NetworkContinueResponseParameters` | `remote.NetworkContinueResponseParameters` [command parameter](https://w3c.github.io/webdriver-bidi/#command-network-continueResponse) | + +#### Returns + +`Promise`\<`EmptyResult`\> + +`Promise` + +#### Url + +https://w3c.github.io/webdriver-bidi/#command-network-continueResponse + +#### Inherited from + +`BidiHandler.networkContinueResponse` + +#### Defined in + +testplane/node\_modules/webdriver/build/bidi/handler.d.ts:165 + +*** + +### ~~networkContinueWithAuth()~~ + +```ts +networkContinueWithAuth(params): Promise +``` + +WebDriver Bidi command to send command method "network.continueWithAuth" with parameters. + +#### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `params` | `NetworkContinueWithAuthParameters` | `remote.NetworkContinueWithAuthParameters` [command parameter](https://w3c.github.io/webdriver-bidi/#command-network-continueWithAuth) | + +#### Returns + +`Promise`\<`EmptyResult`\> + +`Promise` + +#### Url + +https://w3c.github.io/webdriver-bidi/#command-network-continueWithAuth + +#### Inherited from + +`BidiHandler.networkContinueWithAuth` + +#### Defined in + +testplane/node\_modules/webdriver/build/bidi/handler.d.ts:172 + +*** + +### ~~networkFailRequest()~~ + +```ts +networkFailRequest(params): Promise +``` + +WebDriver Bidi command to send command method "network.failRequest" with parameters. + +#### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `params` | `NetworkFailRequestParameters` | `remote.NetworkFailRequestParameters` [command parameter](https://w3c.github.io/webdriver-bidi/#command-network-failRequest) | + +#### Returns + +`Promise`\<`EmptyResult`\> + +`Promise` + +#### Url + +https://w3c.github.io/webdriver-bidi/#command-network-failRequest + +#### Inherited from + +`BidiHandler.networkFailRequest` + +#### Defined in + +testplane/node\_modules/webdriver/build/bidi/handler.d.ts:179 + +*** + +### ~~networkProvideResponse()~~ + +```ts +networkProvideResponse(params): Promise +``` + +WebDriver Bidi command to send command method "network.provideResponse" with parameters. + +#### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `params` | `NetworkProvideResponseParameters` | `remote.NetworkProvideResponseParameters` [command parameter](https://w3c.github.io/webdriver-bidi/#command-network-provideResponse) | + +#### Returns + +`Promise`\<`EmptyResult`\> + +`Promise` + +#### Url + +https://w3c.github.io/webdriver-bidi/#command-network-provideResponse + +#### Inherited from + +`BidiHandler.networkProvideResponse` + +#### Defined in + +testplane/node\_modules/webdriver/build/bidi/handler.d.ts:186 + +*** + +### ~~networkRemoveIntercept()~~ + +```ts +networkRemoveIntercept(params): Promise +``` + +WebDriver Bidi command to send command method "network.removeIntercept" with parameters. + +#### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `params` | `NetworkRemoveInterceptParameters` | `remote.NetworkRemoveInterceptParameters` [command parameter](https://w3c.github.io/webdriver-bidi/#command-network-removeIntercept) | + +#### Returns + +`Promise`\<`EmptyResult`\> + +`Promise` + +#### Url + +https://w3c.github.io/webdriver-bidi/#command-network-removeIntercept + +#### Inherited from + +`BidiHandler.networkRemoveIntercept` + +#### Defined in + +testplane/node\_modules/webdriver/build/bidi/handler.d.ts:193 + +*** + +### ~~newSession()~~ + +```ts +newSession(capabilities): Promise +``` + +Webdriver Protocol Command + +The New Session command creates a new WebDriver session with the endpoint node. If the creation fails, a session not created error is returned. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `capabilities` | `object` | + +#### Returns + +`Promise`\<`SessionReturn`\> + +#### Ref + +https://w3c.github.io/webdriver/#dfn-new-sessions + +#### Inherited from + +`ProtocolCommands.newSession` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:10 + +*** + +### ~~off()~~ + +```ts +off(eventName, listener): this +``` + +Alias for `emitter.removeListener()`. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `eventName` | `string` \| `symbol` | +| `listener` | (...`args`) => `void` | + +#### Returns + +`this` + +#### Since + +v10.0.0 + +#### Inherited from + +`Omit.off` + +#### Defined in + +testplane/node\_modules/@types/node/events.d.ts:620 + +*** + +### ~~on()~~ + +```ts +on(event, listener): this +``` + +#### Type Parameters + +| Type Parameter | +| ------ | +| `K` *extends* \| `"browsingContext.contextCreated"` \| `"browsingContext.contextDestroyed"` \| `"browsingContext.domContentLoaded"` \| `"browsingContext.downloadWillBegin"` \| `"browsingContext.fragmentNavigated"` \| `"browsingContext.load"` \| `"browsingContext.navigationAborted"` \| `"browsingContext.navigationFailed"` \| `"browsingContext.navigationStarted"` \| `"browsingContext.userPromptClosed"` \| `"browsingContext.userPromptOpened"` \| `"log.entryAdded"` \| `"network.authRequired"` \| `"network.beforeRequestSent"` \| `"network.fetchError"` \| `"network.responseCompleted"` \| `"network.responseStarted"` \| `"script.message"` \| `"script.realmCreated"` \| `"script.realmDestroyed"` \| keyof WebDriverClassicEvents | + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `event` | `K` | +| `listener` | (`this`, `param`) => `void` | + +#### Returns + +`this` + +#### Inherited from + +`BidiEventHandler.on` + +#### Defined in + +testplane/node\_modules/webdriver/build/types.d.ts:66 + +*** + +### ~~once()~~ + +```ts +once(event, listener): this +``` + +#### Type Parameters + +| Type Parameter | +| ------ | +| `K` *extends* \| `"browsingContext.contextCreated"` \| `"browsingContext.contextDestroyed"` \| `"browsingContext.domContentLoaded"` \| `"browsingContext.downloadWillBegin"` \| `"browsingContext.fragmentNavigated"` \| `"browsingContext.load"` \| `"browsingContext.navigationAborted"` \| `"browsingContext.navigationFailed"` \| `"browsingContext.navigationStarted"` \| `"browsingContext.userPromptClosed"` \| `"browsingContext.userPromptOpened"` \| `"log.entryAdded"` \| `"network.authRequired"` \| `"network.beforeRequestSent"` \| `"network.fetchError"` \| `"network.responseCompleted"` \| `"network.responseStarted"` \| `"script.message"` \| `"script.realmCreated"` \| `"script.realmDestroyed"` \| keyof WebDriverClassicEvents | + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `event` | `K` | +| `listener` | (`this`, `param`) => `void` | + +#### Returns + +`this` + +#### Inherited from + +`BidiEventHandler.once` + +#### Defined in + +testplane/node\_modules/webdriver/build/types.d.ts:67 + +*** + +### ~~openNotifications()~~ + +```ts +openNotifications(): Promise +``` + +Appium Protocol Command + +Open Android notifications (Emulator only). + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://appium.github.io/appium.io/docs/en/commands/device/system/open-notifications/ + +#### Inherited from + +`ProtocolCommands.openNotifications` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/appium.d.ts:274 + +*** + +### ~~overwriteCommand()~~ + +```ts +overwriteCommand( + name, + func, + attachToElement?, + proto?, + instances?): void +``` + +overwrite `browser` or `element` command + +#### Type Parameters + +| Type Parameter | Default type | +| ------ | ------ | +| `ElementKey` *extends* \| `"$"` \| `"custom$"` \| `"shadow$"` \| `"react$"` \| `"$$"` \| `"custom$$"` \| `"shadow$$"` \| `"react$$"` \| `"saveScreenshot"` \| `"touchAction"` \| `"waitUntil"` \| `"addValue"` \| `"clearValue"` \| `"click"` \| `"doubleClick"` \| `"dragAndDrop"` \| `"getAttribute"` \| `"getCSSProperty"` \| `"getComputedLabel"` \| `"getComputedRole"` \| `"getHTML"` \| `"getLocation"` \| `"getProperty"` \| `"getSize"` \| `"getTagName"` \| `"getText"` \| `"getValue"` \| `"isClickable"` \| `"isDisplayed"` \| `"isDisplayedInViewport"` \| `"isEnabled"` \| `"isEqual"` \| `"isExisting"` \| `"isFocused"` \| `"isSelected"` \| `"moveTo"` \| `"nextElement"` \| `"parentElement"` \| `"previousElement"` \| `"scrollIntoView"` \| `"selectByAttribute"` \| `"selectByIndex"` \| `"selectByVisibleText"` \| `"setValue"` \| `"waitForClickable"` \| `"waitForDisplayed"` \| `"waitForEnabled"` \| `"waitForExist"` \| `"isStable"` \| `"waitForStable"` | - | +| `BrowserKey` *extends* \| `"keys"` \| `"$"` \| `"custom$"` \| `"react$"` \| `"$$"` \| `"custom$$"` \| `"react$$"` \| `"action"` \| `"actions"` \| `"call"` \| `"debug"` \| `"deleteCookies"` \| `"downloadFile"` \| `"emulate"` \| `"execute"` \| `"executeAsync"` \| `"getCookies"` \| `"getPuppeteer"` \| `"getWindowSize"` \| `"mock"` \| `"SESSION_MOCKS"` \| `"CDP_SESSIONS"` \| `"mockClearAll"` \| `"mockRestoreAll"` \| `"newWindow"` \| `"pause"` \| `"reloadSession"` \| `"savePDF"` \| `"saveRecordingScreen"` \| `"saveScreenshot"` \| `"scroll"` \| `"setCookies"` \| `"setTimeout"` \| `"setWindowSize"` \| `"switchWindow"` \| `"throttle"` \| `"throttleCPU"` \| `"throttleNetwork"` \| `"touchAction"` \| `"uploadFile"` \| `"url"` \| `"waitUntil"` | - | +| `IsElement` *extends* `boolean` | `false` | + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `name` | `IsElement` *extends* `true` ? `ElementKey` : `BrowserKey` | +| `func` | `OverwriteCommandFn`\<`ElementKey`, `BrowserKey`, `IsElement`\> \| `OverwriteCommandFnScoped`\<`ElementKey`, `BrowserKey`, `IsElement`\> | +| `attachToElement`? | `IsElement` | +| `proto`? | `Record`\<`string`, `any`\> | +| `instances`? | `Record`\<`string`, `Browser` \| `MultiRemoteBrowser`\> | + +#### Returns + +`void` + +#### Inherited from + +`Omit.overwriteCommand` + +#### Defined in + +testplane/node\_modules/webdriverio/build/types.d.ts:139 + +*** + +### ~~performActions()~~ + +```ts +performActions(actions): Promise +``` + +Webdriver Protocol Command + +The Perform Actions command is used to execute complex user actions. See [spec](https://github.com/jlipps/simple-wd-spec#perform-actions) for more details. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `actions` | `object`[] | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://w3c.github.io/webdriver/#dfn-perform-actions + +#### Inherited from + +`ProtocolCommands.performActions` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:426 + +*** + +### ~~positionClick()~~ + +```ts +positionClick(button?): Promise +``` + +Jsonwp Protocol Command + +Clicks at the current mouse coordinates (set by moveto). + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `button`? | `number` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidclick + +#### Deprecated + +This command is deprecated and likely not supported by any browser. Use the "action" command instead of "positionClick"! + +#### Inherited from + +`ProtocolCommands.positionClick` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/jsonwp.d.ts:579 + +*** + +### ~~positionDoubleClick()~~ + +```ts +positionDoubleClick(): Promise +``` + +Jsonwp Protocol Command + +Double-clicks at the current mouse coordinates (set by moveto). + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessioniddoubleclick + +#### Deprecated + +This command is deprecated and likely not supported by any browser. Use the "action" command instead to execute a click gesture! + +#### Inherited from + +`ProtocolCommands.positionDoubleClick` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/jsonwp.d.ts:588 + +*** + +### ~~powerAC()~~ + +```ts +powerAC(state): Promise +``` + +Appium Protocol Command + +Set the state of the battery charger to connected or not (Emulator only). + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `state` | `string` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://appium.github.io/appium.io/docs/en/commands/device/emulator/power_ac/ + +#### Inherited from + +`ProtocolCommands.powerAC` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/appium.d.ts:437 + +*** + +### ~~powerCapacity()~~ + +```ts +powerCapacity(percent): Promise +``` + +Appium Protocol Command + +Set the battery percentage (Emulator only). + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `percent` | `number` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://appium.github.io/appium.io/docs/en/commands/device/emulator/power_capacity/ + +#### Inherited from + +`ProtocolCommands.powerCapacity` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/appium.d.ts:429 + +*** + +### ~~prependListener()~~ + +```ts +prependListener(eventName, listener): this +``` + +Adds the `listener` function to the _beginning_ of the listeners array for the +event named `eventName`. No checks are made to see if the `listener` has +already been added. Multiple calls passing the same combination of `eventName`and `listener` will result in the `listener` being added, and called, multiple +times. + +```js +server.prependListener('connection', (stream) => { + console.log('someone connected!'); +}); +``` + +Returns a reference to the `EventEmitter`, so that calls can be chained. + +#### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `eventName` | `string` \| `symbol` | The name of the event. | +| `listener` | (...`args`) => `void` | The callback function | + +#### Returns + +`this` + +#### Since + +v6.0.0 + +#### Inherited from + +`Omit.prependListener` + +#### Defined in + +testplane/node\_modules/@types/node/events.d.ts:759 + +*** + +### ~~prependOnceListener()~~ + +```ts +prependOnceListener(eventName, listener): this +``` + +Adds a **one-time**`listener` function for the event named `eventName` to the _beginning_ of the listeners array. The next time `eventName` is triggered, this +listener is removed, and then invoked. + +```js +server.prependOnceListener('connection', (stream) => { + console.log('Ah, we have our first user!'); +}); +``` + +Returns a reference to the `EventEmitter`, so that calls can be chained. + +#### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `eventName` | `string` \| `symbol` | The name of the event. | +| `listener` | (...`args`) => `void` | The callback function | + +#### Returns + +`this` + +#### Since + +v6.0.0 + +#### Inherited from + +`Omit.prependOnceListener` + +#### Defined in + +testplane/node\_modules/@types/node/events.d.ts:775 + +*** + +### ~~pressKeyCode()~~ + +```ts +pressKeyCode( + keycode, + metastate?, +flags?): Promise +``` + +Appium Protocol Command + +Press a particular key on the device. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `keycode` | `number` | +| `metastate`? | `number` | +| `flags`? | `number` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://appium.github.io/appium.io/docs/en/commands/device/keys/press-keycode/ + +#### Inherited from + +`ProtocolCommands.pressKeyCode` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/appium.d.ts:98 + +*** + +### ~~printPage()~~ + +```ts +printPage( + orientation?, + scale?, + background?, + width?, + height?, + top?, + bottom?, + left?, + right?, + shrinkToFit?, +pageRanges?): Promise +``` + +Webdriver Protocol Command + +The Print Page command renders the document to a paginated PDF document. __Note:__ Chrome currently only supports this in [headless mode](https://webdriver.io/docs/capabilities/#run-browser-headless), see [`crbug753118`](https://bugs.chromium.org/p/chromium/issues/detail?id=753118)). + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `orientation`? | `string` | +| `scale`? | `number` | +| `background`? | `boolean` | +| `width`? | `number` | +| `height`? | `number` | +| `top`? | `number` | +| `bottom`? | `number` | +| `left`? | `number` | +| `right`? | `number` | +| `shrinkToFit`? | `boolean` | +| `pageRanges`? | `object`[] | + +#### Returns + +`Promise`\<`string`\> + +#### Ref + +https://w3c.github.io/webdriver/#print-page + +#### Inherited from + +`ProtocolCommands.printPage` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:138 + +*** + +### ~~pullFile()~~ + +```ts +pullFile(path): Promise +``` + +Appium Protocol Command + +Retrieve a file from the device's file system. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `path` | `string` | + +#### Returns + +`Promise`\<`string`\> + +#### Ref + +https://appium.github.io/appium.io/docs/en/commands/device/files/pull-file/ + +#### Inherited from + +`ProtocolCommands.pullFile` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/appium.d.ts:218 + +*** + +### ~~pullFolder()~~ + +```ts +pullFolder(path): Promise +``` + +Appium Protocol Command + +Retrieve a folder from the device's file system. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `path` | `string` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://appium.github.io/appium.io/docs/en/commands/device/files/pull-folder/ + +#### Inherited from + +`ProtocolCommands.pullFolder` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/appium.d.ts:226 + +*** + +### ~~pushFile()~~ + +```ts +pushFile(path, data): Promise +``` + +Appium Protocol Command + +Place a file onto the device in a particular place. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `path` | `string` | +| `data` | `string` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://appium.github.io/appium.io/docs/en/commands/device/files/push-file/ + +#### Inherited from + +`ProtocolCommands.pushFile` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/appium.d.ts:210 + +*** + +### ~~queryAppState()~~ + +```ts +queryAppState(appId): Promise +``` + +Appium Protocol Command + +Get the given app status on the device + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `appId` | `string` | + +#### Returns + +`Promise`\<`number`\> + +#### Ref + +https://appium.github.io/appium.io/docs/en/commands/device/app/app-state/ + +#### Inherited from + +`ProtocolCommands.queryAppState` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/appium.d.ts:186 + +*** + +### ~~queryGrid()~~ + +```ts +queryGrid(query): Promise +``` + +Selenium Protocol Command + +Send GraphQL queries to the Selenium (hub or node) server to fetch data. (Only supported with Selenium v4 Server) + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `query` | `string` | + +#### Returns + +`Promise`\<`ProtocolCommandResponse`\> + +#### Ref + +https://www.selenium.dev/documentation/grid/advanced_features/graphql_support/ + +#### Example + +```js +const result = await browser.queryGrid('{ nodesInfo { nodes { status, uri } } }'); +console.log(JSON.stringify(result, null, 4)) +// +// outputs: +// { +// "data": { +// "nodesInfo": { +// "nodes": [{ +// "status": "UP", +// "uri": "http://192.168.0.39:4444" +// }] +// } +// } +// } +// +``` + +#### Inherited from + +`ProtocolCommands.queryGrid` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/selenium.d.ts:92 + +*** + +### ~~rawListeners()~~ + +```ts +rawListeners(eventName): Function[] +``` + +Returns a copy of the array of listeners for the event named `eventName`, +including any wrappers (such as those created by `.once()`). + +```js +const emitter = new EventEmitter(); +emitter.once('log', () => console.log('log once')); + +// Returns a new Array with a function `onceWrapper` which has a property +// `listener` which contains the original listener bound above +const listeners = emitter.rawListeners('log'); +const logFnWrapper = listeners[0]; + +// Logs "log once" to the console and does not unbind the `once` event +logFnWrapper.listener(); + +// Logs "log once" to the console and removes the listener +logFnWrapper(); + +emitter.on('log', () => console.log('log persistently')); +// Will return a new Array with a single function bound by `.on()` above +const newListeners = emitter.rawListeners('log'); + +// Logs "log persistently" twice +newListeners[0](); +emitter.emit('log'); +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `eventName` | `string` \| `symbol` | + +#### Returns + +`Function`[] + +#### Since + +v9.4.0 + +#### Inherited from + +`Omit.rawListeners` + +#### Defined in + +testplane/node\_modules/@types/node/events.d.ts:690 + +*** + +### ~~receiveAsyncResponse()~~ + +```ts +receiveAsyncResponse(response): Promise +``` + +Appium Protocol Command + +Callback url for asynchronous execution of JavaScript. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `response` | `object` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://github.com/appium/appium-base-driver/blob/master/docs/mjsonwp/protocol-methods.md#appium-extension-endpoints + +#### Inherited from + +`ProtocolCommands.receiveAsyncResponse` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/appium.d.ts:405 + +*** + +### ~~refresh()~~ + +```ts +refresh(): Promise +``` + +Webdriver Protocol Command + +The Refresh command causes the browser to reload the page in current top-level browsing context. + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://w3c.github.io/webdriver/#dfn-refresh + +#### Inherited from + +`ProtocolCommands.refresh` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:82 + +*** + +### ~~releaseActions()~~ + +```ts +releaseActions(): Promise +``` + +Webdriver Protocol Command + +The Release Actions command is used to release all the keys and pointer buttons that are currently depressed. This causes events to be fired as if the state was released by an explicit series of actions. It also clears all the internal state of the virtual devices. + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://w3c.github.io/webdriver/#dfn-release-actions + +#### Inherited from + +`ProtocolCommands.releaseActions` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:434 + +*** + +### ~~removeAllCredentials()~~ + +```ts +removeAllCredentials(authenticatorId): Promise +``` + +Webdriver Protocol Command + +Removes all Public Key Credential Sources stored on a Virtual Authenticator. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `authenticatorId` | `string` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://www.w3.org/TR/webauthn-2/#sctn-automation-remove-all-credentials + +#### Inherited from + +`ProtocolCommands.removeAllCredentials` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:609 + +*** + +### ~~removeAllListeners()~~ + +```ts +removeAllListeners(event?): this +``` + +Removes all listeners, or those of the specified `eventName`. + +It is bad practice to remove listeners added elsewhere in the code, +particularly when the `EventEmitter` instance was created by some other +component or module (e.g. sockets or file streams). + +Returns a reference to the `EventEmitter`, so that calls can be chained. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `event`? | `string` \| `symbol` | + +#### Returns + +`this` + +#### Since + +v0.1.26 + +#### Inherited from + +`Omit.removeAllListeners` + +#### Defined in + +testplane/node\_modules/@types/node/events.d.ts:631 + +*** + +### ~~removeApp()~~ + +```ts +removeApp(appId): Promise +``` + +Appium Protocol Command + +Remove an app from the device. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `appId` | `string` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://appium.github.io/appium.io/docs/en/commands/device/app/remove-app/ + +#### Inherited from + +`ProtocolCommands.removeApp` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/appium.d.ts:162 + +*** + +### ~~removeCredential()~~ + +```ts +removeCredential(authenticatorId, credentialId): Promise +``` + +Webdriver Protocol Command + +Removes a Public Key Credential Source stored on a Virtual Authenticator. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `authenticatorId` | `string` | +| `credentialId` | `string` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://www.w3.org/TR/webauthn-2/#sctn-automation-remove-credential + +#### Inherited from + +`ProtocolCommands.removeCredential` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:617 + +*** + +### ~~removeListener()~~ + +```ts +removeListener(eventName, listener): this +``` + +Removes the specified `listener` from the listener array for the event named`eventName`. + +```js +const callback = (stream) => { + console.log('someone connected!'); +}; +server.on('connection', callback); +// ... +server.removeListener('connection', callback); +``` + +`removeListener()` will remove, at most, one instance of a listener from the +listener array. If any single listener has been added multiple times to the +listener array for the specified `eventName`, then `removeListener()` must be +called multiple times to remove each instance. + +Once an event is emitted, all listeners attached to it at the +time of emitting are called in order. This implies that any`removeListener()` or `removeAllListeners()` calls _after_ emitting and _before_ the last listener finishes execution +will not remove them from`emit()` in progress. Subsequent events behave as expected. + +```js +const myEmitter = new MyEmitter(); + +const callbackA = () => { + console.log('A'); + myEmitter.removeListener('event', callbackB); +}; + +const callbackB = () => { + console.log('B'); +}; + +myEmitter.on('event', callbackA); + +myEmitter.on('event', callbackB); + +// callbackA removes listener callbackB but it will still be called. +// Internal listener array at time of emit [callbackA, callbackB] +myEmitter.emit('event'); +// Prints: +// A +// B + +// callbackB is now removed. +// Internal listener array [callbackA] +myEmitter.emit('event'); +// Prints: +// A +``` + +Because listeners are managed using an internal array, calling this will +change the position indices of any listener registered _after_ the listener +being removed. This will not impact the order in which listeners are called, +but it means that any copies of the listener array as returned by +the `emitter.listeners()` method will need to be recreated. + +When a single function has been added as a handler multiple times for a single +event (as in the example below), `removeListener()` will remove the most +recently added instance. In the example the `once('ping')`listener is removed: + +```js +const ee = new EventEmitter(); + +function pong() { + console.log('pong'); +} + +ee.on('ping', pong); +ee.once('ping', pong); +ee.removeListener('ping', pong); + +ee.emit('ping'); +ee.emit('ping'); +``` + +Returns a reference to the `EventEmitter`, so that calls can be chained. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `eventName` | `string` \| `symbol` | +| `listener` | (...`args`) => `void` | + +#### Returns + +`this` + +#### Since + +v0.1.26 + +#### Inherited from + +`Omit.removeListener` + +#### Defined in + +testplane/node\_modules/@types/node/events.d.ts:615 + +*** + +### ~~removeVirtualAuthenticator()~~ + +```ts +removeVirtualAuthenticator(authenticatorId): Promise +``` + +Webdriver Protocol Command + +Removes a previously created Virtual Authenticator. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `authenticatorId` | `string` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://www.w3.org/TR/webauthn-2/#sctn-automation-remove-virtual-authenticator + +#### Inherited from + +`ProtocolCommands.removeVirtualAuthenticator` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:585 + +*** + +### ~~replaceValue()~~ + +```ts +replaceValue(elementId, value): Promise +``` + +Appium Protocol Command + +Replace the value to element directly. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `elementId` | `string` | +| `value` | `string` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://github.com/appium/appium-base-driver/blob/master/docs/mjsonwp/protocol-methods.md#appium-extension-endpoints + +#### Inherited from + +`ProtocolCommands.replaceValue` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/appium.d.ts:381 + +*** + +### ~~respondMock()~~ + +```ts +respondMock(mockId, payload): Promise +``` + +Saucelabs Protocol Command + +Respond if mock matches a specific resource. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `mockId` | `string` | +| `payload` | `object` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://wiki.saucelabs.com/display/DOCS/Custom+Sauce+Labs+WebDriver+Extensions+for+Network+and+Log+Commands + +#### Inherited from + +`ProtocolCommands.respondMock` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/saucelabs.d.ts:193 + +*** + +### ~~resume()~~ + +```ts +resume(): Promise +``` + +Chromium Protocol Command + +Resume the current page. Extension for [Page Lifecycle API](https://developers.google.com/web/updates/2018/07/page-lifecycle-api). + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://github.com/bayandin/chromedriver/blob/v2.45/window_commands.cc#L635-L645 + +#### Inherited from + +`ProtocolCommands.resume` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/chromium.d.ts:244 + +*** + +### ~~rotateDevice()~~ + +```ts +rotateDevice( + x, + y, +z): Promise +``` + +Appium Protocol Command + +Rotate the device in three dimensions. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `x` | `number` | +| `y` | `number` | +| `z` | `number` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://github.com/SeleniumHQ/mobile-spec/blob/master/spec-draft.md#device-rotation + +#### Inherited from + +`ProtocolCommands.rotateDevice` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/appium.d.ts:122 + +*** + +### ~~sauceThrottleNetwork()~~ + +```ts +sauceThrottleNetwork(condition): Promise +``` + +Saucelabs Protocol Command + +With network conditioning you can test your site on a variety of network connections, including Edge, 3G, and even offline. You can throttle the data throughput, including the maximum download and upload throughput, and use latency manipulation to enforce a minimum delay in connection round-trip time (RTT). + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `condition` | `string` \| `object` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://wiki.saucelabs.com/display/DOCS/Custom+Sauce+Labs+WebDriver+Extensions+for+Network+and+Log+Commands#CustomSauceLabsWebDriverExtensionsforNetworkandLogCommands-ThrottleNetworkCapabilities + +#### Examples + +```js +// predefined network condition +browser.sauceThrottleNetwork('offline') +```* + +```js +// custom network condition +browser.sauceThrottleNetwork({ + download: 1000, + upload: 500, + latency: 40' +}) +``` + +#### Inherited from + +`ProtocolCommands.sauceThrottleNetwork` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/saucelabs.d.ts:70 + +*** + +### ~~scriptAddPreloadScript()~~ + +```ts +scriptAddPreloadScript(params): Promise +``` + +WebDriver Bidi command to send command method "script.addPreloadScript" with parameters. + +#### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `params` | `ScriptAddPreloadScriptParameters` | `remote.ScriptAddPreloadScriptParameters` [command parameter](https://w3c.github.io/webdriver-bidi/#command-script-addPreloadScript) | + +#### Returns + +`Promise`\<`ScriptAddPreloadScriptResult`\> + +`Promise` + +#### Url + +https://w3c.github.io/webdriver-bidi/#command-script-addPreloadScript + +#### Inherited from + +`BidiHandler.scriptAddPreloadScript` + +#### Defined in + +testplane/node\_modules/webdriver/build/bidi/handler.d.ts:200 + +*** + +### ~~scriptCallFunction()~~ + +```ts +scriptCallFunction(params): Promise +``` + +WebDriver Bidi command to send command method "script.callFunction" with parameters. + +#### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `params` | `ScriptCallFunctionParameters` | `remote.ScriptCallFunctionParameters` [command parameter](https://w3c.github.io/webdriver-bidi/#command-script-callFunction) | + +#### Returns + +`Promise`\<`EmptyResult`\> + +`Promise` + +#### Url + +https://w3c.github.io/webdriver-bidi/#command-script-callFunction + +#### Inherited from + +`BidiHandler.scriptCallFunction` + +#### Defined in + +testplane/node\_modules/webdriver/build/bidi/handler.d.ts:214 + +*** + +### ~~scriptDisown()~~ + +```ts +scriptDisown(params): Promise +``` + +WebDriver Bidi command to send command method "script.disown" with parameters. + +#### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `params` | `ScriptDisownParameters` | `remote.ScriptDisownParameters` [command parameter](https://w3c.github.io/webdriver-bidi/#command-script-disown) | + +#### Returns + +`Promise`\<`EmptyResult`\> + +`Promise` + +#### Url + +https://w3c.github.io/webdriver-bidi/#command-script-disown + +#### Inherited from + +`BidiHandler.scriptDisown` + +#### Defined in + +testplane/node\_modules/webdriver/build/bidi/handler.d.ts:207 + +*** + +### ~~scriptEvaluate()~~ + +```ts +scriptEvaluate(params): Promise +``` + +WebDriver Bidi command to send command method "script.evaluate" with parameters. + +#### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `params` | `ScriptEvaluateParameters` | `remote.ScriptEvaluateParameters` [command parameter](https://w3c.github.io/webdriver-bidi/#command-script-evaluate) | + +#### Returns + +`Promise`\<`ScriptEvaluateResult`\> + +`Promise` + +#### Url + +https://w3c.github.io/webdriver-bidi/#command-script-evaluate + +#### Inherited from + +`BidiHandler.scriptEvaluate` + +#### Defined in + +testplane/node\_modules/webdriver/build/bidi/handler.d.ts:221 + +*** + +### ~~scriptGetRealms()~~ + +```ts +scriptGetRealms(params): Promise +``` + +WebDriver Bidi command to send command method "script.getRealms" with parameters. + +#### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `params` | `ScriptGetRealmsParameters` | `remote.ScriptGetRealmsParameters` [command parameter](https://w3c.github.io/webdriver-bidi/#command-script-getRealms) | + +#### Returns + +`Promise`\<`ScriptGetRealmsResult`\> + +`Promise` + +#### Url + +https://w3c.github.io/webdriver-bidi/#command-script-getRealms + +#### Inherited from + +`BidiHandler.scriptGetRealms` + +#### Defined in + +testplane/node\_modules/webdriver/build/bidi/handler.d.ts:228 + +*** + +### ~~scriptRemovePreloadScript()~~ + +```ts +scriptRemovePreloadScript(params): Promise +``` + +WebDriver Bidi command to send command method "script.removePreloadScript" with parameters. + +#### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `params` | `ScriptRemovePreloadScriptParameters` | `remote.ScriptRemovePreloadScriptParameters` [command parameter](https://w3c.github.io/webdriver-bidi/#command-script-removePreloadScript) | + +#### Returns + +`Promise`\<`EmptyResult`\> + +`Promise` + +#### Url + +https://w3c.github.io/webdriver-bidi/#command-script-removePreloadScript + +#### Inherited from + +`BidiHandler.scriptRemovePreloadScript` + +#### Defined in + +testplane/node\_modules/webdriver/build/bidi/handler.d.ts:235 + +*** + +### ~~selectCastSink()~~ + +```ts +selectCastSink(sinkName): Promise +``` + +Chromium Protocol Command + +Selects a cast sink (Cast device) as the recipient of media router intents (connect or play). + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `sinkName` | `string` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://chromium.googlesource.com/chromium/src/+/refs/tags/73.0.3683.121/chrome/test/chromedriver/server/http_handler.cc#737 + +#### Inherited from + +`ProtocolCommands.selectCastSink` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/chromium.d.ts:260 + +*** + +### ~~send()~~ + +```ts +send(params): Promise +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `params` | `Omit`\<`CommandData`, `"id"`\> | + +#### Returns + +`Promise`\<`CommandResponse`\> + +#### Inherited from + +`BidiHandler.send` + +#### Defined in + +testplane/node\_modules/webdriver/build/bidi/core.d.ts:13 + +*** + +### ~~sendAlertText()~~ + +```ts +sendAlertText(text): Promise +``` + +Webdriver Protocol Command + +The Send Alert Text command sets the text field of a window.prompt user prompt to the given value. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `text` | `string` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://w3c.github.io/webdriver/#dfn-send-alert-text + +#### Inherited from + +`ProtocolCommands.sendAlertText` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:466 + +*** + +### ~~sendAsync()~~ + +```ts +sendAsync(params): number +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `params` | `Omit`\<`CommandData`, `"id"`\> | + +#### Returns + +`number` + +#### Inherited from + +`BidiHandler.sendAsync` + +#### Defined in + +testplane/node\_modules/webdriver/build/bidi/core.d.ts:14 + +*** + +### ~~sendCommand()~~ + +```ts +sendCommand(cmd, params): Promise +``` + +Chromium Protocol Command + +Send a command to the DevTools debugger.
For a list of available commands and their parameters refer to the [Chrome DevTools Protocol Viewer](https://chromedevtools.github.io/devtools-protocol/). + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `cmd` | `string` | +| `params` | `object` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://github.com/bayandin/chromedriver/blob/v2.45/window_commands.cc#L1290-L1304 + +#### Inherited from + +`ProtocolCommands.sendCommand` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/chromium.d.ts:163 + +*** + +### ~~sendCommandAndGetResult()~~ + +```ts +sendCommandAndGetResult(cmd, params): Promise +``` + +Chromium Protocol Command + +Send a command to the DevTools debugger and wait for the result.
For a list of available commands and their parameters refer to the [Chrome DevTools Protocol Viewer](https://chromedevtools.github.io/devtools-protocol/). + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `cmd` | `string` | +| `params` | `object` | + +#### Returns + +`Promise`\<`any`\> + +#### Ref + +https://github.com/bayandin/chromedriver/blob/v2.45/window_commands.cc#L1306-L1320 + +#### Inherited from + +`ProtocolCommands.sendCommandAndGetResult` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/chromium.d.ts:171 + +*** + +### ~~sendKeyEvent()~~ + +```ts +sendKeyEvent(keycode, metastate?): Promise +``` + +Appium Protocol Command + +Send a key code to the device. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `keycode` | `string` | +| `metastate`? | `string` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://github.com/appium/appium-base-driver/blob/master/docs/mjsonwp/protocol-methods.md#appium-extension-endpoints + +#### Inherited from + +`ProtocolCommands.sendKeyEvent` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/appium.d.ts:114 + +*** + +### ~~sendKeys()~~ + +```ts +sendKeys(value): Promise +``` + +Jsonwp Protocol Command + +No description available, please see reference link. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `value` | `string`[] | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidkeys + +#### Deprecated + +This command is deprecated and likely not supported by any browser. + +#### Inherited from + +`ProtocolCommands.sendKeys` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/jsonwp.d.ts:384 + +*** + +### ~~sendSms()~~ + +```ts +sendSms(phoneNumber, message): Promise +``` + +Appium Protocol Command + +Simulate an SMS message (Emulator only). + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `phoneNumber` | `string` | +| `message` | `string` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://appium.github.io/appium.io/docs/en/commands/device/network/send-sms/ + +#### Inherited from + +`ProtocolCommands.sendSms` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/appium.d.ts:453 + +*** + +### ~~sessionEnd()~~ + +```ts +sessionEnd(params): Promise +``` + +WebDriver Bidi command to send command method "session.end" with parameters. + +#### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `params` | `EmptyParams` | `remote.EmptyParams` [command parameter](https://w3c.github.io/webdriver-bidi/#command-session-end) | + +#### Returns + +`Promise`\<`EmptyResult`\> + +`Promise` + +#### Url + +https://w3c.github.io/webdriver-bidi/#command-session-end + +#### Inherited from + +`BidiHandler.sessionEnd` + +#### Defined in + +testplane/node\_modules/webdriver/build/bidi/handler.d.ts:39 + +*** + +### ~~sessionNew()~~ + +```ts +sessionNew(params): Promise +``` + +WebDriver Bidi command to send command method "session.new" with parameters. + +#### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `params` | `SessionNewParameters` | `remote.SessionNewParameters` [command parameter](https://w3c.github.io/webdriver-bidi/#command-session-new) | + +#### Returns + +`Promise`\<`SessionNewResult`\> + +`Promise` + +#### Url + +https://w3c.github.io/webdriver-bidi/#command-session-new + +#### Inherited from + +`BidiHandler.sessionNew` + +#### Defined in + +testplane/node\_modules/webdriver/build/bidi/handler.d.ts:32 + +*** + +### ~~sessionStatus()~~ + +```ts +sessionStatus(params): Promise +``` + +WebDriver Bidi command to send command method "session.status" with parameters. + +#### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `params` | `EmptyParams` | `remote.EmptyParams` [command parameter](https://w3c.github.io/webdriver-bidi/#command-session-status) | + +#### Returns + +`Promise`\<`SessionStatusResult`\> + +`Promise` + +#### Url + +https://w3c.github.io/webdriver-bidi/#command-session-status + +#### Inherited from + +`BidiHandler.sessionStatus` + +#### Defined in + +testplane/node\_modules/webdriver/build/bidi/handler.d.ts:25 + +*** + +### ~~sessionSubscribe()~~ + +```ts +sessionSubscribe(params): Promise +``` + +WebDriver Bidi command to send command method "session.subscribe" with parameters. + +#### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `params` | `SessionSubscriptionRequest` | `remote.SessionSubscriptionRequest` [command parameter](https://w3c.github.io/webdriver-bidi/#command-session-subscribe) | + +#### Returns + +`Promise`\<`EmptyResult`\> + +`Promise` + +#### Url + +https://w3c.github.io/webdriver-bidi/#command-session-subscribe + +#### Inherited from + +`BidiHandler.sessionSubscribe` + +#### Defined in + +testplane/node\_modules/webdriver/build/bidi/handler.d.ts:46 + +*** + +### ~~sessionUnsubscribe()~~ + +```ts +sessionUnsubscribe(params): Promise +``` + +WebDriver Bidi command to send command method "session.unsubscribe" with parameters. + +#### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `params` | `SessionSubscriptionRequest` | `remote.SessionSubscriptionRequest` [command parameter](https://w3c.github.io/webdriver-bidi/#command-session-unsubscribe) | + +#### Returns + +`Promise`\<`EmptyResult`\> + +`Promise` + +#### Url + +https://w3c.github.io/webdriver-bidi/#command-session-unsubscribe + +#### Inherited from + +`BidiHandler.sessionUnsubscribe` + +#### Defined in + +testplane/node\_modules/webdriver/build/bidi/handler.d.ts:53 + +*** + +### ~~setAsyncTimeout()~~ + +```ts +setAsyncTimeout(ms): Promise +``` + +Jsonwp Protocol Command + +Set the amount of time, in milliseconds, that asynchronous scripts executed by `/session/:sessionId/execute_async` are permitted to run before they are aborted and a `Timeout` error is returned to the client. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `ms` | `number` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidtimeoutsasync_script + +#### Deprecated + +This command is deprecated and likely not supported by any browser. Use the "setTimeouts" command instead! + +#### Inherited from + +`ProtocolCommands.setAsyncTimeout` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/jsonwp.d.ts:61 + +*** + +### ~~setAutoReporting()~~ + +```ts +setAutoReporting(enabled): Promise +``` + +Chromium Protocol Command + +Toggle whether to return response with unknown error with first browser error (e.g. failed to load resource due to 403/404 response) for all subsequent commands (once enabled). + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `enabled` | `boolean` | + +#### Returns + +`Promise`\<`null` \| `object`\> + +#### Ref + +https://codereview.chromium.org/101203012 + +#### Examples + +```js +// Enable auto reporting first thing after session was initiated with empty browser logs +console.log(browser.setAutoReporting(true)); // outputs: null +// Upon requesting an non-existing resource it will abort execution due to thrown unknown error +browser.url('https://webdriver.io/img/404-does-not-exist.png'); +```* + +```js +// During the session do some operations which populate the browser logs +browser.url('https://webdriver.io/img/404-does-not-exist.png'); +browser.url('https://webdriver.io/403/no-access'); +// Enable auto reporting which throws an unknown error for first browser log (404 response) +browser.setAutoReporting(true); +``` + +#### Inherited from + +`ProtocolCommands.setAutoReporting` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/chromium.d.ts:47 + +*** + +### ~~setClipboard()~~ + +```ts +setClipboard( + content, + contentType?, +label?): Promise +``` + +Appium Protocol Command + +Set the content of the system clipboard + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `content` | `string` | +| `contentType`? | `string` | +| `label`? | `string` | + +#### Returns + +`Promise`\<`string`\> + +#### Ref + +https://appium.github.io/appium.io/docs/en/commands/device/clipboard/set-clipboard/ + +#### Inherited from + +`ProtocolCommands.setClipboard` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/appium.d.ts:469 + +*** + +### ~~setGeoLocation()~~ + +```ts +setGeoLocation(location): Promise +``` + +Jsonwp Protocol Command + +Set the current geo location. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `location` | `object` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#post-sessionsessionidlocation + +#### Deprecated + +This command is deprecated and likely not supported by any browser. + +#### Inherited from + +`ProtocolCommands.setGeoLocation` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/jsonwp.d.ts:642 + +*** + +### ~~setImplicitTimeout()~~ + +```ts +setImplicitTimeout(ms): Promise +``` + +Jsonwp Protocol Command + +Set the amount of time the driver should wait when searching for elements. When searching for a single element, the driver should poll the page until an element is found or the timeout expires, whichever occurs first. When searching for multiple elements, the driver should poll the page until at least one element is found or the timeout expires, at which point it should return an empty list. If this command is never sent, the driver should default to an implicit wait of 0ms. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `ms` | `number` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidtimeoutsimplicit_wait + +#### Deprecated + +This command is deprecated and likely not supported by any browser. Use the "setTimeouts" command instead! + +#### Inherited from + +`ProtocolCommands.setImplicitTimeout` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/jsonwp.d.ts:70 + +*** + +### ~~setLocalStorage()~~ + +```ts +setLocalStorage(key, value): Promise +``` + +Jsonwp Protocol Command + +Set the storage item for the given key. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `key` | `string` | +| `value` | `string` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#post-sessionsessionidlocal_storage + +#### Deprecated + +This command is deprecated and likely not supported by any browser. Use the "execute" command instead to interact with the session storage interface! + +#### Inherited from + +`ProtocolCommands.setLocalStorage` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/jsonwp.d.ts:660 + +*** + +### ~~setMaxListeners()~~ + +```ts +setMaxListeners(n): this +``` + +By default `EventEmitter`s will print a warning if more than `10` listeners are +added for a particular event. This is a useful default that helps finding +memory leaks. The `emitter.setMaxListeners()` method allows the limit to be +modified for this specific `EventEmitter` instance. The value can be set to`Infinity` (or `0`) to indicate an unlimited number of listeners. + +Returns a reference to the `EventEmitter`, so that calls can be chained. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `n` | `number` | + +#### Returns + +`this` + +#### Since + +v0.3.5 + +#### Inherited from + +`Omit.setMaxListeners` + +#### Defined in + +testplane/node\_modules/@types/node/events.d.ts:641 + +*** + +### ~~setMozContext()~~ + +```ts +setMozContext(context): Promise +``` + +Gecko Protocol Command + +Changes target context for commands between chrome- and content.

Changing the current context has a stateful impact on all subsequent commands. The `CONTENT` context has normal web platform document permissions, as if you would evaluate arbitrary JavaScript. The `CHROME` context gets elevated permissions that lets you manipulate the browser chrome itself, with full access to the XUL toolkit. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `context` | `string` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://github.com/SeleniumHQ/selenium/blob/586affe0cf675b1d5c8abc756defa4a46d95391b/javascript/node/selenium-webdriver/firefox.js#L615-L645 + +#### Example + +```js +console.log(await browser.getMozContext()); // outputs: 'CHROME' +browser.setMozContext('CONTENT'); +console.log(await browser.getMozContext()); // outputs: 'CONTENT' +``` + +#### Inherited from + +`ProtocolCommands.setMozContext` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/gecko.d.ts:35 + +*** + +### ~~setNetworkConditions()~~ + +```ts +setNetworkConditions(networkConditions, networkName?): Promise +``` + +Chromium Protocol Command + +Set network conditions used for emulation by throttling connection. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `networkConditions` | `object` | +| `networkName`? | `string` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://github.com/bayandin/chromedriver/blob/v2.45/window_commands.cc#L1663-L1722 + +#### Examples + +```js +// Use different download (25kb/s) and upload (50kb/s) throughput values for throttling with a latency of 1000ms +browser.setNetworkConditions({ latency: 1000, download_throughput: 25600, upload_throughput: 51200 }); +```* + +```js +// Force disconnected from network by setting 'offline' to true +browser.setNetworkConditions({ latency: 0, throughput: 0, offline: true }); +```* + +```js +// When preset name (e.g. 'DSL') is specified it does not respect values in object (e.g. 'offline') +browser.setNetworkConditions({ latency: 0, throughput: 0, offline: true }, 'DSL'); +```* + +```js +// Best practice for specifying network throttling preset is to use an empty object +browser.setNetworkConditions({}, 'Good 3G'); +``` + +#### Inherited from + +`ProtocolCommands.setNetworkConditions` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/chromium.d.ts:147 + +*** + +### ~~setNetworkConnection()~~ + +```ts +setNetworkConnection(parameters): Promise +``` + +Chromium Protocol Command + +Change connection type for network connection. This command is only applicable when remote end replies with `networkConnectionEnabled` capability set to `true`. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `parameters` | `object` | + +#### Returns + +`Promise`\<`number`\> + +#### Ref + +https://github.com/SeleniumHQ/mobile-spec/blob/master/spec-draft.md#device-modes + +#### Example + +```js +const browser = remote({ + capabilities: { + browserName: 'chrome', + 'goog:chromeOptions': { + // Network emulation requires device mode, which is only enabled when mobile emulation is on + mobileEmulation: { deviceName: 'iPad' }, + }, + } +}); +console.log(browser.setNetworkConnection({ type: 1 })); // outputs: 1 (Airplane Mode) +``` + +#### Inherited from + +`ProtocolCommands.setNetworkConnection` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/chromium.d.ts:111 + +*** + +### ~~setOrientation()~~ + +```ts +setOrientation(orientation): Promise +``` + +Jsonwp Protocol Command + +No description available, please see reference link. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `orientation` | `string` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#post-sessionsessionidorientation + +#### Deprecated + +This command is deprecated and likely not supported by any browser. + +#### Inherited from + +`ProtocolCommands.setOrientation` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/jsonwp.d.ts:543 + +*** + +### ~~setPermissions()~~ + +```ts +setPermissions( + descriptor, + state, +oneRealm?): Promise +``` + +Webdriver Protocol Command + +Simulates user modification of a PermissionDescriptor's permission state. __Note:__ this feature has not landed in all browsers yet. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `descriptor` | `object` | +| `state` | `string` | +| `oneRealm`? | `boolean` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://w3c.github.io/permissions/#set-permission-command + +#### Examples + +```js +// set midi permissions +browser.setPermissions( + { name: 'midi', sysex: true }, + 'granted' // can be also "denied" or "prompt" +); +```* + +```js +// set clipboard permissions +browser.setPermissions({ name: 'clipboard-read' }, 'granted'); +// now you can read the clipboard via, e.g. +const clipboardText = await browser.execute(() => navigator.clipboard.readText()); +``` + +#### Inherited from + +`ProtocolCommands.setPermissions` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:521 + +*** + +### ~~setSessionStorage()~~ + +```ts +setSessionStorage(key, value): Promise +``` + +Jsonwp Protocol Command + +Set the storage item for the given key. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `key` | `string` | +| `value` | `string` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#post-sessionsessionidsession_storage + +#### Deprecated + +This command is deprecated and likely not supported by any browser. Use the "execute" command instead to interact with the session storage interface! + +#### Inherited from + +`ProtocolCommands.setSessionStorage` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/jsonwp.d.ts:714 + +*** + +### ~~setTimeZone()~~ + +```ts +setTimeZone(timeZone): Promise +``` + +Webdriver Protocol Command + +Simulates the changing of a time zone for the purposes of testing. __Note:__ this feature has not landed in all browsers yet. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `timeZone` | `string` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://w3c.github.io/sensors/#create-mock-sensor-command + +#### Inherited from + +`ProtocolCommands.setTimeZone` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:569 + +*** + +### ~~setTimeouts()~~ + +```ts +setTimeouts( + implicit?, + pageLoad?, +script?): Promise +``` + +Webdriver Protocol Command + +The Set Timeouts command sets timeout durations associated with the current session. The timeouts that can be controlled are listed in the table of session timeouts below. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `implicit`? | `number` | +| `pageLoad`? | `number` | +| `script`? | `number` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://w3c.github.io/webdriver/#dfn-set-timeouts + +#### Inherited from + +`ProtocolCommands.setTimeouts` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:42 + +*** + +### ~~setUserVerified()~~ + +```ts +setUserVerified(authenticatorId): Promise +``` + +Webdriver Protocol Command + +The Set User Verified extension command sets the isUserVerified property on the Virtual Authenticator. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `authenticatorId` | `string` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://www.w3.org/TR/webauthn-2/#sctn-automation-set-user-verified + +#### Inherited from + +`ProtocolCommands.setUserVerified` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:625 + +*** + +### ~~setValueImmediate()~~ + +```ts +setValueImmediate(elementId, text): Promise +``` + +Appium Protocol Command + +No description available, please see reference link. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `elementId` | `string` | +| `text` | `string` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://github.com/appium/appium-base-driver/blob/master/docs/mjsonwp/protocol-methods.md#appium-extension-endpoints + +#### Inherited from + +`ProtocolCommands.setValueImmediate` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/appium.d.ts:373 + +*** + +### ~~setWindowPosition()~~ + +```ts +setWindowPosition(x, y): Promise +``` + +Jsonwp Protocol Command + +Change the position of the current focussed window. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `x` | `number` | +| `y` | `number` | + +#### Returns + +`Promise`\<`ProtocolCommandResponse`\> + +#### Ref + +https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#post-sessionsessionidwindowwindowhandleposition + +#### Deprecated + +This command is deprecated and likely not supported by any browser. + +#### Inherited from + +`ProtocolCommands.setWindowPosition` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/jsonwp.d.ts:184 + +*** + +### ~~setWindowRect()~~ + +```ts +setWindowRect( + x, + y, + width, +height): Promise +``` + +Webdriver Protocol Command + +The Set Window Rect command alters the size and the position of the operating system window corresponding to the current top-level browsing context. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `x` | `null` \| `number` | +| `y` | `null` \| `number` | +| `width` | `null` \| `number` | +| `height` | `null` \| `number` | + +#### Returns + +`Promise`\<`RectReturn`\> + +#### Ref + +https://w3c.github.io/webdriver/#dfn-set-window-rect + +#### Inherited from + +`ProtocolCommands.setWindowRect` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:170 + +*** + +### ~~shake()~~ + +```ts +shake(): Promise +``` + +Appium Protocol Command + +Perform a shake action on the device. + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://appium.github.io/appium.io/docs/en/commands/device/interactions/shake/ + +#### Inherited from + +`ProtocolCommands.shake` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/appium.d.ts:34 + +*** + +### ~~shutdown()~~ + +```ts +shutdown(): Promise +``` + +Chromium Protocol Command + +Shutdown ChromeDriver process and consequently terminating all active sessions. + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://github.com/bayandin/chromedriver/blob/v2.45/session_commands.cc#L489-L498 + +#### Inherited from + +`ProtocolCommands.shutdown` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/chromium.d.ts:292 + +*** + +### ~~startActivity()~~ + +```ts +startActivity( + appPackage, + appActivity, + appWaitPackage?, + appWaitActivity?, + intentAction?, + intentCategory?, + intentFlags?, + optionalIntentArguments?, +dontStopAppOnReset?): Promise +``` + +Appium Protocol Command + +Start an Android activity by providing package name and activity name. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `appPackage` | `string` | +| `appActivity` | `string` | +| `appWaitPackage`? | `string` | +| `appWaitActivity`? | `string` | +| `intentAction`? | `string` | +| `intentCategory`? | `string` | +| `intentFlags`? | `string` | +| `optionalIntentArguments`? | `string` | +| `dontStopAppOnReset`? | `string` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://appium.github.io/appium.io/docs/en/commands/device/activity/start-activity/ + +#### Inherited from + +`ProtocolCommands.startActivity` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/appium.d.ts:282 + +*** + +### ~~startCastTabMirroring()~~ + +```ts +startCastTabMirroring(sinkName): Promise +``` + +Chromium Protocol Command + +Initiates tab mirroring for the current browser tab on the specified device. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `sinkName` | `string` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://chromium.googlesource.com/chromium/src/+/refs/tags/73.0.3683.121/chrome/test/chromedriver/server/http_handler.cc#741 + +#### Inherited from + +`ProtocolCommands.startCastTabMirroring` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/chromium.d.ts:268 + +*** + +### ~~startRecordingScreen()~~ + +```ts +startRecordingScreen(options?): Promise +``` + +Appium Protocol Command + +Start recording the screen. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `options`? | `object` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://appium.github.io/appium.io/docs/en/commands/device/recording-screen/start-recording-screen/ + +#### Inherited from + +`ProtocolCommands.startRecordingScreen` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/appium.d.ts:66 + +*** + +### ~~status()~~ + +```ts +status(): Promise +``` + +Webdriver Protocol Command + +The Status command returns information about whether a remote end is in a state in which it can create new sessions and can additionally include arbitrary meta information that is specific to the implementation. + +#### Returns + +`Promise`\<`StatusReturn`\> + +#### Ref + +https://w3c.github.io/webdriver/#dfn-status + +#### Inherited from + +`ProtocolCommands.status` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:26 + +*** + +### ~~stopCasting()~~ + +```ts +stopCasting(sinkName): Promise +``` + +Chromium Protocol Command + +Stops casting from media router to the specified device, if connected. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `sinkName` | `string` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://chromium.googlesource.com/chromium/src/+/refs/tags/73.0.3683.121/chrome/test/chromedriver/server/http_handler.cc#744 + +#### Inherited from + +`ProtocolCommands.stopCasting` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/chromium.d.ts:284 + +*** + +### ~~stopRecordingScreen()~~ + +```ts +stopRecordingScreen( + remotePath?, + username?, + password?, +method?): Promise +``` + +Appium Protocol Command + +Stop recording screen + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `remotePath`? | `string` | +| `username`? | `string` | +| `password`? | `string` | +| `method`? | `string` | + +#### Returns + +`Promise`\<`string`\> + +#### Ref + +https://appium.github.io/appium.io/docs/en/commands/device/recording-screen/stop-recording-screen/ + +#### Inherited from + +`ProtocolCommands.stopRecordingScreen` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/appium.d.ts:74 + +*** + +### ~~switchContext()~~ + +```ts +switchContext(name): Promise +``` + +Appium Protocol Command + +No description available, please see reference link. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `name` | `string` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://github.com/SeleniumHQ/mobile-spec/blob/master/spec-draft.md#webviews-and-other-contexts + +#### Inherited from + +`ProtocolCommands.switchContext` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/appium.d.ts:18 + +*** + +### ~~switchToFrame()~~ + +```ts +switchToFrame(id): Promise +``` + +Webdriver Protocol Command + +The Switch To Frame command is used to select the current top-level browsing context or a child browsing context of the current browsing context to use as the current browsing context for subsequent commands. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `id` | `null` \| `number` \| `object` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://w3c.github.io/webdriver/#dfn-switch-to-frame + +#### Inherited from + +`ProtocolCommands.switchToFrame` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:146 + +*** + +### ~~switchToParentFrame()~~ + +```ts +switchToParentFrame(): Promise +``` + +Webdriver Protocol Command + +The Switch to Parent Frame command sets the current browsing context for future commands to the parent of the current browsing context. + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://w3c.github.io/webdriver/#dfn-switch-to-parent-frame + +#### Inherited from + +`ProtocolCommands.switchToParentFrame` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:154 + +*** + +### ~~switchToWindow()~~ + +```ts +switchToWindow(handle): Promise +``` + +Webdriver Protocol Command + +The Switch To Window command is used to select the current top-level browsing context for the current session, i.e. the one that will be used for processing commands. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `handle` | `string` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://w3c.github.io/webdriver/#dfn-switch-to-window + +#### Inherited from + +`ProtocolCommands.switchToWindow` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:114 + +*** + +### ~~takeElementScreenshot()~~ + +```ts +takeElementScreenshot(elementId, scroll?): Promise +``` + +Webdriver Protocol Command + +The Take Element Screenshot command takes a screenshot of the visible region encompassed by the bounding rectangle of an element. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `elementId` | `string` | +| `scroll`? | `boolean` | + +#### Returns + +`Promise`\<`string`\> + +#### Ref + +https://w3c.github.io/webdriver/#dfn-take-element-screenshot + +#### Inherited from + +`ProtocolCommands.takeElementScreenshot` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:482 + +*** + +### ~~takeHeapSnapshot()~~ + +```ts +takeHeapSnapshot(): Promise +``` + +Chromium Protocol Command + +Takes a heap snapshot of the current execution context. + +#### Returns + +`Promise`\<`ProtocolCommandResponse`\> + +#### Ref + +https://github.com/bayandin/chromedriver/blob/v2.45/chrome/web_view.h#L198-L202 + +#### Inherited from + +`ProtocolCommands.takeHeapSnapshot` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/chromium.d.ts:69 + +*** + +### ~~takeScreenshot()~~ + +```ts +takeScreenshot(): Promise +``` + +Webdriver Protocol Command + +The Take Screenshot command takes a screenshot of the top-level browsing context's viewport. + +#### Returns + +`Promise`\<`string`\> + +#### Ref + +https://w3c.github.io/webdriver/#dfn-take-screenshot + +#### Inherited from + +`ProtocolCommands.takeScreenshot` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:474 + +*** + +### ~~terminateApp()~~ + +```ts +terminateApp(appId): Promise +``` + +Appium Protocol Command + +Terminate the given app on the device + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `appId` | `string` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://appium.github.io/appium.io/docs/en/commands/device/app/terminate-app/ + +#### Inherited from + +`ProtocolCommands.terminateApp` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/appium.d.ts:170 + +*** + +### ~~throttleCPU()~~ + +```ts +throttleCPU(rate): Promise +``` + +Saucelabs Protocol Command + +You can throttle the CPU in DevTools to understand how your page performs under that constraint. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `rate` | `number` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://wiki.saucelabs.com/display/DOCS/Custom+Sauce+Labs+WebDriver+Extensions+for+Network+and+Log+Commands#CustomSauceLabsWebDriverExtensionsforNetworkandLogCommands-ThrottleCPUCapabilities + +#### Examples + +```js +// throttle CPU and make it run 4x slower +browser.throttleCPU(4) +```* + +```js +// reset CPU throttling +browser.throttleCPU(0) +``` + +#### Inherited from + +`ProtocolCommands.throttleCPU` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/saucelabs.d.ts:88 + +*** + +### ~~toggleAirplaneMode()~~ + +```ts +toggleAirplaneMode(): Promise +``` + +Appium Protocol Command + +Toggle airplane mode on device. + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://appium.github.io/appium.io/docs/en/commands/device/network/toggle-airplane-mode/ + +#### Inherited from + +`ProtocolCommands.toggleAirplaneMode` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/appium.d.ts:234 + +*** + +### ~~toggleData()~~ + +```ts +toggleData(): Promise +``` + +Appium Protocol Command + +Switch the state of data service. + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://appium.github.io/appium.io/docs/en/commands/device/network/toggle-data/ + +#### Inherited from + +`ProtocolCommands.toggleData` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/appium.d.ts:242 + +*** + +### ~~toggleEnrollTouchId()~~ + +```ts +toggleEnrollTouchId(enabled?): Promise +``` + +Appium Protocol Command + +Toggle the simulator being [enrolled](https://support.apple.com/en-ca/ht201371) to accept touchId (iOS Simulator only). To enable this feature, the `allowTouchIdEnroll` desired capability must be set to true. When `allowTouchIdEnroll` is set to true the Simulator will be enrolled by default, and the 'Toggle Touch ID Enrollment' changes the enrollment state. This call will only work if the Appium process or its parent application (e.g., Terminal.app or Appium.app) has access to Mac OS accessibility in System Preferences > Security & Privacy > Privacy > Accessibility list. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `enabled`? | `boolean` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://appium.github.io/appium.io/docs/en/commands/device/simulator/toggle-touch-id-enrollment/ + +#### Inherited from + +`ProtocolCommands.toggleEnrollTouchId` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/appium.d.ts:322 + +*** + +### ~~toggleLocationServices()~~ + +```ts +toggleLocationServices(): Promise +``` + +Appium Protocol Command + +Switch the state of the location service. + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://appium.github.io/appium.io/docs/en/commands/device/network/toggle-location-services/ + +#### Inherited from + +`ProtocolCommands.toggleLocationServices` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/appium.d.ts:258 + +*** + +### ~~toggleNetworkSpeed()~~ + +```ts +toggleNetworkSpeed(netspeed): Promise +``` + +Appium Protocol Command + +Set network speed (Emulator only) + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `netspeed` | `string` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://appium.github.io/appium.io/docs/en/commands/device/network/network-speed/ + +#### Inherited from + +`ProtocolCommands.toggleNetworkSpeed` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/appium.d.ts:266 + +*** + +### ~~toggleWiFi()~~ + +```ts +toggleWiFi(): Promise +``` + +Appium Protocol Command + +Switch the state of the wifi service. + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://appium.github.io/appium.io/docs/en/commands/device/network/toggle-wifi/ + +#### Inherited from + +`ProtocolCommands.toggleWiFi` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/appium.d.ts:250 + +*** + +### ~~touchClick()~~ + +```ts +touchClick(element): Promise +``` + +Jsonwp Protocol Command + +Single tap on the touch enabled device. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `element` | `string` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidtouchclick + +#### Deprecated + +This command is deprecated and likely not supported by any browser. Use the "action" command instead to execute a touch gesture! + +#### Inherited from + +`ProtocolCommands.touchClick` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/jsonwp.d.ts:597 + +*** + +### ~~touchDoubleClick()~~ + +```ts +touchDoubleClick(element): Promise +``` + +Jsonwp Protocol Command + +Double tap on the touch screen using finger motion events. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `element` | `string` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidtouchdoubleclick + +#### Deprecated + +This command is deprecated and likely not supported by any browser. Use the "action" command instead to execute a touch gesture! + +#### Inherited from + +`ProtocolCommands.touchDoubleClick` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/jsonwp.d.ts:615 + +*** + +### ~~touchFlick()~~ + +```ts +touchFlick( + xoffset?, + yoffset?, + element?, + speed?, + xspeed?, +yspeed?): Promise +``` + +Jsonwp Protocol Command + +Flick on the touch screen using finger motion events. This flickcommand starts at a particulat screen location. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `xoffset`? | `number` | +| `yoffset`? | `number` | +| `element`? | `string` | +| `speed`? | `number` | +| `xspeed`? | `number` | +| `yspeed`? | `number` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidtouchflick + +#### Deprecated + +This command is deprecated and likely not supported by any browser. Use the "action" command instead to execute a touch gesture! + +#### Inherited from + +`ProtocolCommands.touchFlick` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/jsonwp.d.ts:624 + +*** + +### ~~touchId()~~ + +```ts +touchId(match): Promise +``` + +Appium Protocol Command + +Simulate a [touch id](https://support.apple.com/en-ca/ht201371) event (iOS Simulator only). To enable this feature, the `allowTouchIdEnroll` desired capability must be set to true and the Simulator must be [enrolled](https://support.apple.com/en-ca/ht201371). When you set allowTouchIdEnroll to true, it will set the Simulator to be enrolled by default. The enrollment state can be [toggled](https://appium.github.io/appium.io/docs/en/commands/device/simulator/toggle-touch-id-enrollment/index.html). This call will only work if Appium process or its parent application (e.g. Terminal.app or Appium.app) has access to Mac OS accessibility in System Preferences > Security & Privacy > Privacy > Accessibility list. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `match` | `boolean` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://appium.github.io/appium.io/docs/en/commands/device/simulator/touch-id/ + +#### Inherited from + +`ProtocolCommands.touchId` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/appium.d.ts:314 + +*** + +### ~~touchPerform()~~ + +```ts +touchPerform(actions): Promise +``` + +Appium Protocol Command + +This functionality is only available from within a native context. 'Touch Perform' works similarly to the other singular touch interactions, except that this allows you to chain together more than one touch action as one command. This is useful because Appium commands are sent over the network and there's latency between commands. This latency can make certain touch interactions impossible because some interactions need to be performed in one sequence. Vertical, for example, requires pressing down, moving to a different y coordinate, and then releasing. For it to work, there can't be a delay between the interactions. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `actions` | `object`[] | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://appium.github.io/appium.io/docs/en/commands/interactions/touch/touch-perform/ + +#### Example + +```js +// do a horizontal swipe by percentage +const startPercentage = 10; +const endPercentage = 90; +const anchorPercentage = 50; + +const { width, height } = driver.getWindowSize(); +const anchor = height// anchorPercentage / 100; +const startPoint = width// startPercentage / 100; +const endPoint = width// endPercentage / 100; +driver.touchPerform([ + { + action: 'press', + options: { + x: startPoint, + y: anchor, + }, + }, + { + action: 'wait', + options: { + ms: 100, + }, + }, + { + action: 'moveTo', + options: { + x: endPoint, + y: anchor, + }, + }, + { + action: 'release', + options: {}, + }, +]); +``` + +#### Inherited from + +`ProtocolCommands.touchPerform` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/appium.d.ts:523 + +*** + +### ~~touchPinch()~~ + +```ts +touchPinch( + x, + y, +scale): Promise +``` + +Chromium Protocol Command + +Trigger a pinch zoom effect. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `x` | `number` | +| `y` | `number` | +| `scale` | `number` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://github.com/bayandin/chromedriver/blob/v2.45/window_commands.cc#L813-L827 + +#### Inherited from + +`ProtocolCommands.touchPinch` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/chromium.d.ts:228 + +*** + +### ~~touchScroll()~~ + +```ts +touchScroll( + xoffset, + yoffset, +element?): Promise +``` + +Jsonwp Protocol Command + +Finger move on the screen. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `xoffset` | `number` | +| `yoffset` | `number` | +| `element`? | `string` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidtouchscroll + +#### Deprecated + +This command is deprecated and likely not supported by any browser. Use the "action" command instead to execute a touch gesture! + +#### Inherited from + +`ProtocolCommands.touchScroll` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/jsonwp.d.ts:606 + +*** + +### ~~uninstallAddOn()~~ + +```ts +uninstallAddOn(id): Promise +``` + +Gecko Protocol Command + +Uninstalls an addon from the current browser session's profile. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `id` | `string` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://github.com/SeleniumHQ/selenium/blob/586affe0cf675b1d5c8abc756defa4a46d95391b/javascript/node/selenium-webdriver/firefox.js#L670-L687 + +#### Example + +```js +// Create a buffer of the add on .zip file +const extension = await fs.promises.readFile('/path/to/extension.zip') +// Load extension in Firefox +const id = await browser.installAddOn(extension.toString('base64'), false); +// ... +await browser.uninstallAddOn(id) +``` + +#### Inherited from + +`ProtocolCommands.uninstallAddOn` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/gecko.d.ts:67 + +*** + +### ~~unlock()~~ + +```ts +unlock(): Promise +``` + +Appium Protocol Command + +Unlock the device. + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://appium.github.io/appium.io/docs/en/commands/device/interactions/unlock/ + +#### Inherited from + +`ProtocolCommands.unlock` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/appium.d.ts:50 + +*** + +### ~~updateMockSensor()~~ + +```ts +updateMockSensor( + type, + mockSensorType, + maxSamplingFrequency, +minSamplingFrequency): Promise +``` + +Webdriver Protocol Command + +Updates the mock sensor type. __Note:__ this feature has not landed in all browsers yet. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `type` | `string` | +| `mockSensorType` | `string` | +| `maxSamplingFrequency` | `number` | +| `minSamplingFrequency` | `number` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://w3c.github.io/sensors/#update-mock-sensor-reading-command + +#### Inherited from + +`ProtocolCommands.updateMockSensor` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/webdriver.d.ts:553 + +*** + +### ~~updateSettings()~~ + +```ts +updateSettings(settings): Promise +``` + +Appium Protocol Command + +Update the current setting on the device. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `settings` | `object` | + +#### Returns + +`Promise`\<`void`\> + +#### Ref + +https://appium.github.io/appium.io/docs/en/commands/session/settings/update-settings/ + +#### Inherited from + +`ProtocolCommands.updateSettings` + +#### Defined in + +testplane/node\_modules/@wdio/protocols/build/commands/appium.d.ts:397 diff --git a/i18n/en/docusaurus-plugin-content-docs/current/api-reference/type-aliases/AssertViewResult.mdx b/i18n/en/docusaurus-plugin-content-docs/current/api-reference/type-aliases/AssertViewResult.mdx new file mode 100644 index 0000000..edd17d1 --- /dev/null +++ b/i18n/en/docusaurus-plugin-content-docs/current/api-reference/type-aliases/AssertViewResult.mdx @@ -0,0 +1,11 @@ +[testplane](../README.mdx) / AssertViewResult + +# Type Alias: AssertViewResult + +```ts +type AssertViewResult: AssertViewResultSuccess | AssertViewResultDiff | AssertViewResultNoRefImage; +``` + +## Defined in + +testplane-docs/.testplane/src/types/index.ts:105 diff --git a/i18n/en/docusaurus-plugin-content-docs/current/api-reference/type-aliases/AsyncSessionEventCallback.mdx b/i18n/en/docusaurus-plugin-content-docs/current/api-reference/type-aliases/AsyncSessionEventCallback.mdx new file mode 100644 index 0000000..2159c70 --- /dev/null +++ b/i18n/en/docusaurus-plugin-content-docs/current/api-reference/type-aliases/AsyncSessionEventCallback.mdx @@ -0,0 +1,22 @@ +[testplane](../README.mdx) / AsyncSessionEventCallback + +# Type Alias: AsyncSessionEventCallback() + +```ts +type AsyncSessionEventCallback: (browser, browserInfo) => Promise | void; +``` + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `browser` | `WebdriverIO.Browser` | +| `browserInfo` | [`BrowserInfo`](../interfaces/BrowserInfo.mdx) | + +## Returns + +`Promise`\<`void`\> \| `void` + +## Defined in + +testplane-docs/.testplane/src/types/index.ts:36 diff --git a/i18n/en/docusaurus-plugin-content-docs/current/api-reference/type-aliases/ConfigInput.mdx b/i18n/en/docusaurus-plugin-content-docs/current/api-reference/type-aliases/ConfigInput.mdx new file mode 100644 index 0000000..3b96785 --- /dev/null +++ b/i18n/en/docusaurus-plugin-content-docs/current/api-reference/type-aliases/ConfigInput.mdx @@ -0,0 +1,27 @@ +[testplane](../README.mdx) / ConfigInput + +# Type Alias: ConfigInput + +```ts +type ConfigInput: Partial & { + browsers: Record & { + desiredCapabilities: WebdriverIO.Capabilities; + }>; + plugins: Record; + prepareEnvironment: () => void | null; + sets: Record; +}; +``` + +## Type declaration + +| Name | Type | Defined in | +| ------ | ------ | ------ | +| `browsers` | `Record`\<`string`, `Partial`\<[`CommonConfig`](../interfaces/CommonConfig.mdx)\> & \{ `desiredCapabilities`: `WebdriverIO.Capabilities`; \}\> | testplane-docs/.testplane/src/config/types.ts:197 | +| `plugins` | `Record`\<`string`, `unknown`\> | testplane-docs/.testplane/src/config/types.ts:198 | +| `prepareEnvironment` | () => `void` \| `null` | testplane-docs/.testplane/src/config/types.ts:200 | +| `sets` | `Record`\<`string`, [`SetsConfig`](../interfaces/SetsConfig.mdx)\> | testplane-docs/.testplane/src/config/types.ts:199 | + +## Defined in + +testplane-docs/.testplane/src/config/types.ts:196 diff --git a/i18n/en/docusaurus-plugin-content-docs/current/api-reference/type-aliases/InterceptHandler.mdx b/i18n/en/docusaurus-plugin-content-docs/current/api-reference/type-aliases/InterceptHandler.mdx new file mode 100644 index 0000000..c64b1e7 --- /dev/null +++ b/i18n/en/docusaurus-plugin-content-docs/current/api-reference/type-aliases/InterceptHandler.mdx @@ -0,0 +1,21 @@ +[testplane](../README.mdx) / InterceptHandler + +# Type Alias: InterceptHandler() + +```ts +type InterceptHandler: (arg) => InterceptData | void; +``` + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `arg` | [`InterceptData`](../interfaces/InterceptData.mdx) | + +## Returns + +[`InterceptData`](../interfaces/InterceptData.mdx) \| `void` + +## Defined in + +testplane-docs/.testplane/src/events/types.ts:9 diff --git a/i18n/en/docusaurus-plugin-content-docs/current/api-reference/type-aliases/InterceptedEvent.mdx b/i18n/en/docusaurus-plugin-content-docs/current/api-reference/type-aliases/InterceptedEvent.mdx new file mode 100644 index 0000000..d13c5de --- /dev/null +++ b/i18n/en/docusaurus-plugin-content-docs/current/api-reference/type-aliases/InterceptedEvent.mdx @@ -0,0 +1,19 @@ +[testplane](../README.mdx) / InterceptedEvent + +# Type Alias: InterceptedEvent + +```ts +type InterceptedEvent: ValueOf>; +``` + +## Defined in + +testplane-docs/.testplane/src/events/index.ts:105 diff --git a/i18n/en/docusaurus-plugin-content-docs/current/api-reference/type-aliases/MasterEventHandler.mdx b/i18n/en/docusaurus-plugin-content-docs/current/api-reference/type-aliases/MasterEventHandler.mdx new file mode 100644 index 0000000..98ed4f8 --- /dev/null +++ b/i18n/en/docusaurus-plugin-content-docs/current/api-reference/type-aliases/MasterEventHandler.mdx @@ -0,0 +1,303 @@ +[testplane](../README.mdx) / MasterEventHandler + +# Type Alias: MasterEventHandler()\ + +```ts +type MasterEventHandler: (event, callback) => T(event, callback) => T(event, callback) => T(event, callback) => T(event, callback) => T(event, callback) => T(event, callback) => T(event, callback) => T(event, callback) => T(event, callback) => T(event, callback) => T(event, callback) => T(event, callback) => T(event, callback) => T(event, callback) => T(event, callback) => T(event, callback) => T(event, callback) => T(event, callback) => T(event, callback) => T(event, callback) => T(event, callback) => T(event, callback) => T(event, callback) => T(event, callback) => T(event, callback) => T; +``` + +## Type Parameters + +| Type Parameter | +| ------ | +| `T` *extends* `BaseTestplane` | + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `event` | `"init"` | +| `callback` | () => `void` \| `Promise`\<`void`\> | + +## Returns + +`T` + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `event` | `"startRunner"` | +| `callback` | (`runner`) => `void` \| `Promise`\<`void`\> | + +## Returns + +`T` + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `event` | `"endRunner"` | +| `callback` | (`result`) => `void` \| `Promise`\<`void`\> | + +## Returns + +`T` + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `event` | `"startSession"` | +| `callback` | [`AsyncSessionEventCallback`](AsyncSessionEventCallback.mdx) | + +## Returns + +`T` + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `event` | `"endSession"` | +| `callback` | [`AsyncSessionEventCallback`](AsyncSessionEventCallback.mdx) | + +## Returns + +`T` + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `event` | `"exit"` | +| `callback` | () => `void` \| `Promise`\<`void`\> | + +## Returns + +`T` + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `event` | `"newWorkerProcess"` | +| `callback` | (`suite`) => `void` | + +## Returns + +`T` + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `event` | `"beginSuite"` | +| `callback` | (`suite`) => `void` | + +## Returns + +`T` + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `event` | `"endSuite"` | +| `callback` | (`suite`) => `void` | + +## Returns + +`T` + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `event` | `"beginTest"` | +| `callback` | (`test`) => `void` | + +## Returns + +`T` + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `event` | `"endTest"` | +| `callback` | (`test`) => `void` | + +## Returns + +`T` + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `event` | `"passTest"` | +| `callback` | (`test`) => `void` | + +## Returns + +`T` + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `event` | `"failTest"` | +| `callback` | (`test`) => `void` | + +## Returns + +`T` + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `event` | `"pendingTest"` | +| `callback` | (`test`) => `void` | + +## Returns + +`T` + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `event` | `"retry"` | +| `callback` | (`test`) => `void` | + +## Returns + +`T` + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `event` | `"cli"` | +| `callback` | (`commander`) => `void` | + +## Returns + +`T` + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `event` | `"begin"` | +| `callback` | () => `void` | + +## Returns + +`T` + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `event` | `"end"` | +| `callback` | () => `void` | + +## Returns + +`T` + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `event` | `"beforeFileRead"` | +| `callback` | (`data`) => `void` | + +## Returns + +`T` + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `event` | `"afterFileRead"` | +| `callback` | (`data`) => `void` | + +## Returns + +`T` + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `event` | `"afterTestsRead"` | +| `callback` | (`collection`) => `void` | + +## Returns + +`T` + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `event` | `"info"` | +| `callback` | () => `void` | + +## Returns + +`T` + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `event` | `"warning"` | +| `callback` | () => `void` | + +## Returns + +`T` + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `event` | `"err"` | +| `callback` | (`err`) => `void` | + +## Returns + +`T` + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `event` | `"updateReference"` | +| `callback` | (`data`) => `void` | + +## Returns + +`T` + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `event` | `"newBrowser"` | +| `callback` | [`SyncSessionEventCallback`](SyncSessionEventCallback.mdx) | + +## Returns + +`T` + +## Defined in + +testplane-docs/.testplane/src/types/index.ts:193 diff --git a/i18n/en/docusaurus-plugin-content-docs/current/api-reference/type-aliases/SyncSessionEventCallback.mdx b/i18n/en/docusaurus-plugin-content-docs/current/api-reference/type-aliases/SyncSessionEventCallback.mdx new file mode 100644 index 0000000..e1a6093 --- /dev/null +++ b/i18n/en/docusaurus-plugin-content-docs/current/api-reference/type-aliases/SyncSessionEventCallback.mdx @@ -0,0 +1,24 @@ +[testplane](../README.mdx) / SyncSessionEventCallback + +# Type Alias: SyncSessionEventCallback() + +```ts +type SyncSessionEventCallback: (browser, browserInfo) => void; +``` + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `browser` | `WebdriverIO.Browser` | +| `browserInfo` | `object` | +| `browserInfo.browserId` | `string` | +| `browserInfo.browserVersion` | `string` | + +## Returns + +`void` + +## Defined in + +testplane-docs/.testplane/src/types/index.ts:188 diff --git a/i18n/en/docusaurus-plugin-content-docs/current/api-reference/type-aliases/WorkerEventHandler.mdx b/i18n/en/docusaurus-plugin-content-docs/current/api-reference/type-aliases/WorkerEventHandler.mdx new file mode 100644 index 0000000..85b36df --- /dev/null +++ b/i18n/en/docusaurus-plugin-content-docs/current/api-reference/type-aliases/WorkerEventHandler.mdx @@ -0,0 +1,83 @@ +[testplane](../README.mdx) / WorkerEventHandler + +# Type Alias: WorkerEventHandler()\ + +```ts +type WorkerEventHandler: (event, callback) => T(event, callback) => T(event, callback) => T(event, callback) => T(event, callback) => T(event, callback) => T; +``` + +## Type Parameters + +| Type Parameter | +| ------ | +| `T` *extends* `BaseTestplane` | + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `event` | `"init"` | +| `callback` | () => `void` \| `Promise`\<`void`\> | + +## Returns + +`T` + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `event` | `"beforeFileRead"` | +| `callback` | (`data`) => `void` | + +## Returns + +`T` + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `event` | `"afterFileRead"` | +| `callback` | (`data`) => `void` | + +## Returns + +`T` + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `event` | `"afterTestsRead"` | +| `callback` | (`collection`) => `void` | + +## Returns + +`T` + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `event` | `"updateReference"` | +| `callback` | (`data`) => `void` | + +## Returns + +`T` + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `event` | `"newBrowser"` | +| `callback` | [`SyncSessionEventCallback`](SyncSessionEventCallback.mdx) | + +## Returns + +`T` + +## Defined in + +testplane-docs/.testplane/src/types/index.ts:225 diff --git a/i18n/en/docusaurus-plugin-content-docs/current/api-reference/variables/Key.mdx b/i18n/en/docusaurus-plugin-content-docs/current/api-reference/variables/Key.mdx new file mode 100644 index 0000000..3b6c37f --- /dev/null +++ b/i18n/en/docusaurus-plugin-content-docs/current/api-reference/variables/Key.mdx @@ -0,0 +1,131 @@ +[testplane](../README.mdx) / Key + +# Variable: Key + +```ts +const Key: { + Add: ""; + Alt: ""; + ArrowDown: ""; + ArrowLeft: ""; + ArrowRight: ""; + ArrowUp: ""; + Backspace: ""; + Cancel: ""; + Clear: ""; + Command: ""; + Control: ""; + Ctrl: "WDIO_CONTROL"; + Decimal: ""; + Delete: ""; + Divide: ""; + End: ""; + Enter: ""; + Equals: ""; + Escape: ""; + F1: ""; + F10: ""; + F11: ""; + F12: ""; + F2: ""; + F3: ""; + F4: ""; + F5: ""; + F6: ""; + F7: ""; + F8: ""; + F9: ""; + Help: ""; + Home: ""; + Insert: ""; + Multiply: ""; + NULL: ""; + Numpad0: ""; + Numpad1: ""; + Numpad2: ""; + Numpad3: ""; + Numpad4: ""; + Numpad5: ""; + Numpad6: ""; + Numpad7: ""; + Numpad8: ""; + Numpad9: ""; + PageDown: ""; + PageUp: ""; + Pause: ""; + Return: ""; + Semicolon: ""; + Separator: ""; + Shift: ""; + Space: ""; + Subtract: ""; + Tab: ""; + ZenkakuHankaku: ""; +}; +``` + +## Type declaration + +| Name | Type | Defined in | +| ------ | ------ | ------ | +| `Add` | `""` | testplane/node\_modules/webdriverio/build/index.d.ts:45 | +| `Alt` | `""` | testplane/node\_modules/webdriverio/build/index.d.ts:18 | +| `ArrowDown` | `""` | testplane/node\_modules/webdriverio/build/index.d.ts:29 | +| `ArrowLeft` | `""` | testplane/node\_modules/webdriverio/build/index.d.ts:26 | +| `ArrowRight` | `""` | testplane/node\_modules/webdriverio/build/index.d.ts:28 | +| `ArrowUp` | `""` | testplane/node\_modules/webdriverio/build/index.d.ts:27 | +| `Backspace` | `""` | testplane/node\_modules/webdriverio/build/index.d.ts:11 | +| `Cancel` | `""` | testplane/node\_modules/webdriverio/build/index.d.ts:9 | +| `Clear` | `""` | testplane/node\_modules/webdriverio/build/index.d.ts:13 | +| `Command` | `""` | testplane/node\_modules/webdriverio/build/index.d.ts:62 | +| `Control` | `""` | testplane/node\_modules/webdriverio/build/index.d.ts:17 | +| `Ctrl` | `"WDIO_CONTROL"` | testplane/node\_modules/webdriverio/build/index.d.ts:7 | +| `Decimal` | `""` | testplane/node\_modules/webdriverio/build/index.d.ts:48 | +| `Delete` | `""` | testplane/node\_modules/webdriverio/build/index.d.ts:31 | +| `Divide` | `""` | testplane/node\_modules/webdriverio/build/index.d.ts:49 | +| `End` | `""` | testplane/node\_modules/webdriverio/build/index.d.ts:24 | +| `Enter` | `""` | testplane/node\_modules/webdriverio/build/index.d.ts:15 | +| `Equals` | `""` | testplane/node\_modules/webdriverio/build/index.d.ts:33 | +| `Escape` | `""` | testplane/node\_modules/webdriverio/build/index.d.ts:20 | +| `F1` | `""` | testplane/node\_modules/webdriverio/build/index.d.ts:50 | +| `F10` | `""` | testplane/node\_modules/webdriverio/build/index.d.ts:59 | +| `F11` | `""` | testplane/node\_modules/webdriverio/build/index.d.ts:60 | +| `F12` | `""` | testplane/node\_modules/webdriverio/build/index.d.ts:61 | +| `F2` | `""` | testplane/node\_modules/webdriverio/build/index.d.ts:51 | +| `F3` | `""` | testplane/node\_modules/webdriverio/build/index.d.ts:52 | +| `F4` | `""` | testplane/node\_modules/webdriverio/build/index.d.ts:53 | +| `F5` | `""` | testplane/node\_modules/webdriverio/build/index.d.ts:54 | +| `F6` | `""` | testplane/node\_modules/webdriverio/build/index.d.ts:55 | +| `F7` | `""` | testplane/node\_modules/webdriverio/build/index.d.ts:56 | +| `F8` | `""` | testplane/node\_modules/webdriverio/build/index.d.ts:57 | +| `F9` | `""` | testplane/node\_modules/webdriverio/build/index.d.ts:58 | +| `Help` | `""` | testplane/node\_modules/webdriverio/build/index.d.ts:10 | +| `Home` | `""` | testplane/node\_modules/webdriverio/build/index.d.ts:25 | +| `Insert` | `""` | testplane/node\_modules/webdriverio/build/index.d.ts:30 | +| `Multiply` | `""` | testplane/node\_modules/webdriverio/build/index.d.ts:44 | +| `NULL` | `""` | testplane/node\_modules/webdriverio/build/index.d.ts:8 | +| `Numpad0` | `""` | testplane/node\_modules/webdriverio/build/index.d.ts:34 | +| `Numpad1` | `""` | testplane/node\_modules/webdriverio/build/index.d.ts:35 | +| `Numpad2` | `""` | testplane/node\_modules/webdriverio/build/index.d.ts:36 | +| `Numpad3` | `""` | testplane/node\_modules/webdriverio/build/index.d.ts:37 | +| `Numpad4` | `""` | testplane/node\_modules/webdriverio/build/index.d.ts:38 | +| `Numpad5` | `""` | testplane/node\_modules/webdriverio/build/index.d.ts:39 | +| `Numpad6` | `""` | testplane/node\_modules/webdriverio/build/index.d.ts:40 | +| `Numpad7` | `""` | testplane/node\_modules/webdriverio/build/index.d.ts:41 | +| `Numpad8` | `""` | testplane/node\_modules/webdriverio/build/index.d.ts:42 | +| `Numpad9` | `""` | testplane/node\_modules/webdriverio/build/index.d.ts:43 | +| `PageDown` | `""` | testplane/node\_modules/webdriverio/build/index.d.ts:23 | +| `PageUp` | `""` | testplane/node\_modules/webdriverio/build/index.d.ts:22 | +| `Pause` | `""` | testplane/node\_modules/webdriverio/build/index.d.ts:19 | +| `Return` | `""` | testplane/node\_modules/webdriverio/build/index.d.ts:14 | +| `Semicolon` | `""` | testplane/node\_modules/webdriverio/build/index.d.ts:32 | +| `Separator` | `""` | testplane/node\_modules/webdriverio/build/index.d.ts:46 | +| `Shift` | `""` | testplane/node\_modules/webdriverio/build/index.d.ts:16 | +| `Space` | `""` | testplane/node\_modules/webdriverio/build/index.d.ts:21 | +| `Subtract` | `""` | testplane/node\_modules/webdriverio/build/index.d.ts:47 | +| `Tab` | `""` | testplane/node\_modules/webdriverio/build/index.d.ts:12 | +| `ZenkakuHankaku` | `""` | testplane/node\_modules/webdriverio/build/index.d.ts:63 | + +## Defined in + +testplane/node\_modules/webdriverio/build/index.d.ts:6 diff --git a/package-lock.json b/package-lock.json index 40638ff..9e13582 100644 --- a/package-lock.json +++ b/package-lock.json @@ -48,6 +48,10 @@ "storybook": "8.0.5", "tailwindcss": "3.4.1", "typed.js": "2.1.0", + "typedoc": "0.26.5", + "typedoc-plugin-localization": "3.0.5", + "typedoc-plugin-markdown": "4.2.4", + "typedoc-plugin-rename-defaults": "0.7.1", "typescript": "5.4.3", "typescript-eslint": "7.4.0", "zustand": "4.5.2" @@ -5102,6 +5106,15 @@ } } }, + "node_modules/@shikijs/core": { + "version": "1.12.1", + "resolved": "https://registry.npmjs.org/@shikijs/core/-/core-1.12.1.tgz", + "integrity": "sha512-biCz/mnkMktImI6hMfMX3H9kOeqsInxWEyCHbSlL8C/2TR1FqfmGxTLRNwYCKsyCyxWLbB8rEqXRVZuyxuLFmA==", + "dev": true, + "dependencies": { + "@types/hast": "^3.0.4" + } + }, "node_modules/@sideway/address": { "version": "4.1.5", "resolved": "https://registry.npmjs.org/@sideway/address/-/address-4.1.5.tgz", @@ -17103,6 +17116,15 @@ "resolved": "https://registry.npmjs.org/lines-and-columns/-/lines-and-columns-1.2.4.tgz", "integrity": "sha512-7ylylesZQ/PV29jhEDl3Ufjo6ZX7gCqJr5F7PKrqc93v7fzSymt1BpwEU8nAUXs8qzzvqhbjhK5QZg6Mt/HkBg==" }, + "node_modules/linkify-it": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/linkify-it/-/linkify-it-5.0.0.tgz", + "integrity": "sha512-5aHCbzQRADcdP+ATqnDuhhJ/MRIqDkZX5pyjFHRRysS8vZ5AbqGEoFIb6pYHPZ+L/OC2Lc+xT8uHVVR5CAK/wQ==", + "dev": true, + "dependencies": { + "uc.micro": "^2.0.0" + } + }, "node_modules/loader-runner": { "version": "4.3.0", "resolved": "https://registry.npmjs.org/loader-runner/-/loader-runner-4.3.0.tgz", @@ -17440,6 +17462,12 @@ "yallist": "^3.0.2" } }, + "node_modules/lunr": { + "version": "2.3.9", + "resolved": "https://registry.npmjs.org/lunr/-/lunr-2.3.9.tgz", + "integrity": "sha512-zTU3DaZaF3Rt9rhN3uBMGQD3dD2/vFQqnvZCDv4dl5iOzq2IZQqTxu90r4E5J+nP70J3ilqVCrbho2eWaeW8Ow==", + "dev": true + }, "node_modules/lz-string": { "version": "1.5.0", "resolved": "https://registry.npmjs.org/lz-string/-/lz-string-1.5.0.tgz", @@ -17509,6 +17537,23 @@ "url": "https://github.com/sponsors/sindresorhus" } }, + "node_modules/markdown-it": { + "version": "14.1.0", + "resolved": "https://registry.npmjs.org/markdown-it/-/markdown-it-14.1.0.tgz", + "integrity": "sha512-a54IwgWPaeBCAAsv13YgmALOF1elABB08FxO9i+r4VFk5Vl4pKokRPeX8u5TCgSsPi6ec1otfLjdOpVcgbpshg==", + "dev": true, + "dependencies": { + "argparse": "^2.0.1", + "entities": "^4.4.0", + "linkify-it": "^5.0.0", + "mdurl": "^2.0.0", + "punycode.js": "^2.3.1", + "uc.micro": "^2.1.0" + }, + "bin": { + "markdown-it": "bin/markdown-it.mjs" + } + }, "node_modules/markdown-table": { "version": "3.0.3", "resolved": "https://registry.npmjs.org/markdown-table/-/markdown-table-3.0.3.tgz", @@ -17920,6 +17965,12 @@ "resolved": "https://registry.npmjs.org/mdn-data/-/mdn-data-2.0.30.tgz", "integrity": "sha512-GaqWWShW4kv/G9IEucWScBx9G1/vsFZZJUO+tD26M8J8z3Kw5RDQjaoZe03YAClgeS/SWPOcb4nkFBTEi5DUEA==" }, + "node_modules/mdurl": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/mdurl/-/mdurl-2.0.0.tgz", + "integrity": "sha512-Lf+9+2r+Tdp5wXDXC4PcIBjTDtq4UKjCPMQhKIuzpJNW0b96kVqSwW0bT7FhRSfmAiFYgP+SCRvdrDozfh0U5w==", + "dev": true + }, "node_modules/media-typer": { "version": "0.3.0", "resolved": "https://registry.npmjs.org/media-typer/-/media-typer-0.3.0.tgz", @@ -22459,6 +22510,15 @@ "resolved": "https://registry.npmjs.org/punycode/-/punycode-1.4.1.tgz", "integrity": "sha512-jmYNElW7yvO7TV33CjSmvSiE2yco3bV2czu/OzDKdMNVZQWfxCblURLhf+47syQRBntjfLdd/H0egrzIG+oaFQ==" }, + "node_modules/punycode.js": { + "version": "2.3.1", + "resolved": "https://registry.npmjs.org/punycode.js/-/punycode.js-2.3.1.tgz", + "integrity": "sha512-uxFIHU0YlHYhDQtV4R9J6a52SLx28BCjT+4ieh7IGbgwVJWO+km431c4yRlREUAsAmt/uMjQUyQHNEPf0M39CA==", + "dev": true, + "engines": { + "node": ">=6" + } + }, "node_modules/pupa": { "version": "3.1.0", "resolved": "https://registry.npmjs.org/pupa/-/pupa-3.1.0.tgz", @@ -24758,6 +24818,16 @@ "url": "https://github.com/sponsors/isaacs" } }, + "node_modules/shiki": { + "version": "1.12.1", + "resolved": "https://registry.npmjs.org/shiki/-/shiki-1.12.1.tgz", + "integrity": "sha512-nwmjbHKnOYYAe1aaQyEBHvQymJgfm86ZSS7fT8OaPRr4sbAcBNz7PbfAikMEFSDQ6se2j2zobkXvVKcBOm0ysg==", + "dev": true, + "dependencies": { + "@shikijs/core": "1.12.1", + "@types/hast": "^3.0.4" + } + }, "node_modules/side-channel": { "version": "1.0.6", "resolved": "https://registry.npmjs.org/side-channel/-/side-channel-1.0.6.tgz", @@ -26297,6 +26367,109 @@ "is-typedarray": "^1.0.0" } }, + "node_modules/typedoc": { + "version": "0.26.5", + "resolved": "https://registry.npmjs.org/typedoc/-/typedoc-0.26.5.tgz", + "integrity": "sha512-Vn9YKdjKtDZqSk+by7beZ+xzkkr8T8CYoiasqyt4TTRFy5+UHzL/mF/o4wGBjRF+rlWQHDb0t6xCpA3JNL5phg==", + "dev": true, + "dependencies": { + "lunr": "^2.3.9", + "markdown-it": "^14.1.0", + "minimatch": "^9.0.5", + "shiki": "^1.9.1", + "yaml": "^2.4.5" + }, + "bin": { + "typedoc": "bin/typedoc" + }, + "engines": { + "node": ">= 18" + }, + "peerDependencies": { + "typescript": "4.6.x || 4.7.x || 4.8.x || 4.9.x || 5.0.x || 5.1.x || 5.2.x || 5.3.x || 5.4.x || 5.5.x" + } + }, + "node_modules/typedoc-plugin-localization": { + "version": "3.0.5", + "resolved": "https://registry.npmjs.org/typedoc-plugin-localization/-/typedoc-plugin-localization-3.0.5.tgz", + "integrity": "sha512-mvk0/DyjlFWcjxl2d0AsDeM6X8TjFE8FlbVyPDjY0mg54mHk9INp1rAbx9zZ5jtiLUVHrE8t9fb8FacmbmvqwA==", + "dev": true, + "dependencies": { + "fs-extra": "^11.2.0" + } + }, + "node_modules/typedoc-plugin-markdown": { + "version": "4.2.4", + "resolved": "https://registry.npmjs.org/typedoc-plugin-markdown/-/typedoc-plugin-markdown-4.2.4.tgz", + "integrity": "sha512-9jdYqF5Sx1qxvSo7wV1mUHA2XYn3Y1DJ/ttCWW1V4lHdzDAwIA/EB9U92Ryx3GOSD73X1u8eTu8fBjoCmkURTQ==", + "dev": true, + "engines": { + "node": ">= 18" + }, + "peerDependencies": { + "typedoc": "0.26.x" + } + }, + "node_modules/typedoc-plugin-rename-defaults": { + "version": "0.7.1", + "resolved": "https://registry.npmjs.org/typedoc-plugin-rename-defaults/-/typedoc-plugin-rename-defaults-0.7.1.tgz", + "integrity": "sha512-hgg4mAy5IumgUmPOnVVGmGywjTGtUCmRJ2jRbseqtXdlUuYKj652ODL9joUWFt5uvNu4Dr/pNILc/qsKGHJw+w==", + "dev": true, + "dependencies": { + "camelcase": "^8.0.0" + }, + "peerDependencies": { + "typedoc": ">=0.22.x <0.27.x" + } + }, + "node_modules/typedoc-plugin-rename-defaults/node_modules/camelcase": { + "version": "8.0.0", + "resolved": "https://registry.npmjs.org/camelcase/-/camelcase-8.0.0.tgz", + "integrity": "sha512-8WB3Jcas3swSvjIeA2yvCJ+Miyz5l1ZmB6HFb9R1317dt9LCQoswg/BGrmAmkWVEszSrrg4RwmO46qIm2OEnSA==", + "dev": true, + "engines": { + "node": ">=16" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/typedoc/node_modules/brace-expansion": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-2.0.1.tgz", + "integrity": "sha512-XnAIvQ8eM+kC6aULx6wuQiwVsnzsi9d3WxzV3FpWTGA19F621kwdbsAcFKXgKUHZWsy+mY6iL1sHTxWEFCytDA==", + "dev": true, + "dependencies": { + "balanced-match": "^1.0.0" + } + }, + "node_modules/typedoc/node_modules/minimatch": { + "version": "9.0.5", + "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-9.0.5.tgz", + "integrity": "sha512-G6T0ZX48xgozx7587koeX9Ys2NYy6Gmv//P89sEte9V9whIapMNF4idKxnW2QtCcLiTWlb/wfCabAtAFWhhBow==", + "dev": true, + "dependencies": { + "brace-expansion": "^2.0.1" + }, + "engines": { + "node": ">=16 || 14 >=14.17" + }, + "funding": { + "url": "https://github.com/sponsors/isaacs" + } + }, + "node_modules/typedoc/node_modules/yaml": { + "version": "2.5.0", + "resolved": "https://registry.npmjs.org/yaml/-/yaml-2.5.0.tgz", + "integrity": "sha512-2wWLbGbYDiSqqIKoPjar3MPgB94ErzCtrNE1FdqGuaO0pi2JGjmE8aW8TDZwzU7vuxcGRdL/4gPQwQ7hD5AMSw==", + "dev": true, + "bin": { + "yaml": "bin.mjs" + }, + "engines": { + "node": ">= 14" + } + }, "node_modules/typescript": { "version": "5.4.3", "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.4.3.tgz", @@ -26459,6 +26632,12 @@ "url": "https://github.com/sponsors/isaacs" } }, + "node_modules/uc.micro": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/uc.micro/-/uc.micro-2.1.0.tgz", + "integrity": "sha512-ARDJmphmdvUk6Glw7y9DQ2bFkKBHwQHLi2lsaH6PPmz/Ka9sFOBsBluozhDltWmnv9u/cF6Rt87znRTPV+yp/A==", + "dev": true + }, "node_modules/ufo": { "version": "1.5.3", "resolved": "https://registry.npmjs.org/ufo/-/ufo-1.5.3.tgz", diff --git a/package.json b/package.json index 38dc753..5297747 100644 --- a/package.json +++ b/package.json @@ -10,7 +10,12 @@ "test": "npm run lint && npm run typecheck", "typecheck": "tsc", "storybook": "storybook dev -p 6006", - "build-storybook": "storybook build" + "build-storybook": "storybook build", + "clone-testplane": "node clone-testplane.js", + "docs:generate:ru-template": "npx typedoc .testplane/src/ --generate-json exports", + "docs:generate:ru": "npx typedoc .testplane/src/ --generate-from-json ./exports --out docs/api-reference --locale ru", + "docs:generate:en": "npx typedoc .testplane/src/ --out i18n/en/docusaurus-plugin-content-docs/current/api-reference", + "docs:generate": "npm run docs:generate:en && npm run docs:generate:ru" }, "dependencies": { "@docusaurus/core": "3.4.0", @@ -53,6 +58,10 @@ "storybook": "8.0.5", "tailwindcss": "3.4.1", "typed.js": "2.1.0", + "typedoc": "0.26.5", + "typedoc-plugin-localization": "3.0.5", + "typedoc-plugin-markdown": "4.2.4", + "typedoc-plugin-rename-defaults": "0.7.1", "typescript": "5.4.3", "typescript-eslint": "7.4.0", "zustand": "4.5.2" diff --git a/sidebars.ts b/sidebars.ts index 508caf2..e298491 100644 --- a/sidebars.ts +++ b/sidebars.ts @@ -30,6 +30,11 @@ const sidebars: SidebarsConfig = { label: "Guides", items: [{ type: "autogenerated", dirName: "guides" }], }, + { + type: "category", + label: "API reference", + items: [{ type: "autogenerated", dirName: "api-reference" }], + }, { type: "category", label: "HTML Reporter", diff --git a/typedoc.json b/typedoc.json new file mode 100644 index 0000000..7ada539 --- /dev/null +++ b/typedoc.json @@ -0,0 +1,108 @@ +{ + "$schema": "https://typedoc-plugin-markdown.org/schema.json", + "tsconfig": ".testplane/tsconfig.json", + "name": "testplane", + "entryPoints": [".testplane/src/index.ts"], + "exclude": [".testplane/node_modules/**"], + "plugin": ["typedoc-plugin-rename-defaults", "typedoc-plugin-localization", "typedoc-plugin-markdown"], + "readme": "none", + "enumMembersFormat": "table", + "parametersFormat": "table", + "propertiesFormat": "table", + "typeDeclarationFormat": "table", + "indexFormat": "table", + "useCodeBlocks": true, + "expandObjects": true, + "hidePageHeader": true, + "excludeInternal": true, + "classPropertiesFormat": "htmlTable", + "excludeProtected": true, + "fileExtension": ".mdx", + "mergeReadme": true, + + "locales": { + "ru": { + "kind_project": "Проект", + "kind_module": "Модуль", + "kind_namespace": "Пространство имен", + "kind_enum": "Перечисление", + "kind_enum_member": "Элемент перечисления", + "kind_variable": "Переменная", + "kind_function": "Функция", + "kind_class": "Класс", + "kind_interface": "Интерфейс", + "kind_constructor": "Конструктор", + "kind_property": "Свойство", + "kind_method": "Метод", + "kind_call_signature": "Сигнатура вызова", + "kind_index_signature": "Сигнатура индексации", + "kind_constructor_signature": "Сигнатура конструктора", + "kind_parameter": "Параметр", + "kind_type_literal": "Тип литерала", + "kind_type_parameter": "Параметр типа", + "kind_accessor": "Акцессор", + "kind_get_signature": "Сигнатура получения", + "kind_set_signature": "Сигнатура установки", + "kind_type_alias": "Псевдоним типа", + "kind_reference": "Ссылка", + "kind_document": "Документ", + + // ReflectionKind plural translations + "kind_plural_project": "Проекты", + "kind_plural_module": "Модули", + "kind_plural_namespace": "Пространства имен", + "kind_plural_enum": "Перечисления", + "kind_plural_enum_member": "Элементы перечисления", + "kind_plural_variable": "Переменные", + "kind_plural_function": "Функции", + "kind_plural_class": "Классы", + "kind_plural_interface": "Интерфейсы", + "kind_plural_constructor": "Конструкторы", + "kind_plural_property": "Свойства", + "kind_plural_method": "Методы", + "kind_plural_call_signature": "Сигнатуры вызова", + "kind_plural_index_signature": "Сигнатуры индексации", + "kind_plural_constructor_signature": "Сигнатуры конструктора", + "kind_plural_parameter": "Параметры", + "kind_plural_type_literal": "Типы литералов", + "kind_plural_type_parameter": "Параметры типа", + "kind_plural_accessor": "Акцессоры", + "kind_plural_get_signature": "Сигнатуры получения", + "kind_plural_set_signature": "Сигнатуры установки", + "kind_plural_type_alias": "Псевдонимы типа", + "kind_plural_reference": "Ссылки", + "kind_plural_document": "Документы", + + // ReflectionFlag translations + "flag_private": "Приватный", + "flag_protected": "Защищенный", + "flag_public": "Публичный", + "flag_static": "Статический", + "flag_external": "Внешний", + "flag_optional": "Необязательный", + "flag_rest": "Остальные", + "flag_abstract": "Абстрактный", + "flag_const": "Константный", + "flag_readonly": "Только для чтения", + "flag_inherited": "Наследуемый", + + // Page headings/labels + "theme_implements": "Реализует", + "theme_indexable": "Индексируемый", + "theme_type_declaration": "Объявление типа", + "theme_index": "Индекс", + "theme_hierarchy": "Иерархия", + "theme_hierarchy_view_full": "показать полностью", + "theme_implemented_by": "Реализовано в", + "theme_defined_in": "Определено в", + "theme_implementation_of": "Реализация", + "theme_inherited_from": "Наследуется от", + "theme_overrides": "Переопределяет", + "theme_returns": "Возвращает", + "theme_re_exports": "Повторно экспортирует", + "theme_renames_and_re_exports": "Переименовывает и повторно экспортирует", + "theme_generated_using_typedoc": "Сгенерировано с помощью TypeDoc", + "theme_class_hierarchy_title": "Иерархия класса" + } + } +}