Skip to content

Commit

Permalink
chore: use '@typescript-eslint/consistent-type-definitions'
Browse files Browse the repository at this point in the history
  • Loading branch information
jrandolf committed Sep 13, 2023
1 parent b3f3199 commit 1eddb9d
Show file tree
Hide file tree
Showing 123 changed files with 1,871 additions and 1,646 deletions.
149 changes: 77 additions & 72 deletions docs/api/index.md

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions docs/api/puppeteer.browser.md
Expand Up @@ -9,16 +9,16 @@ A Browser is created when Puppeteer connects to a browser instance, either throu
#### Signature:

```typescript
export declare class Browser extends EventEmitter implements AsyncDisposable, Disposable
export declare class Browser extends EventEmitter<BrowserEvents> implements AsyncDisposable, Disposable
```
**Extends:** [EventEmitter](./puppeteer.eventemitter.md)
**Extends:** [EventEmitter](./puppeteer.eventemitter.md)&lt;[BrowserEvents](./puppeteer.browserevents.md)&gt;
**Implements:** AsyncDisposable, Disposable
## Remarks
The Browser class extends from Puppeteer's [EventEmitter](./puppeteer.eventemitter.md) class and will emit various events which are documented in the [BrowserEmittedEvents](./puppeteer.browseremittedevents.md) enum.
The Browser class extends from Puppeteer's [EventEmitter](./puppeteer.eventemitter.md) class and will emit various events which are documented in the [BrowserEvent](./puppeteer.browserevent.md) enum.
The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `Browser` class.
Expand Down
6 changes: 3 additions & 3 deletions docs/api/puppeteer.browsercontext.md
Expand Up @@ -9,14 +9,14 @@ BrowserContexts provide a way to operate multiple independent browser sessions.
#### Signature:

```typescript
export declare class BrowserContext extends EventEmitter
export declare class BrowserContext extends EventEmitter<BrowserContextEvents>
```
**Extends:** [EventEmitter](./puppeteer.eventemitter.md)
**Extends:** [EventEmitter](./puppeteer.eventemitter.md)&lt;[BrowserContextEvents](./puppeteer.browsercontextevents.md)&gt;
## Remarks
The Browser class extends from Puppeteer's [EventEmitter](./puppeteer.eventemitter.md) class and will emit various events which are documented in the [BrowserContextEmittedEvents](./puppeteer.browsercontextemittedevents.md) enum.
The Browser class extends from Puppeteer's [EventEmitter](./puppeteer.eventemitter.md) class and will emit various events which are documented in the [BrowserContextEvents](./puppeteer.browsercontextevents.md) enum.
If a page opens another page, e.g. with a `window.open` call, the popup will belong to the parent page's browser context.
Expand Down
@@ -1,13 +1,13 @@
---
sidebar_label: BrowserContextEmittedEvents
sidebar_label: BrowserContextEvent
---

# BrowserContextEmittedEvents enum
# BrowserContextEvent enum

#### Signature:

```typescript
export declare const enum BrowserContextEmittedEvents
export declare const enum BrowserContextEvent
```

## Enumeration Members
Expand Down
21 changes: 21 additions & 0 deletions docs/api/puppeteer.browsercontextevents.md
@@ -0,0 +1,21 @@
---
sidebar_label: BrowserContextEvents
---

# BrowserContextEvents interface

#### Signature:

```typescript
export interface BrowserContextEvents extends Record<EventType, unknown>
```
**Extends:** Record&lt;EventType, unknown&gt;
## Properties
| Property | Modifiers | Type | Description | Default |
| --------------- | --------- | ------------------------------- | ----------- | ------- |
| targetchanged | | [Target](./puppeteer.target.md) | | |
| targetcreated | | [Target](./puppeteer.target.md) | | |
| targetdestroyed | | [Target](./puppeteer.target.md) | | |
@@ -1,15 +1,15 @@
---
sidebar_label: BrowserEmittedEvents
sidebar_label: BrowserEvent
---

