From 7cb6059bcc36f8dc3739a8df9119c658146ac100 Mon Sep 17 00:00:00 2001 From: Alex Rudenko Date: Tue, 13 Jun 2023 13:53:48 +0200 Subject: [PATCH] fix: mark CDPSessionOnMessageObject as internal (#10373) --- docs/api/index.md | 1 - .../puppeteer.cdpsessiononmessageobject.md | 21 ------------------- .../puppeteer-core/src/common/Connection.ts | 2 +- 3 files changed, 1 insertion(+), 23 deletions(-) delete mode 100644 docs/api/puppeteer.cdpsessiononmessageobject.md diff --git a/docs/api/index.md b/docs/api/index.md index 26ee2981..cf3370d7 100644 --- a/docs/api/index.md +++ b/docs/api/index.md @@ -72,7 +72,6 @@ sidebar_label: API | [BrowserConnectOptions](./puppeteer.browserconnectoptions.md) | Generic browser options that can be passed when launching any browser or when connecting to an existing browser instance. | | [BrowserContextOptions](./puppeteer.browsercontextoptions.md) | BrowserContext options. | | [BrowserLaunchArgumentOptions](./puppeteer.browserlaunchargumentoptions.md) | Launcher options that only apply to Chrome. | -| [CDPSessionOnMessageObject](./puppeteer.cdpsessiononmessageobject.md) | | | [ClickOptions](./puppeteer.clickoptions.md) | | | [CommonEventEmitter](./puppeteer.commoneventemitter.md) | | | [Configuration](./puppeteer.configuration.md) |

Defines options to configure Puppeteer's behavior during installation and runtime.

See individual properties for more information.

| diff --git a/docs/api/puppeteer.cdpsessiononmessageobject.md b/docs/api/puppeteer.cdpsessiononmessageobject.md deleted file mode 100644 index da62304c..00000000 --- a/docs/api/puppeteer.cdpsessiononmessageobject.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -sidebar_label: CDPSessionOnMessageObject ---- - -# CDPSessionOnMessageObject interface - -#### Signature: - -```typescript -export interface CDPSessionOnMessageObject -``` - -## Properties - -| Property | Modifiers | Type | Description | Default | -| -------- | --------------------- | --------------------------------------------- | ----------- | ------- | -| error | | { message: string; data: any; code: number; } | | | -| id | optional | number | | | -| method | | string | | | -| params | | Record<string, unknown> | | | -| result | optional | any | | | diff --git a/packages/puppeteer-core/src/common/Connection.ts b/packages/puppeteer-core/src/common/Connection.ts index def84d0f..f9ea618c 100644 --- a/packages/puppeteer-core/src/common/Connection.ts +++ b/packages/puppeteer-core/src/common/Connection.ts @@ -411,7 +411,7 @@ export class Connection extends EventEmitter { } /** - * @public + * @internal */ export interface CDPSessionOnMessageObject { id?: number;