Skip to content

Commit

Permalink
feat: Lighthouse extension (#467)
Browse files Browse the repository at this point in the history
Documentation update to trigger a new release. The implementation has
been already there but not released.
  • Loading branch information
OrKoN committed Feb 13, 2023
1 parent 1ad4cb4 commit c2f3ce8
Show file tree
Hide file tree
Showing 3 changed files with 187 additions and 0 deletions.
1 change: 1 addition & 0 deletions docs/api/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
### Classes

- [JSONStringifyExtension](classes/JSONStringifyExtension.md)
- [LighthouseRunnerExtension](classes/LighthouseRunnerExtension.md)
- [LighthouseStringifyExtension](classes/LighthouseStringifyExtension.md)
- [PuppeteerReplayStringifyExtension](classes/PuppeteerReplayStringifyExtension.md)
- [PuppeteerRunnerExtension](classes/PuppeteerRunnerExtension.md)
Expand Down
184 changes: 184 additions & 0 deletions docs/api/classes/LighthouseRunnerExtension.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,184 @@
[@puppeteer/replay](../README.md) / LighthouseRunnerExtension

# Class: LighthouseRunnerExtension

## Hierarchy

- [`PuppeteerRunnerExtension`](PuppeteerRunnerExtension.md)

**`LighthouseRunnerExtension`**

## Table of contents

### Constructors

- [constructor](LighthouseRunnerExtension.md#constructor)

### Methods

- [afterAllSteps](LighthouseRunnerExtension.md#afterallsteps)
- [afterEachStep](LighthouseRunnerExtension.md#aftereachstep)
- [beforeAllSteps](LighthouseRunnerExtension.md#beforeallsteps)
- [beforeEachStep](LighthouseRunnerExtension.md#beforeeachstep)
- [createFlowResult](LighthouseRunnerExtension.md#createflowresult)
- [runStep](LighthouseRunnerExtension.md#runstep)

## Constructors

### constructor

**new LighthouseRunnerExtension**(`browser`, `page`, `opts?`)

#### Parameters

| Name | Type |
| :-------------- | :-------- |
| `browser` | `Browser` |
| `page` | `Page` |
| `opts?` | `Object` |
| `opts.timeout?` | `number` |

#### Inherited from

[PuppeteerRunnerExtension](PuppeteerRunnerExtension.md).[constructor](PuppeteerRunnerExtension.md#constructor)

#### Defined in

[PuppeteerRunnerExtension.ts:47](https://github.com/puppeteer/replay/blob/main/src/PuppeteerRunnerExtension.ts#L47)

## Methods

### afterAllSteps

**afterAllSteps**(`flow`): `Promise`<`void`\>

#### Parameters

| Name | Type |
| :----- | :--------------------------------------------- |
| `flow` | [`UserFlow`](../interfaces/Schema.UserFlow.md) |

#### Returns

`Promise`<`void`\>

#### Overrides

[PuppeteerRunnerExtension](PuppeteerRunnerExtension.md).[afterAllSteps](PuppeteerRunnerExtension.md#afterallsteps)

#### Defined in

[lighthouse/LighthouseRunnerExtension.ts:76](https://github.com/puppeteer/replay/blob/main/src/lighthouse/LighthouseRunnerExtension.ts#L76)

---

### afterEachStep

**afterEachStep**(`step`, `flow?`): `Promise`<`void`\>

#### Parameters

| Name | Type |
| :------ | :--------------------------------------------- |
| `step` | [`Step`](../modules/Schema.md#step) |
| `flow?` | [`UserFlow`](../interfaces/Schema.UserFlow.md) |

#### Returns

`Promise`<`void`\>

#### Overrides

[PuppeteerRunnerExtension](PuppeteerRunnerExtension.md).[afterEachStep](PuppeteerRunnerExtension.md#aftereachstep)

#### Defined in

[lighthouse/LighthouseRunnerExtension.ts:68](https://github.com/puppeteer/replay/blob/main/src/lighthouse/LighthouseRunnerExtension.ts#L68)

---

### beforeAllSteps

**beforeAllSteps**(`flow`): `Promise`<`void`\>

#### Parameters

| Name | Type |
| :----- | :--------------------------------------------- |
| `flow` | [`UserFlow`](../interfaces/Schema.UserFlow.md) |

#### Returns

`Promise`<`void`\>

#### Overrides

[PuppeteerRunnerExtension](PuppeteerRunnerExtension.md).[beforeAllSteps](PuppeteerRunnerExtension.md#beforeallsteps)

#### Defined in

[lighthouse/LighthouseRunnerExtension.ts:34](https://github.com/puppeteer/replay/blob/main/src/lighthouse/LighthouseRunnerExtension.ts#L34)

---

### beforeEachStep

**beforeEachStep**(`step`, `flow?`): `Promise`<`void`\>

#### Parameters

| Name | Type |
| :------ | :--------------------------------------------- |
| `step` | [`Step`](../modules/Schema.md#step) |
| `flow?` | [`UserFlow`](../interfaces/Schema.UserFlow.md) |

#### Returns

`Promise`<`void`\>

#### Overrides

[PuppeteerRunnerExtension](PuppeteerRunnerExtension.md).[beforeEachStep](PuppeteerRunnerExtension.md#beforeeachstep)

#### Defined in

[lighthouse/LighthouseRunnerExtension.ts:51](https://github.com/puppeteer/replay/blob/main/src/lighthouse/LighthouseRunnerExtension.ts#L51)

---

### createFlowResult

**createFlowResult**(): `Promise`<`FlowResult`\>

#### Returns

`Promise`<`FlowResult`\>

#### Defined in

[lighthouse/LighthouseRunnerExtension.ts:27](https://github.com/puppeteer/replay/blob/main/src/lighthouse/LighthouseRunnerExtension.ts#L27)

---

### runStep

**runStep**(`step`, `flow?`): `Promise`<`void`\>

#### Parameters

| Name | Type |
| :------ | :--------------------------------------------- |
| `step` | [`Step`](../modules/Schema.md#step) |
| `flow?` | [`UserFlow`](../interfaces/Schema.UserFlow.md) |

#### Returns

`Promise`<`void`\>

#### Inherited from

[PuppeteerRunnerExtension](PuppeteerRunnerExtension.md).[runStep](PuppeteerRunnerExtension.md#runstep)

#### Defined in

[PuppeteerRunnerExtension.ts:68](https://github.com/puppeteer/replay/blob/main/src/PuppeteerRunnerExtension.ts#L68)
2 changes: 2 additions & 0 deletions docs/api/classes/PuppeteerRunnerExtension.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@

↳↳ [`PuppeteerRunnerOwningBrowserExtension`](PuppeteerRunnerOwningBrowserExtension.md)

↳↳ [`LighthouseRunnerExtension`](LighthouseRunnerExtension.md)

## Table of contents

### Constructors
Expand Down

0 comments on commit c2f3ce8

Please sign in to comment.