From 159d2835450697dabea6f9adf6e67d158b5b8ae3 Mon Sep 17 00:00:00 2001 From: TASNEEM KOUSHAR Date: Mon, 24 May 2021 18:44:51 +0530 Subject: [PATCH] fix: modified comment for method product, platform and newPage (#7262) --- src/common/Browser.ts | 3 ++- src/node/BrowserFetcher.ts | 6 ++++-- tsconfig.json | 5 +++-- 3 files changed, 9 insertions(+), 5 deletions(-) diff --git a/src/common/Browser.ts b/src/common/Browser.ts index 153c545b7884f..d9c9d29737a1f 100644 --- a/src/common/Browser.ts +++ b/src/common/Browser.ts @@ -417,7 +417,8 @@ export class Browser extends EventEmitter { } /** - * Creates a {@link Page} in the default browser context. + * Promise which resolves to a new {@link Page} object. The Page is created in + * a default browser context. */ async newPage(): Promise { return this._defaultContext.newPage(); diff --git a/src/node/BrowserFetcher.ts b/src/node/BrowserFetcher.ts index 0d22e3386a403..20301e2462142 100644 --- a/src/node/BrowserFetcher.ts +++ b/src/node/BrowserFetcher.ts @@ -220,14 +220,16 @@ export class BrowserFetcher { } /** - * @returns Returns the current `Platform`. + * @returns Returns the current `Platform`, which is one of `mac`, `linux`, + * `win32` or `win64`. */ platform(): Platform { return this._platform; } /** - * @returns Returns the current `Product`. + * @returns Returns the current `Product`, which is one of `chrome` or + * `firefox`. */ product(): Product { return this._product; diff --git a/tsconfig.json b/tsconfig.json index d35ef12857dcf..0fe7e06ad83c7 100644 --- a/tsconfig.json +++ b/tsconfig.json @@ -7,8 +7,9 @@ "extends": "./tsconfig.base.json", "compilerOptions": { "noEmit": true, - // This module setting is just for VSCode so it doesn't error when we use - // dynamic imports. + /* This module setting is just for VSCode so it doesn't throw error when we + use dynamic imports. + */ "module": "esnext" }, "include": ["src"]