github/puppeteer
0
0
Fork 0
mirror of https://github.com/puppeteer/puppeteer synced 2024-06-14 14:02:48 +00:00
Code Issues Packages Projects Releases Wiki Activity

fix: make CDPSessionEvent.SessionAttached public (#10941)

Browse Source
This commit is contained in:
jrandolf 2023-09-19 17:42:40 +02:00 committed by GitHub
parent 88e0997b39
commit cfed7b93ec
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
6 changed files with 63 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/api/index.md
View File

@ -134,6 +134,12 @@ sidebar_label: API
| [WaitForTargetOptions](./puppeteer.waitfortargetoptions.md) | |
| [WaitTimeoutOptions](./puppeteer.waittimeoutoptions.md) | |
## Namespaces
| Namespace | Description |
| ------------------------------------------------- | --------------------------------------- |
| [CDPSessionEvent](./puppeteer.cdpsessionevent.md) | Events that the CDPSession class emits. |
## Variables
| Variable | Description |

20
docs/api/puppeteer.cdpsessionevent.md Normal file
View File

@ -0,0 +1,20 @@
---
sidebar_label: CDPSessionEvent
---
# CDPSessionEvent namespace
Events that the CDPSession class emits.
#### Signature:
```typescript
export declare namespace CDPSessionEvent
```
## Variables
| Variable | Description |
| ----------------------------------------------------------------- | ----------- |
| [SessionAttached](./puppeteer.cdpsessionevent.sessionattached.md) | |
| [SessionDetached](./puppeteer.cdpsessionevent.sessiondetached.md) | |

11
docs/api/puppeteer.cdpsessionevent.sessionattached.md Normal file
View File

@ -0,0 +1,11 @@
---
sidebar_label: CDPSessionEvent.SessionAttached
---
# CDPSessionEvent.SessionAttached variable
#### Signature:
```typescript
SessionAttached: 'sessionattached';
```

11
docs/api/puppeteer.cdpsessionevent.sessiondetached.md Normal file
View File

@ -0,0 +1,11 @@
---
sidebar_label: CDPSessionEvent.SessionDetached
---
# CDPSessionEvent.SessionDetached variable
#### Signature:
```typescript
SessionDetached: 'sessiondetached';
```

7
docs/api/puppeteer.cdpsessionevents.md
View File

@ -11,3 +11,10 @@ export interface CDPSessionEvents extends CDPEvents, Record<EventType, unknown>
```
**Extends:** [CDPEvents](./puppeteer.cdpevents.md), Record&lt;EventType, unknown&gt;
## Properties
| Property | Modifiers | Type | Description | Default |
| --------------- | --------- | --------------------------------------- | ----------- | ------- |
| sessionattached | | [CDPSession](./puppeteer.cdpsession.md) | | |
| sessiondetached | | [CDPSession](./puppeteer.cdpsession.md) | | |

14
packages/puppeteer-core/src/api/CDPSession.ts
View File

@ -11,21 +11,25 @@ export type CDPEvents = {
};
/**
* Internal events that the CDPSession class emits.
* Events that the CDPSession class emits.
*
* @internal
* @public
*/
// eslint-disable-next-line @typescript-eslint/no-namespace
export namespace CDPSessionEvent {
/** @internal */
export const Disconnected = Symbol('CDPSession.Disconnected');
/** @internal */
export const Swapped = Symbol('CDPSession.Swapped');
/**
* Emitted when the session is ready to be configured during the auto-attach
* process. Right after the event is handled, the session will be resumed.
*
* @internal
*/
export const Ready = Symbol('CDPSession.Ready');
export const SessionAttached = Symbol('CDPSession.SessionAttached');
export const SessionDetached = Symbol('CDPSession.SessionDetached');
export const SessionAttached = 'sessionattached' as const;
export const SessionDetached = 'sessiondetached' as const;
}
/**
@ -40,9 +44,7 @@ export interface CDPSessionEvents
[CDPSessionEvent.Swapped]: CDPSession;
/** @internal */
[CDPSessionEvent.Ready]: CDPSession;
/** @internal */
[CDPSessionEvent.SessionAttached]: CDPSession;
/** @internal */
[CDPSessionEvent.SessionDetached]: CDPSession;
}