# BrowserEmittedEvents enum
# BrowserEvent enum

All the events a [browser instance](./puppeteer.browser.md) may emit.

#### Signature:

```typescript
export declare const enum BrowserEmittedEvents
export declare const enum BrowserEvent
```

## Enumeration Members
Expand Down
22 changes: 22 additions & 0 deletions docs/api/puppeteer.browserevents.md
@@ -0,0 +1,22 @@
---
sidebar_label: BrowserEvents
---

# BrowserEvents interface

#### Signature:

```typescript
export interface BrowserEvents extends Record<EventType, unknown>
```
**Extends:** Record&lt;EventType, unknown&gt;
## Properties
| Property | Modifiers | Type | Description | Default |
| --------------- | --------- | ------------------------------- | ----------- | ------- |
| disconnected | | undefined | | |
| targetchanged | | [Target](./puppeteer.target.md) | | |
| targetcreated | | [Target](./puppeteer.target.md) | | |
| targetdestroyed | | [Target](./puppeteer.target.md) | | |
13 changes: 13 additions & 0 deletions docs/api/puppeteer.cdpevents.md
@@ -0,0 +1,13 @@
---
sidebar_label: CDPEvents
---

# CDPEvents type

#### Signature:

```typescript
export type CDPEvents = {
[Property in keyof ProtocolMapping.Events]: ProtocolMapping.Events[Property][0];
};
```
4 changes: 2 additions & 2 deletions docs/api/puppeteer.cdpsession.md
Expand Up @@ -9,10 +9,10 @@ The `CDPSession` instances are used to talk raw Chrome Devtools Protocol.
#### Signature:

```typescript
export declare class CDPSession extends EventEmitter
export declare abstract class CDPSession extends EventEmitter<CDPSessionEvents>
```
**Extends:** [EventEmitter](./puppeteer.eventemitter.md)
**Extends:** [EventEmitter](./puppeteer.eventemitter.md)&lt;[CDPSessionEvents](./puppeteer.cdpsessionevents.md)&gt;
## Remarks
Expand Down
13 changes: 13 additions & 0 deletions docs/api/puppeteer.cdpsessionevents.md
@@ -0,0 +1,13 @@
---
sidebar_label: CDPSessionEvents
---

# CDPSessionEvents interface

#### Signature:

```typescript
export interface CDPSessionEvents extends CDPEvents, Record<EventType, unknown>
```
**Extends:** [CDPEvents](./puppeteer.cdpevents.md), Record&lt;EventType, unknown&gt;
13 changes: 8 additions & 5 deletions docs/api/puppeteer.commoneventemitter.addlistener.md
Expand Up @@ -8,16 +8,19 @@ sidebar_label: CommonEventEmitter.addListener

```typescript
interface CommonEventEmitter {
addListener(event: EventType, handler: Handler): this;
addListener<Key extends keyof Events>(
type: Key,
handler: Handler<Events[Key]>
): this;
}
```

## Parameters

| Parameter | Type | Description |
| --------- | ------------------------------------- | ----------- |
| event | [EventType](./puppeteer.eventtype.md) | |
| handler | [Handler](./puppeteer.handler.md) | |
| Parameter | Type | Description |
| --------- | ------------------------------------------------------ | ----------- |
| type | Key | |
| handler | [Handler](./puppeteer.handler.md)&lt;Events\[Key\]&gt; | |

**Returns:**

Expand Down
10 changes: 5 additions & 5 deletions docs/api/puppeteer.commoneventemitter.emit.md
Expand Up @@ -8,16 +8,16 @@ sidebar_label: CommonEventEmitter.emit

```typescript
interface CommonEventEmitter {
emit(event: EventType, eventData?: unknown): boolean;
emit<Key extends keyof Events>(type: Key, event: Events[Key]): boolean;
}
```

