Skip to content

Commit

Permalink
fix: modified comment for method product, platform and newPage (#7262)
Browse files Browse the repository at this point in the history
  • Loading branch information
tasneemkoushar committed May 24, 2021
1 parent 8340cb7 commit 159d283
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 5 deletions.
3 changes: 2 additions & 1 deletion src/common/Browser.ts
Expand Up @@ -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<Page> {
return this._defaultContext.newPage();
Expand Down
6 changes: 4 additions & 2 deletions src/node/BrowserFetcher.ts
Expand Up @@ -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;
Expand Down
5 changes: 3 additions & 2 deletions tsconfig.json
Expand Up @@ -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"]
Expand Down

0 comments on commit 159d283

Please sign in to comment.