diff --git a/new-docs/puppeteer.md b/new-docs/puppeteer.md index a7f0e556d40de..d6ba6af699f70 100644 --- a/new-docs/puppeteer.md +++ b/new-docs/puppeteer.md @@ -32,7 +32,7 @@ | [Puppeteer](./puppeteer.puppeteer.md) | The main Puppeteer class | | [SecurityDetails](./puppeteer.securitydetails.md) | The SecurityDetails class represents the security details of a response that was received over a secure connection. | | [Target](./puppeteer.target.md) | | -| [TimeoutError](./puppeteer.timeouterror.md) | | +| [TimeoutError](./puppeteer.timeouterror.md) | TimeoutError is emitted whenever certain operations are terminated due to timeout. | | [Touchscreen](./puppeteer.touchscreen.md) | | | [Tracing](./puppeteer.tracing.md) | | | [WebWorker](./puppeteer.webworker.md) | The WebWorker class represents a [WebWorker](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API). | diff --git a/new-docs/puppeteer.timeouterror.md b/new-docs/puppeteer.timeouterror.md index 180d854666408..10ceabbef546f 100644 --- a/new-docs/puppeteer.timeouterror.md +++ b/new-docs/puppeteer.timeouterror.md @@ -4,6 +4,8 @@ ## TimeoutError class +TimeoutError is emitted whenever certain operations are terminated due to timeout. + Signature: ```typescript @@ -11,3 +13,7 @@ export declare class TimeoutError extends CustomError ``` Extends: CustomError +## Remarks + +Example operations are [page.waitForSelector](./puppeteer.page.waitforselector.md) or [puppeteer.launch](./puppeteer.puppeteer.launch.md). + diff --git a/src/common/Errors.ts b/src/common/Errors.ts index 48bf3f2a830d7..6b0bb79c7b80d 100644 --- a/src/common/Errors.ts +++ b/src/common/Errors.ts @@ -22,6 +22,16 @@ class CustomError extends Error { } } +/** + * TimeoutError is emitted whenever certain operations are terminated due to timeout. + * + * @remarks + * + * Example operations are {@link Page.waitForSelector | page.waitForSelector} + * or {@link Puppeteer.launch | puppeteer.launch}. + * + * @public + */ export class TimeoutError extends CustomError {} export type PuppeteerErrors = Record;