Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/webapi/grabBrowserLogs.mustache
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@ let logs = await I.grabBrowserLogs();
console.log(JSON.stringify(logs))
```

@returns {Promise<object[]>|undefined} all browser logs
@returns {Promise<any[]>} all browser logs
2 changes: 1 addition & 1 deletion docs/webapi/grabCookie.mustache
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,4 @@ assert(cookie.value, '123456');
```

@param {?string} [name=null] cookie name.
@returns {any} attribute value
@returns {Promise<any>} cookie object, or all cookies if no name is given
2 changes: 1 addition & 1 deletion docs/webapi/grabDataFromPerformanceTiming.mustache
Original file line number Diff line number Diff line change
Expand Up @@ -17,4 +17,4 @@ let data = await I.grabDataFromPerformanceTiming();
loadEventEnd: 241
}
```
@returns {CodeceptJS.StepPromise} automatically synchronized promise through #recorder
@returns {Promise<{responseEnd: number, domInteractive: number, domContentLoadedEventEnd: number, loadEventEnd: number}>} performance timing data in ms
2 changes: 1 addition & 1 deletion docs/webapi/grabRecordedNetworkTraffics.mustache
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,4 @@ expect(traffics[0].response.status).to.equal(200);
expect(traffics[0].response.body).to.contain({ name: 'this was mocked' });
```