## Parameters

| Parameter | Type | Description |
| --------- | ------------------------------------- | ------------ |
| event | [EventType](./puppeteer.eventtype.md) | |
| eventData | unknown | _(Optional)_ |
| Parameter | Type | Description |
| --------- | ------------- | ----------- |
| type | Key | |
| event | Events\[Key\] | |

**Returns:**

Expand Down
8 changes: 4 additions & 4 deletions docs/api/puppeteer.commoneventemitter.listenercount.md
Expand Up @@ -8,15 +8,15 @@ sidebar_label: CommonEventEmitter.listenerCount

```typescript
interface CommonEventEmitter {
listenerCount(event: string): number;
listenerCount(event: keyof Events): number;
}
```

## Parameters

| Parameter | Type | Description |
| --------- | ------ | ----------- |
| event | string | |
| Parameter | Type | Description |
| --------- | ------------ | ----------- |
| event | keyof Events | |

**Returns:**

Expand Down
22 changes: 11 additions & 11 deletions docs/api/puppeteer.commoneventemitter.md
Expand Up @@ -7,18 +7,18 @@ sidebar_label: CommonEventEmitter
#### Signature:

```typescript
export interface CommonEventEmitter
export interface CommonEventEmitter<Events extends Record<EventType, unknown>>
```

## Methods

| Method | Description |
| ---------------------------------------------------------------------------------- | ----------- |
| [addListener(event, handler)](./puppeteer.commoneventemitter.addlistener.md) | |
| [emit(event, eventData)](./puppeteer.commoneventemitter.emit.md) | |
| [listenerCount(event)](./puppeteer.commoneventemitter.listenercount.md) | |
| [off(event, handler)](./puppeteer.commoneventemitter.off.md) | |
| [on(event, handler)](./puppeteer.commoneventemitter.on.md) | |
| [once(event, handler)](./puppeteer.commoneventemitter.once.md) | |
| [removeAllListeners(event)](./puppeteer.commoneventemitter.removealllisteners.md) | |
| [removeListener(event, handler)](./puppeteer.commoneventemitter.removelistener.md) | |
| Method | Description |
| --------------------------------------------------------------------------------- | ----------- |
| [addListener(type, handler)](./puppeteer.commoneventemitter.addlistener.md) | |
| [emit(type, event)](./puppeteer.commoneventemitter.emit.md) | |
| [listenerCount(event)](./puppeteer.commoneventemitter.listenercount.md) | |
| [off(type, handler)](./puppeteer.commoneventemitter.off.md) | |
| [on(type, handler)](./puppeteer.commoneventemitter.on.md) | |
| [once(type, handler)](./puppeteer.commoneventemitter.once.md) | |
| [removeAllListeners(event)](./puppeteer.commoneventemitter.removealllisteners.md) | |
| [removeListener(type, handler)](./puppeteer.commoneventemitter.removelistener.md) | |
13 changes: 8 additions & 5 deletions docs/api/puppeteer.commoneventemitter.off.md
Expand Up @@ -8,16 +8,19 @@ sidebar_label: CommonEventEmitter.off

```typescript
interface CommonEventEmitter {
off(event: EventType, handler: Handler): this;
off<Key extends keyof Events>(
type: Key,
handler?: Handler<Events[Key]>
): this;
}
```

## Parameters

| Parameter | Type | Description |
| --------- | ------------------------------------- | ----------- |
| event | [EventType](./puppeteer.eventtype.md) | |
| handler | [Handler](./puppeteer.handler.md) | |
| Parameter | Type | Description |
| --------- | ------------------------------------------------------ | ------------ |
| type | Key | |
| handler | [Handler](./puppeteer.handler.md)&lt;Events\[Key\]&gt; | _(Optional)_ |

**Returns:**

Expand Down
10 changes: 5 additions & 5 deletions docs/api/puppeteer.commoneventemitter.on.md
Expand Up @@ -8,16 +8,16 @@ sidebar_label: CommonEventEmitter.on

