Skip to content

Commit

Permalink
chore: generate versioned docs
Browse files Browse the repository at this point in the history
  • Loading branch information
release-please[bot] committed Apr 4, 2024
1 parent bcb561d commit 9c78e44
Show file tree
Hide file tree
Showing 582 changed files with 167 additions and 24 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -437,6 +437,10 @@ Description

</td><td>

**Deprecated:**

Import [Puppeteer](./puppeteer.puppeteer.md) and use the static method [Puppeteer.clearCustomQueryHandlers()](./puppeteer.puppeteer.clearcustomqueryhandlers.md)

</td></tr>
<tr><td>

Expand All @@ -451,6 +455,10 @@ Description

</td><td>

**Deprecated:**

Import [Puppeteer](./puppeteer.puppeteer.md) and use the static method [Puppeteer.customQueryHandlerNames()](./puppeteer.puppeteer.customqueryhandlernames.md)

</td></tr>
<tr><td>

Expand Down Expand Up @@ -479,6 +487,10 @@ Description

</td><td>

**Deprecated:**

Import [Puppeteer](./puppeteer.puppeteer.md) and use the static method [Puppeteer.registerCustomQueryHandler()](./puppeteer.puppeteer.registercustomqueryhandler.md)

</td></tr>
<tr><td>

Expand All @@ -493,6 +505,10 @@ Description

</td><td>

**Deprecated:**

Import [Puppeteer](./puppeteer.puppeteer.md) and use the static method [Puppeteer.unregisterCustomQueryHandler()](./puppeteer.puppeteer.unregistercustomqueryhandler.md)

</td></tr>
</tbody></table>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -189,10 +189,16 @@ Disconnects Puppeteer from this [browser](./puppeteer.browser.md), but leaves th
</td><td>
`deprecated`
</td><td>
Whether Puppeteer is connected to this [browser](./puppeteer.browser.md).
**Deprecated:**
Use [Browser.connected](./puppeteer.browser.md).
</td></tr>
<tr><td>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -148,12 +148,18 @@ Closes this [browser context](./puppeteer.browsercontext.md) and all associated
</td><td>
`deprecated`
</td><td>
Whether this [browser context](./puppeteer.browsercontext.md) is incognito.
In Chrome, the [default browser context](./puppeteer.browser.defaultbrowsercontext.md) is the only non-incognito browser context.
**Deprecated:**
In Chrome, the [default browser context](./puppeteer.browser.defaultbrowsercontext.md) can also be "icognito" if configured via the arguments and in such cases this getter returns wrong results (see https://github.com/puppeteer/puppeteer/issues/8836). Also, the term "incognito" is not applicable to other browsers. To migrate, check the [default browser context](./puppeteer.browser.defaultbrowsercontext.md) instead: in Chrome all non-default contexts are incognito, and the default context might be incognito if you provide the `--incognito` argument when launching the browser.
</td></tr>
<tr><td>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -232,26 +232,44 @@ Drags an element over the given element or point.
</td><td>
`deprecated`
</td><td>
**Deprecated:**
Use `ElementHandle.drop` instead.
</td></tr>
<tr><td>
[dragEnter(this, data)](./puppeteer.elementhandle.dragenter.md)
</td><td>
`deprecated`
</td><td>
**Deprecated:**
Do not use. `dragenter` will automatically be performed during dragging.
</td></tr>
<tr><td>
[dragOver(this, data)](./puppeteer.elementhandle.dragover.md)
</td><td>
`deprecated`
</td><td>
**Deprecated:**
Do not use. `dragover` will automatically be performed during dragging.
</td></tr>
<tr><td>
Expand All @@ -270,8 +288,14 @@ Drops the given element onto the current one.
</td><td>
`deprecated`
</td><td>
**Deprecated:**
No longer supported.
</td></tr>
<tr><td>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -296,10 +296,16 @@ Hovers the pointer over the center of the first element that matches the `select
</td><td>
`deprecated`
</td><td>
Is`true` if the frame has been detached. Otherwise, `false`.
**Deprecated:**
Use the `detached` getter.
</td></tr>
<tr><td>
Expand Down Expand Up @@ -340,10 +346,21 @@ Creates a locator for the provided function. See [Locator](./puppeteer.locator.m
</td><td>
`deprecated`
</td><td>
The frame's `name` attribute as specified in the tag.
**Deprecated:**
Use
```ts
const element = await frame.frameElement();
const nameOrId = await element.evaluate(frame => frame.name ?? frame.id);
```
</td></tr>
<tr><td>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Aborts a request.

```typescript
class HTTPRequest {
abstract abort(errorCode?: ErrorCode, priority?: number): Promise<void>;
abort(errorCode?: ErrorCode, priority?: number): Promise<void>;
}
```

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ The most recent reason for aborting the request

```typescript
class HTTPRequest {
abstract abortErrorReason(): Protocol.Network.ErrorReason | null;
abortErrorReason(): Protocol.Network.ErrorReason | null;
}
```

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Continues request with optional request overrides.

```typescript
class HTTPRequest {
abstract continue(
continue(
overrides?: ContinueRequestOverrides,
priority?: number
): Promise<void>;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ The `ContinueRequestOverrides` that will be used if the interception is allowed

```typescript
class HTTPRequest {
abstract continueRequestOverrides(): ContinueRequestOverrides;
continueRequestOverrides(): ContinueRequestOverrides;
}
```

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Adds an async request handler to the processing queue. Deferred handlers are not

```typescript
class HTTPRequest {
abstract enqueueInterceptAction(
enqueueInterceptAction(
pendingHandler: () => void | PromiseLike<unknown>
): void;
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Awaits pending interception handlers and then decides how to fulfill the request

```typescript
class HTTPRequest {
abstract finalizeInterceptions(): Promise<void>;
finalizeInterceptions(): Promise<void>;
}
```

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ InterceptResolutionAction is one of: `abort`, `respond`, `continue`, `disabled`,

```typescript
class HTTPRequest {
abstract interceptResolutionState(): InterceptResolutionState;
interceptResolutionState(): InterceptResolutionState;
}
```

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Is `true` if the intercept resolution has already been handled, `false` otherwis

```typescript
class HTTPRequest {
abstract isInterceptResolutionHandled(): boolean;
isInterceptResolutionHandled(): boolean;
}
```

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Fulfills a request with the given response.

```typescript
class HTTPRequest {
abstract respond(
respond(
response: Partial<ResponseForRequest>,
priority?: number
): Promise<void>;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ The `ResponseForRequest` that gets used if the interception is allowed to respon

```typescript
class HTTPRequest {
abstract responseForRequest(): Partial<ResponseForRequest> | null;
responseForRequest(): Partial<ResponseForRequest> | null;
}
```

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,14 +39,18 @@ commands

</td><td>

`optional`
`optional, deprecated`

</td><td>

string\[\]

</td><td>

**Deprecated:**

Do not use. This is automatically handled.

</td><td>

</td></tr>
Expand All @@ -56,14 +60,18 @@ text

</td><td>

`optional`
`optional, deprecated`

</td><td>

string

</td><td>

**Deprecated:**

Do not use. This is automatically handled.

</td><td>

</td></tr>
Expand Down

0 comments on commit 9c78e44

Please sign in to comment.