@return { Array } recorded network traffics
@returns {Promise<any[]>} recorded network traffics
4 changes: 3 additions & 1 deletion lib/helper/Playwright.js
Original file line number Diff line number Diff line change
Expand Up @@ -2656,6 +2656,8 @@ class Playwright extends Helper {
* // include IndexedDB when using Firebase Auth, etc.
* const stateWithIDB = await I.grabStorageState({ indexedDB: true });
* ```
*
* @returns {Promise<object>} storage state
*/
async grabStorageState(options = {}) {
return this.browserContext.storageState(options)
Expand Down Expand Up @@ -4065,7 +4067,7 @@ class Playwright extends Helper {
* ```
*
* @param {string|RegExp} urlMatch Expected URL of request in network traffic. Can be a string or a regular expression.
* @return {Promise<*>}
* @return {Promise<string>}
*/
grabTrafficUrl(urlMatch) {
if (!this.recordedAtLeastOnce) {
Expand Down
4 changes: 2 additions & 2 deletions typings/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -527,13 +527,13 @@ declare namespace CodeceptJS {

type StringOrSecret = string | CodeceptJS.Secret

interface StepPromise extends Promise<any> {
interface StepPromise<T = any> extends Promise<T> {
stepConfig(config: CodeceptJS.StepConfig): this
timeout(seconds: number): this
retry(retry: number | object): this
}

interface ElementStepPromise extends StepPromise {
interface ElementStepPromise<T = any> extends StepPromise<T> {
first(): this
last(): this
at(position: number): this
Expand Down
16 changes: 13 additions & 3 deletions typings/tests/helpers/Playwright.types.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { expectError, expectType } from 'tsd';
import { expectAssignable, expectError, expectType } from 'tsd';

// @ts-ignore
const playwright = new CodeceptJS.Playwright();
Expand Down Expand Up @@ -95,7 +95,8 @@ expectType<CodeceptJS.StepPromise>(playwright.seeNumberOfVisibleElements(str, nu
expectType<CodeceptJS.StepPromise>(playwright.setCookie({ name: str, value: str }));
expectType<CodeceptJS.StepPromise>(playwright.seeCookie(str));
expectType<CodeceptJS.StepPromise>(playwright.dontSeeCookie(str));
expectType<any>(playwright.grabCookie());
expectType<Promise<any>>(playwright.grabCookie());
expectType<Promise<object>>(playwright.grabStorageState());
expectType<void>(playwright.clearCookie());
expectType<Promise<any>>(playwright.executeScript(() => {}));
expectType<Promise<string>>(playwright.grabTextFrom(str));
Expand Down Expand Up @@ -132,12 +133,14 @@ expectType<CodeceptJS.StepPromise>(playwright.switchTo());
expectType<CodeceptJS.StepPromise>(playwright.waitForFunction(() => { }));
expectType<void>(playwright.waitForNavigation(str));
expectType<CodeceptJS.StepPromise>(playwright.waitForDetached(str));
expectType<CodeceptJS.StepPromise>(playwright.grabDataFromPerformanceTiming());
expectType<Promise<{ responseEnd: number; domInteractive: number; domContentLoadedEventEnd: number; loadEventEnd: number }>>(playwright.grabDataFromPerformanceTiming());
//expectType<Promise<number>>(playwright.grabElementBoundingRect(str));
expectType<void>(playwright.mockRoute(str));
expectType<void>(playwright.stopMockingRoute(str));

expectType<CodeceptJS.StepPromise>(playwright.startRecordingTraffic());
expectType<Promise<string>>(playwright.grabTrafficUrl(str));
expectType<Promise<any[]>>(playwright.grabRecordedNetworkTraffics());
expectType<void>(playwright.stopRecordingTraffic());
expectError(playwright.seeTraffic());
expectError(playwright.seeTraffic(str));
Expand All @@ -159,6 +162,13 @@ expectType<CodeceptJS.StepPromise>(playwright.see(str).timeout(5))
expectType<CodeceptJS.StepPromise>(playwright.see(str).retry(3))
expectType<CodeceptJS.ElementStepPromise>(playwright.click(str).first().timeout(5).retry(3))

async function stepPromiseTypes(step: CodeceptJS.StepPromise<string>, elementStep: CodeceptJS.ElementStepPromise<number>) {
expectType<string>(await step);
expectType<CodeceptJS.StepPromise<string>>(step.timeout(5).retry(3));
expectType<number>(await elementStep.first().timeout(5));
expectAssignable<CodeceptJS.StepPromise>(step);
}

async function webElementTypes(el: CodeceptJS.WebElement) {
expectType<string>(await el.getText());
expectType<string | null>(await el.getAttribute(str));
Expand Down
5 changes: 4 additions & 1 deletion typings/tests/helpers/PlaywrightTs.types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,7 @@ expectType<CodeceptJS.StepPromise>(playwright.setCookie({ name: str, value: str
expectType<CodeceptJS.StepPromise>(playwright.seeCookie(str));
expectType<CodeceptJS.StepPromise>(playwright.dontSeeCookie(str));
expectType<Promise<any>>(playwright.grabCookie());
expectType<Promise<object>>(playwright.grabStorageState());
expectType<Promise<any>>(playwright.clearCookie());
expectType<Promise<any>>(playwright.executeScript(() => {}));
expectType<Promise<string>>(playwright.grabTextFrom(str));
Expand Down Expand Up @@ -130,12 +131,14 @@ expectType<CodeceptJS.StepPromise>(playwright.switchTo());
expectType<CodeceptJS.StepPromise>(playwright.waitForFunction(() => { }));
expectType<Promise<any>>(playwright.waitForNavigation(str));
expectType<CodeceptJS.StepPromise>(playwright.waitForDetached(str));
expectType<CodeceptJS.StepPromise>(playwright.grabDataFromPerformanceTiming());
expectType<Promise<{ responseEnd: number; domInteractive: number; domContentLoadedEventEnd: number; loadEventEnd: number }>>(playwright.grabDataFromPerformanceTiming());
//expectType<Promise<number>>(playwright.grabElementBoundingRect(str));
expectType<Promise<any>>(playwright.mockRoute(str));
expectType<Promise<any>>(playwright.stopMockingRoute(str));

expectType<CodeceptJS.StepPromise>(playwright.startRecordingTraffic());
expectType<Promise<string>>(playwright.grabTrafficUrl(str));
expectType<Promise<any[]>>(playwright.grabRecordedNetworkTraffics());
expectType<Promise<any>>(playwright.stopRecordingTraffic());
expectError(playwright.seeTraffic());
expectError(playwright.seeTraffic(str));
Expand Down
6 changes: 3 additions & 3 deletions typings/tests/helpers/WebDriverIO.types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -450,15 +450,15 @@ expectType<Promise<string>>(wd.grabTitle())

expectType<Promise<string>>(wd.grabSource())

wd.grabBrowserLogs() // $ExpectType Promise<object[]> | undefined
expectType<Promise<any[]>>(wd.grabBrowserLogs())

expectType<Promise<string>>(wd.grabCurrentUrl())

expectError(wd.grabNumberOfVisibleElements())
expectType<Promise<number>>(wd.grabNumberOfVisibleElements('div'))

wd.grabCookie() // $ExpectType any
wd.grabCookie('name') // $ExpectType any
expectType<Promise<any>>(wd.grabCookie())
expectType<Promise<any>>(wd.grabCookie('name'))

expectType<Promise<string>>(wd.grabPopupText())

Expand Down
Loading