Skip to content

Commit

Permalink
chore(main): release 2.3.0 (#382)
Browse files Browse the repository at this point in the history
* chore(main): release 2.3.0

* chore: generate docs

Co-authored-by: release-please[bot] <55107282+release-please[bot]@users.noreply.github.com>
  • Loading branch information
release-please[bot] authored Nov 16, 2022
1 parent f1abc72 commit f33ba37
Show file tree
Hide file tree
Showing 8 changed files with 189 additions and 4 deletions.
2 changes: 1 addition & 1 deletion .release-please-manifest.json
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
{
".": "2.2.0"
".": "2.3.0"
}
7 changes: 7 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,13 @@

All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.

## [2.3.0](https://github.com/puppeteer/replay/compare/v2.2.0...v2.3.0) (2022-11-16)


### Features

* add PuppeteerReplayStringifyExtension ([#381](https://github.com/puppeteer/replay/issues/381)) ([f1abc72](https://github.com/puppeteer/replay/commit/f1abc72e9ee7d95bc35d07c59ea79626ee9366a6))

## [2.2.0](https://github.com/puppeteer/replay/compare/v2.1.0...v2.2.0) (2022-11-09)


Expand Down
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

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

# Class: PuppeteerReplayStringifyExtension

Stringifies a user flow to a script that uses @puppeteer/replay's own API.

## Hierarchy

- [`StringifyExtension`](StringifyExtension.md)

**`PuppeteerReplayStringifyExtension`**

## Table of contents

### Constructors

- [constructor](PuppeteerReplayStringifyExtension.md#constructor)

### Methods

- [afterAllSteps](PuppeteerReplayStringifyExtension.md#afterallsteps)
- [afterEachStep](PuppeteerReplayStringifyExtension.md#aftereachstep)
- [beforeAllSteps](PuppeteerReplayStringifyExtension.md#beforeallsteps)
- [beforeEachStep](PuppeteerReplayStringifyExtension.md#beforeeachstep)
- [stringifyStep](PuppeteerReplayStringifyExtension.md#stringifystep)

## Constructors

### constructor

**new PuppeteerReplayStringifyExtension**()

#### Inherited from

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

## Methods

### afterAllSteps

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

#### Parameters

| Name | Type |
| :---- | :------------------------------------------ |
| `out` | [`LineWriter`](../interfaces/LineWriter.md) |

#### Returns

`Promise`<`void`\>

#### Overrides

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

#### Defined in

[PuppeteerReplayStringifyExtension.ts:36](https://github.com/puppeteer/replay/blob/main/src/PuppeteerReplayStringifyExtension.ts#L36)

---

### afterEachStep

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

#### Parameters

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

#### Returns

`Promise`<`void`\>

#### Inherited from

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

#### Defined in

[StringifyExtension.ts:33](https://github.com/puppeteer/replay/blob/main/src/StringifyExtension.ts#L33)

---

### beforeAllSteps

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

#### Parameters

| Name | Type |
| :---- | :------------------------------------------ |
| `out` | [`LineWriter`](../interfaces/LineWriter.md) |

#### Returns

`Promise`<`void`\>

#### Overrides

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

#### Defined in

[PuppeteerReplayStringifyExtension.ts:25](https://github.com/puppeteer/replay/blob/main/src/PuppeteerReplayStringifyExtension.ts#L25)

---

### beforeEachStep

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

#### Parameters

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

#### Returns

`Promise`<`void`\>

#### Inherited from

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

#### Defined in

[StringifyExtension.ts:23](https://github.com/puppeteer/replay/blob/main/src/StringifyExtension.ts#L23)

---

### stringifyStep

**stringifyStep**(`out`, `step`): `Promise`<`void`\>

#### Parameters

| Name | Type |
| :----- | :------------------------------------------ |
| `out` | [`LineWriter`](../interfaces/LineWriter.md) |
| `step` | [`Step`](../modules/Schema.md#step) |

#### Returns

`Promise`<`void`\>

#### Overrides

[StringifyExtension](StringifyExtension.md).[stringifyStep](StringifyExtension.md#stringifystep)

#### Defined in

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

[`PuppeteerStringifyExtension`](PuppeteerStringifyExtension.md)

[`PuppeteerReplayStringifyExtension`](PuppeteerReplayStringifyExtension.md)

## Table of contents

### Constructors
Expand Down
15 changes: 15 additions & 0 deletions docs/api/interfaces/LineWriter.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ limitations under the License.

- [appendLine](LineWriter.md#appendline)
- [endBlock](LineWriter.md#endblock)
- [getIndent](LineWriter.md#getindent)
- [startBlock](LineWriter.md#startblock)

## Methods
Expand Down Expand Up @@ -60,6 +61,20 @@ limitations under the License.

---

### getIndent

**getIndent**(): `string`

#### Returns

`string`

#### Defined in

[LineWriter.ts:21](https://github.com/puppeteer/replay/blob/main/src/LineWriter.ts#L21)

---

### startBlock

**startBlock**(): [`LineWriter`](LineWriter.md)
Expand Down
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@puppeteer/replay",
"version": "2.2.0",
"version": "2.3.0",
"description": "Replay is a library which provides an API to replay and stringify recordings created using Chrome DevTools Recorder](https://developer.chrome.com/docs/devtools/recorder/)",
"main": "lib/cjs/main.cjs",
"types": "lib/main.d.ts",
Expand Down

0 comments on commit f33ba37

Please sign in to comment.