docs(new): migrate TimeoutError to TSDoc (#6062)
* docs(new): migrate TimeoutError to TSDoc Co-authored-by: Alex Rudenko <alexrudenko@chromium.org>
This commit is contained in:
parent
ace31d6f58
commit
1cf3f06055
@ -32,7 +32,7 @@
|
|||||||
| [Puppeteer](./puppeteer.puppeteer.md) | The main Puppeteer class |
|
| [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. |
|
| [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) | |
|
| [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) | |
|
| [Touchscreen](./puppeteer.touchscreen.md) | |
|
||||||
| [Tracing](./puppeteer.tracing.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)<!-- -->. |
|
| [WebWorker](./puppeteer.webworker.md) | The WebWorker class represents a [WebWorker](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API)<!-- -->. |
|
||||||
|
@ -4,6 +4,8 @@
|
|||||||
|
|
||||||
## TimeoutError class
|
## TimeoutError class
|
||||||
|
|
||||||
|
TimeoutError is emitted whenever certain operations are terminated due to timeout.
|
||||||
|
|
||||||
<b>Signature:</b>
|
<b>Signature:</b>
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
@ -11,3 +13,7 @@ export declare class TimeoutError extends CustomError
|
|||||||
```
|
```
|
||||||
<b>Extends:</b> CustomError
|
<b>Extends:</b> CustomError
|
||||||
|
|
||||||
|
## Remarks
|
||||||
|
|
||||||
|
Example operations are [page.waitForSelector](./puppeteer.page.waitforselector.md) or [puppeteer.launch](./puppeteer.puppeteer.launch.md)<!-- -->.
|
||||||
|
|
||||||
|
@ -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 class TimeoutError extends CustomError {}
|
||||||
|
|
||||||
export type PuppeteerErrors = Record<string, typeof CustomError>;
|
export type PuppeteerErrors = Record<string, typeof CustomError>;
|
||||||
|
Loading…
Reference in New Issue
Block a user