From ace31d6f588c62ea53c62821f26b238d61f312cf Mon Sep 17 00:00:00 2001 From: Jack Franklin Date: Mon, 22 Jun 2020 09:16:51 +0100 Subject: [PATCH] chore: pin TSDoc related dependencies (#6063) Without the API-* dependencies pinned different versions may be installed on local machines vs CI. One of the checks we do is to check that the checked in docs matches what is generated on CI. Therefore we need to ensure devs locally run the exact version that CI runs such that they generate the same output. So in this case we pin to a particular version of the dependencies. --- new-docs/puppeteer.browser.md | 1 + new-docs/puppeteer.browsercontext.md | 1 + new-docs/puppeteer.cdpsession.md | 1 + new-docs/puppeteer.connection.md | 1 + new-docs/puppeteer.elementhandle.md | 1 + new-docs/puppeteer.eventemitter.md | 1 + new-docs/puppeteer.framemanager.md | 1 + new-docs/puppeteer.page.md | 1 + new-docs/puppeteer.timeouterror.md | 2 ++ new-docs/puppeteer.webworker.md | 1 + package.json | 4 ++-- 11 files changed, 13 insertions(+), 2 deletions(-) diff --git a/new-docs/puppeteer.browser.md b/new-docs/puppeteer.browser.md index d04f7335c0a..4c669ee5802 100644 --- a/new-docs/puppeteer.browser.md +++ b/new-docs/puppeteer.browser.md @@ -9,6 +9,7 @@ ```typescript export declare class Browser extends EventEmitter ``` +Extends: [EventEmitter](./puppeteer.eventemitter.md) ## Constructors diff --git a/new-docs/puppeteer.browsercontext.md b/new-docs/puppeteer.browsercontext.md index 68a9b828447..393509a20ef 100644 --- a/new-docs/puppeteer.browsercontext.md +++ b/new-docs/puppeteer.browsercontext.md @@ -9,6 +9,7 @@ ```typescript export declare class BrowserContext extends EventEmitter ``` +Extends: [EventEmitter](./puppeteer.eventemitter.md) ## Constructors diff --git a/new-docs/puppeteer.cdpsession.md b/new-docs/puppeteer.cdpsession.md index cca7a990426..1f3987c67c3 100644 --- a/new-docs/puppeteer.cdpsession.md +++ b/new-docs/puppeteer.cdpsession.md @@ -9,6 +9,7 @@ ```typescript export declare class CDPSession extends EventEmitter ``` +Extends: [EventEmitter](./puppeteer.eventemitter.md) ## Constructors diff --git a/new-docs/puppeteer.connection.md b/new-docs/puppeteer.connection.md index 3fb04345462..75fff814e8c 100644 --- a/new-docs/puppeteer.connection.md +++ b/new-docs/puppeteer.connection.md @@ -9,6 +9,7 @@ ```typescript export declare class Connection extends EventEmitter ``` +Extends: [EventEmitter](./puppeteer.eventemitter.md) ## Constructors diff --git a/new-docs/puppeteer.elementhandle.md b/new-docs/puppeteer.elementhandle.md index 6280f20a453..a5b14ac0d91 100644 --- a/new-docs/puppeteer.elementhandle.md +++ b/new-docs/puppeteer.elementhandle.md @@ -9,6 +9,7 @@ ```typescript export declare class ElementHandle extends JSHandle ``` +Extends: [JSHandle](./puppeteer.jshandle.md) ## Constructors diff --git a/new-docs/puppeteer.eventemitter.md b/new-docs/puppeteer.eventemitter.md index 9937c5b2aca..99d26ef45a8 100644 --- 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 ``` +Implements: CommonEventEmitter ## Remarks diff --git a/new-docs/puppeteer.framemanager.md b/new-docs/puppeteer.framemanager.md index d5322f6fe56..f1563870ebe 100644 --- a/new-docs/puppeteer.framemanager.md +++ b/new-docs/puppeteer.framemanager.md @@ -9,6 +9,7 @@ ```typescript export declare class FrameManager extends EventEmitter ``` +Extends: [EventEmitter](./puppeteer.eventemitter.md) ## Constructors diff --git a/new-docs/puppeteer.page.md b/new-docs/puppeteer.page.md index 0277bffd267..fc1c7965b27 100644 --- 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 ``` +Extends: [EventEmitter](./puppeteer.eventemitter.md) ## Remarks diff --git a/new-docs/puppeteer.timeouterror.md b/new-docs/puppeteer.timeouterror.md index d8643e1f925..180d8546664 100644 --- a/new-docs/puppeteer.timeouterror.md +++ b/new-docs/puppeteer.timeouterror.md @@ -9,3 +9,5 @@ ```typescript export declare class TimeoutError extends CustomError ``` +Extends: CustomError + diff --git a/new-docs/puppeteer.webworker.md b/new-docs/puppeteer.webworker.md index 771e1d3bea5..23f649c1501 100644 --- 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 ``` +Extends: [EventEmitter](./puppeteer.eventemitter.md) ## Remarks diff --git a/package.json b/package.json index ab58f3a46e9..80a1f4a861c 100644 --- a/package.json +++ b/package.json @@ -59,8 +59,8 @@ "ws": "^7.2.3" }, "devDependencies": { - "@microsoft/api-documenter": "^7.8.8", - "@microsoft/api-extractor": "^7.8.8", + "@microsoft/api-documenter": "7.8.14", + "@microsoft/api-extractor": "7.8.12", "@types/debug": "0.0.31", "@types/mime": "^2.0.0", "@types/node": "^10.17.14",