fix: modified comment for method product, platform and newPage (#7262)

This commit is contained in:
TASNEEM KOUSHAR 2021-05-24 18:44:51 +05:30 committed by GitHub
parent 8340cb7c34
commit 159d283545
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 9 additions and 5 deletions

View File

@ -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> { async newPage(): Promise<Page> {
return this._defaultContext.newPage(); return this._defaultContext.newPage();

View File

@ -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 { platform(): Platform {
return this._platform; return this._platform;
} }
/** /**
* @returns Returns the current `Product`. * @returns Returns the current `Product`, which is one of `chrome` or
* `firefox`.
*/ */
product(): Product { product(): Product {
return this._product; return this._product;

View File

@ -7,8 +7,9 @@
"extends": "./tsconfig.base.json", "extends": "./tsconfig.base.json",
"compilerOptions": { "compilerOptions": {
"noEmit": true, "noEmit": true,
// This module setting is just for VSCode so it doesn't error when we use /* This module setting is just for VSCode so it doesn't throw error when we
// dynamic imports. use dynamic imports.
*/
"module": "esnext" "module": "esnext"
}, },
"include": ["src"] "include": ["src"]