docs(new): migrate TimeoutError to TSDoc

puppeteer · Jun 22, 2020 · 1b84ae7 · 1b84ae7
1 parent 750f5ee
commit 1b84ae7
Show file tree

Hide file tree

Showing 12 changed files with 28 additions and 1 deletion.
diff --git a/new-docs/puppeteer.browser.md b/new-docs/puppeteer.browser.md
@@ -9,6 +9,7 @@
 ```typescript
 export declare class Browser extends EventEmitter 
 ```
+<b>Extends:</b> [EventEmitter](./puppeteer.eventemitter.md)
 
 ## Constructors
 

diff --git a/new-docs/puppeteer.browsercontext.md b/new-docs/puppeteer.browsercontext.md
@@ -9,6 +9,7 @@
 ```typescript
 export declare class BrowserContext extends EventEmitter 
 ```
+<b>Extends:</b> [EventEmitter](./puppeteer.eventemitter.md)
 
 ## Constructors
 

diff --git a/new-docs/puppeteer.cdpsession.md b/new-docs/puppeteer.cdpsession.md
@@ -9,6 +9,7 @@
 ```typescript
 export declare class CDPSession extends EventEmitter 
 ```
+<b>Extends:</b> [EventEmitter](./puppeteer.eventemitter.md)
 
 ## Constructors
 

diff --git a/new-docs/puppeteer.connection.md b/new-docs/puppeteer.connection.md
@@ -9,6 +9,7 @@
 ```typescript
 export declare class Connection extends EventEmitter 
 ```
+<b>Extends:</b> [EventEmitter](./puppeteer.eventemitter.md)
 
 ## Constructors
 

diff --git a/new-docs/puppeteer.elementhandle.md b/new-docs/puppeteer.elementhandle.md
@@ -9,6 +9,7 @@
 ```typescript
 export declare class ElementHandle extends JSHandle 
 ```
+<b>Extends:</b> [JSHandle](./puppeteer.jshandle.md)
 
 ## Constructors
 

diff --git a/new-docs/puppeteer.eventemitter.md b/new-docs/puppeteer.eventemitter.md
@@ -11,6 +11,7 @@ The EventEmitter class that many Puppeteer classes extend.
 ```typescript
 export declare class EventEmitter implements CommonEventEmitter 
 ```
+<b>Implements:</b> CommonEventEmitter
 
 ## Remarks
 

diff --git a/new-docs/puppeteer.framemanager.md b/new-docs/puppeteer.framemanager.md
@@ -9,6 +9,7 @@
 ```typescript
 export declare class FrameManager extends EventEmitter 
 ```
+<b>Extends:</b> [EventEmitter](./puppeteer.eventemitter.md)
 
 ## Constructors
 

diff --git 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.page.md b/new-docs/puppeteer.page.md
@@ -11,6 +11,7 @@ Page provides methods to interact with a single tab or \[extension background pa
 ```typescript
 export declare class Page extends EventEmitter 
 ```
+<b>Extends:</b> [EventEmitter](./puppeteer.eventemitter.md)
 
 ## Remarks
 

diff --git a/new-docs/puppeteer.timeouterror.md b/new-docs/puppeteer.timeouterror.md
@@ -4,8 +4,16 @@
 
 ## TimeoutError class
 
+TimeoutError is emitted whenever certain operations are terminated due to timeout.
+
 <b>Signature:</b>
 
 ```typescript
 export declare class TimeoutError extends CustomError 
 ```
+<b>Extends:</b> CustomError
+
+## Remarks
+
+Example operations are [page.waitForSelector](./puppeteer.page.waitforselector.md) or [puppeteer.launch](./puppeteer.puppeteer.launch.md)<!-- -->.
+
diff --git a/new-docs/puppeteer.webworker.md b/new-docs/puppeteer.webworker.md
@@ -11,6 +11,7 @@ The WebWorker class represents a [WebWorker](https://developer.mozilla.org/en-US
 ```typescript
 export declare class WebWorker extends EventEmitter 
 ```
+<b>Extends:</b> [EventEmitter](./puppeteer.eventemitter.md)
 
 ## Remarks
 

diff --git 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<string, typeof CustomError>;