```typescript
interface CommonEventEmitter {
on(event: EventType, handler: Handler): this;
on<Key extends keyof Events>(type: Key, handler: Handler<Events[Key]>): this;
}
```

## Parameters

| Parameter | Type | Description |
| --------- | ------------------------------------- | ----------- |
| event | [EventType](./puppeteer.eventtype.md) | |
| handler | [Handler](./puppeteer.handler.md) | |
| Parameter | Type | Description |
| --------- | ------------------------------------------------------ | ----------- |
| type | Key | |
| handler | [Handler](./puppeteer.handler.md)&lt;Events\[Key\]&gt; | |

**Returns:**

Expand Down
13 changes: 8 additions & 5 deletions docs/api/puppeteer.commoneventemitter.once.md
Expand Up @@ -8,16 +8,19 @@ sidebar_label: CommonEventEmitter.once

```typescript
interface CommonEventEmitter {
once(event: EventType, handler: Handler): this;
once<Key extends keyof Events>(
type: Key,
handler: Handler<Events[Key]>
): this;
}
```

## Parameters

| Parameter | Type | Description |
| --------- | ------------------------------------- | ----------- |
| event | [EventType](./puppeteer.eventtype.md) | |
| handler | [Handler](./puppeteer.handler.md) | |
| Parameter | Type | Description |
| --------- | ------------------------------------------------------ | ----------- |
| type | Key | |
| handler | [Handler](./puppeteer.handler.md)&lt;Events\[Key\]&gt; | |

**Returns:**

Expand Down
8 changes: 4 additions & 4 deletions docs/api/puppeteer.commoneventemitter.removealllisteners.md
Expand Up @@ -8,15 +8,15 @@ sidebar_label: CommonEventEmitter.removeAllListeners

```typescript
interface CommonEventEmitter {
removeAllListeners(event?: EventType): this;
removeAllListeners(event?: keyof Events): this;
}
```

## Parameters

| Parameter | Type | Description |
| --------- | ------------------------------------- | ------------ |
| event | [EventType](./puppeteer.eventtype.md) | _(Optional)_ |
| Parameter | Type | Description |
| --------- | ------------ | ------------ |
| event | keyof Events | _(Optional)_ |

**Returns:**

Expand Down
13 changes: 8 additions & 5 deletions docs/api/puppeteer.commoneventemitter.removelistener.md
Expand Up @@ -8,16 +8,19 @@ sidebar_label: CommonEventEmitter.removeListener

```typescript
interface CommonEventEmitter {
removeListener(event: EventType, handler: Handler): this;
removeListener<Key extends keyof Events>(
type: Key,
handler: Handler<Events[Key]>
): this;
}
```

## Parameters

| Parameter | Type | Description |
| --------- | ------------------------------------- | ----------- |
| event | [EventType](./puppeteer.eventtype.md) | |
| handler | [Handler](./puppeteer.handler.md) | |
| Parameter | Type | Description |
| --------- | ------------------------------------------------------ | ----------- |
| type | Key | |
| handler | [Handler](./puppeteer.handler.md)&lt;Events\[Key\]&gt; | |

**Returns:**

Expand Down
4 changes: 2 additions & 2 deletions docs/api/puppeteer.connection.md
Expand Up @@ -7,10 +7,10 @@ sidebar_label: Connection
#### Signature:

```typescript
export declare class Connection extends EventEmitter
export declare class Connection extends EventEmitter<CDPSessionEvents>
```
**Extends:** [EventEmitter](./puppeteer.eventemitter.md)
**Extends:** [EventEmitter](./puppeteer.eventemitter.md)&lt;[CDPSessionEvents](./puppeteer.cdpsessionevents.md)&gt;
## Constructors
Expand Down

0 comments on commit 1eddb9d

Please sign in to comment.