@wdio/types
Advanced tools
Comparing version 7.25.4 to 7.26.0
@@ -210,7 +210,26 @@ import { WebdriverIO as WebDriverIOOptions, Connection as ConnectionOptions } from './Options'; | ||
perfLoggingPrefs?: { | ||
/** | ||
* Whether or not to collect events from Network domain. | ||
* @default true | ||
*/ | ||
enableNetwork?: boolean; | ||
/** | ||
* Whether or not to collect events from Page domain. | ||
* @default true | ||
*/ | ||
enablePage?: boolean; | ||
enableTimeline?: boolean; | ||
tracingCategories?: boolean; | ||
bufferUsageReportingInterval?: boolean; | ||
/** | ||
* A comma-separated string of Chrome tracing categories for which trace events | ||
* should be collected. An unspecified or empty string disables tracing. | ||
* @default '' | ||
*/ | ||
tracingCategories?: string; | ||
/** | ||
* The requested number of milliseconds between DevTools trace buffer | ||
* usage events. For example, if 1000, then once per second, DevTools | ||
* will report how full the trace buffer is. If a report indicates the | ||
* buffer usage is 100%, a warning will be issued. | ||
* @default 1000 | ||
*/ | ||
bufferUsageReportingInterval?: number; | ||
}; | ||
@@ -973,6 +992,25 @@ /** | ||
device?: string; | ||
/** | ||
* Specify a name for a logical group of builds. | ||
*/ | ||
projectName?: string; | ||
/** | ||
* Specify a name for a logical group of tests. | ||
*/ | ||
buildName?: string; | ||
/** | ||
* Specify an identifier for the test run. | ||
*/ | ||
sessionName?: string; | ||
/** | ||
* Test locally hosted websites on BrowserStack. | ||
* To enable access to the local machine you need to setup the | ||
* [BrowserStack Local Binary](https://www.browserstack.com/local-testing/automate). | ||
*/ | ||
local?: boolean; | ||
/** | ||
* Generate screenshots at various steps of the test. | ||
* | ||
* @default false | ||
*/ | ||
debug?: boolean; | ||
@@ -991,2 +1029,9 @@ networkLogs?: boolean; | ||
localIdentifier?: string; | ||
/** | ||
* Capture browser console logs at various steps in the test. | ||
* Console Logs are available for Selenium tests on Desktop Chrome | ||
* and Mobile Chrome (Android devices). | ||
* | ||
* @default 'errors' | ||
*/ | ||
consoleLogs?: 'disable' | 'errors' | 'warnings' | 'info' | 'verbose'; | ||
@@ -998,11 +1043,79 @@ appiumLogs?: boolean; | ||
timezone?: string; | ||
/** | ||
* Set the resolution of the VM. | ||
*/ | ||
resolution?: string; | ||
/** | ||
* Mask the data sent or retrieved by certain commands. | ||
* | ||
* Note: Multiple commands can be passed in a single array, separated by commas. | ||
*/ | ||
'browserstack.maskCommands'?: string[]; | ||
/** | ||
* BrowerStack triggers `BROWSERSTACK_IDLE_TIMEOUT` error when a session | ||
* is left idle for more than `idleTimeout` seconds. This happens as BrowserStack by | ||
* default waits for the timeout duration for additional steps or commands | ||
* to run. If no command is received during that time, the session is stopped, | ||
* changing the session status to `TIMEOUT` on the Automate dashboard. | ||
* | ||
* Valid range: 0-300 seconds. | ||
* | ||
* @default 90 | ||
*/ | ||
idleTimeout?: number; | ||
/** | ||
* Mask credentials from test logs if using basic authentication. | ||
*/ | ||
maskBasicAuth?: boolean; | ||
/** | ||
* Specify a custom delay between the execution of Selenium commands. | ||
* | ||
* @default 20 | ||
*/ | ||
autoWait?: number; | ||
/** | ||
* Add a host entry (/etc/hosts) to the remote BrowserStack machine. | ||
* | ||
* Format: ip_address domain_name | ||
* @example | ||
* { "bstack:options": { hosts: "1.2.3.4 staging.website.com" } } | ||
*/ | ||
hosts?: string; | ||
/** | ||
* IE 11 uses cached pages when navigating using the backward or forward buttons. | ||
* To disable page caching, set this value to 1. | ||
* | ||
* @default 0 | ||
*/ | ||
bfcache?: 0 | 1; | ||
/** | ||
* Enable WSS (WebSocket Secure) connections to work with Network Logs | ||
* on Chrome v71 and above. | ||
* | ||
* Note: if using `localhost` in your test, change it to `bs-local.com`. | ||
* | ||
* @default false | ||
*/ | ||
wsLocalSupport?: boolean; | ||
/** | ||
* Use this capability to disable cross origin restrictions in Safari. | ||
* Available for Monterey, Big Sur, Catalina and Mojave. | ||
* | ||
* @default false | ||
*/ | ||
disableCorsRestrictions?: boolean; | ||
/** | ||
* Use this capability to add a custom tag to the builds. | ||
* These tags can be used to filter the builds on the Automate dashboard. | ||
*/ | ||
buildTag?: string; | ||
/** | ||
* Specify a particular mobile device for the test environment. | ||
*/ | ||
deviceName?: string; | ||
/** | ||
* Use this flag to test on a physical mobile device. | ||
* | ||
* @default false | ||
*/ | ||
realMobile?: boolean; | ||
@@ -1029,2 +1142,7 @@ appiumVersion?: string; | ||
browserVersion?: string; | ||
/** | ||
* Ignore invalid certificate errors. | ||
* | ||
* @default false | ||
*/ | ||
acceptSslCerts?: boolean; | ||
@@ -1031,0 +1149,0 @@ /** |
@@ -5,10 +5,50 @@ /// <reference types="node" /> | ||
import { EventEmitter } from 'events'; | ||
import type { RemoteCapability } from './Capabilities'; | ||
interface OutputFileFormatOptions { | ||
cid: string; | ||
capabilities: RemoteCapability; | ||
} | ||
export interface Options { | ||
outputDir?: string; | ||
/** | ||
* Complete path of the reporter log file. If `setLogFile` is defined, it will | ||
* be used instead of this option. | ||
*/ | ||
logFile?: string; | ||
/** | ||
* Define the filename format for the reporter log files, using the `cid` and | ||
* `capabilities`. `setLogFile` and `logFile` take precedence over this | ||
* option, if defined (in that order). | ||
* | ||
* > Note: `options.capabilities` is your capabilities object for that runner, so specifying | ||
* `${options.capabilities}` in your string will return [Object object]. You must specify which | ||
* properties of capabilities you want in your filename. | ||
* | ||
* @default `wdio-${cid}-${name}-reporter.log` | ||
* | ||
* @example | ||
* outputFileFormat: function (options) { | ||
* const { cid, capabilities } = options | ||
* const { browserName } = capabilities | ||
* return `wdio-${cid}-${browserName}-reporter.log` | ||
* } | ||
*/ | ||
outputFileFormat?: (options: OutputFileFormatOptions) => string; | ||
/** | ||
* Set the complete path for the reporter's log output, using `cid` and | ||
* the reporter's `name`. | ||
*/ | ||
setLogFile?: (cid: string, name: string) => string; | ||
/** | ||
* No log file will be created if this option is set to `true`. | ||
*/ | ||
stdout?: boolean; | ||
/** | ||
* Write to `writeStream` instead of a file. | ||
* | ||
* Note: `logFile` must not be set, unless `stdout` is set to `true`. | ||
*/ | ||
writeStream?: WriteStream | { | ||
write: (content: any) => boolean; | ||
}; | ||
stdout?: boolean; | ||
logFile?: string; | ||
/** | ||
@@ -56,2 +96,3 @@ * allow random typings from 3rd party reporters | ||
]); | ||
export {}; | ||
//# sourceMappingURL=Reporters.d.ts.map |
{ | ||
"name": "@wdio/types", | ||
"version": "7.25.4", | ||
"version": "7.26.0", | ||
"description": "Utility package providing type information for a variety of WebdriverIO interfaces", | ||
@@ -43,3 +43,3 @@ "author": "Christian Bromann <mail@bromann.dev>", | ||
}, | ||
"gitHead": "7e41cd86779937722b6f824d10375b039aee620f" | ||
"gitHead": "573927a79dc0a2b9d9a9e19e7d1b8c1ff9fac308" | ||
} |
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
129272
2462