From ce34c0a4ff5c130216a70a30e95949be661e0b87 Mon Sep 17 00:00:00 2001 From: Jack Franklin Date: Thu, 18 Jun 2020 12:44:46 +0100 Subject: [PATCH] fix: `page.goto` options type should be optional (#6038) The TypeScript definition erroneously made `options` required. We can fix it by providing a default value, which means users calling the function will be able to leave it blank without TS complaining. Issues like this are a +1 to porting our tests to TypeScript in order to catch these on our own test suite, so that's something we should look into. --- new-docs/puppeteer.frame.goto.md | 2 +- new-docs/puppeteer.page.goto.md | 2 +- src/FrameManager.ts | 2 +- src/Page.ts | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/new-docs/puppeteer.frame.goto.md b/new-docs/puppeteer.frame.goto.md index b98308a45c159..2395e11156865 100644 --- a/new-docs/puppeteer.frame.goto.md +++ b/new-docs/puppeteer.frame.goto.md @@ -7,7 +7,7 @@ Signature: ```typescript -goto(url: string, options: { +goto(url: string, options?: { referer?: string; timeout?: number; waitUntil?: PuppeteerLifeCycleEvent | PuppeteerLifeCycleEvent[]; diff --git a/new-docs/puppeteer.page.goto.md b/new-docs/puppeteer.page.goto.md index 3463d9b8377dd..f43ef671511ab 100644 --- a/new-docs/puppeteer.page.goto.md +++ b/new-docs/puppeteer.page.goto.md @@ -7,7 +7,7 @@ Signature: ```typescript -goto(url: string, options: WaitForOptions & { +goto(url: string, options?: WaitForOptions & { referer?: string; }): Promise; ``` diff --git a/src/FrameManager.ts b/src/FrameManager.ts index 3ac37085ba73e..e50617bff208b 100644 --- a/src/FrameManager.ts +++ b/src/FrameManager.ts @@ -412,7 +412,7 @@ export class Frame { referer?: string; timeout?: number; waitUntil?: PuppeteerLifeCycleEvent | PuppeteerLifeCycleEvent[]; - } + } = {} ): Promise { return await this._frameManager.navigateFrame(this, url, options); } diff --git a/src/Page.ts b/src/Page.ts index c5f51179e80bd..79bb1d51f8da2 100644 --- a/src/Page.ts +++ b/src/Page.ts @@ -838,7 +838,7 @@ export class Page extends EventEmitter { async goto( url: string, - options: WaitForOptions & { referer?: string } + options: WaitForOptions & { referer?: string } = {} ): Promise { return await this._frameManager.mainFrame().goto(url, options); }