chore: remove more ts-doc warnings (#7422)

This commit is contained in:
TASNEEM KOUSHAR 2021-07-19 15:09:40 +05:30 committed by GitHub
parent dd470c7a22
commit c65b10c524
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 12 additions and 8 deletions

View File

@ -123,8 +123,8 @@ export class Coverage {
} }
/** /**
* @param options - Set of configurable options for coverage defaults to `{ * @param options - Set of configurable options for coverage defaults to
* resetOnNavigation : true, reportAnonymousScripts : false }` * `resetOnNavigation : true, reportAnonymousScripts : false`
* @returns Promise that resolves when coverage is started. * @returns Promise that resolves when coverage is started.
* *
* @remarks * @remarks
@ -150,8 +150,8 @@ export class Coverage {
} }
/** /**
* @param options - Set of configurable options for coverage, defaults to `{ * @param options - Set of configurable options for coverage, defaults to
* resetOnNavigation : true }` * `resetOnNavigation : true`
* @returns Promise that resolves when coverage is started. * @returns Promise that resolves when coverage is started.
*/ */
async startCSSCoverage(options: CSSCoverageOptions = {}): Promise<void> { async startCSSCoverage(options: CSSCoverageOptions = {}): Promise<void> {

View File

@ -641,6 +641,9 @@ const errorReasons: Record<ErrorCode, Protocol.Network.ErrorReason> = {
failed: 'Failed', failed: 'Failed',
} as const; } as const;
/**
* @public
*/
export type ActionResult = 'continue' | 'abort' | 'respond'; export type ActionResult = 'continue' | 'abort' | 'respond';
function headersArray( function headersArray(

View File

@ -2718,8 +2718,8 @@ export class Page extends EventEmitter {
} }
/** /**
* @param {!PDFOptions=} options - * @param options -
* @returns {!Promise<!Buffer>} * @returns
*/ */
async pdf(options: PDFOptions = {}): Promise<Buffer> { async pdf(options: PDFOptions = {}): Promise<Buffer> {
const { path = undefined } = options; const { path = undefined } = options;
@ -2897,7 +2897,6 @@ export class Page extends EventEmitter {
* key presses in milliseconds. Defaults to `0`. * key presses in milliseconds. Defaults to `0`.
* @returns * @returns
* @remarks * @remarks
* Shortcut for {@link page.mainFrame().type(selector, text[, options])}
*/ */
type( type(
selector: string, selector: string,

View File

@ -45,7 +45,9 @@ export interface BrowserLaunchArgumentOptions {
*/ */
args?: string[]; args?: string[];
} }
/**
* @public
*/
export type ChromeReleaseChannel = export type ChromeReleaseChannel =
| 'chrome' | 'chrome'
| 'chrome-beta' | 'chrome-beta'