Skip to content

Commit

Permalink
feat: expose runner APIs for running individual steps
Browse files Browse the repository at this point in the history 
BREAKING CHANGE: the user flow parameter in the runner extensions is now optional
  • Loading branch information
@OrKoN
OrKoN committed Jun 30, 2022
1 parent 95a1575 commit d368a87
Show file tree
Hide file tree
Showing 9 changed files with 492 additions and 94 deletions.
2 changes: 1 addition & 1 deletion docs/api/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@

#### Defined in

[Runner.ts:61](https://github.com/puppeteer/replay/blob/main/src/Runner.ts#L61)
[Runner.ts:172](https://github.com/puppeteer/replay/blob/main/src/Runner.ts#L172)

---

Expand Down
46 changes: 23 additions & 23 deletions docs/api/classes/PuppeteerRunnerExtension.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -51,13 +51,13 @@

### afterAllSteps

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

#### Parameters

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

#### Returns

Expand All @@ -75,14 +75,14 @@

### afterEachStep

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

#### Parameters

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

#### Returns

Expand All @@ -100,13 +100,13 @@

### beforeAllSteps

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

#### Parameters

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

#### Returns

Expand All @@ -124,14 +124,14 @@

### beforeEachStep

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

#### Parameters

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

#### Returns

Expand All @@ -149,14 +149,14 @@

### runStep

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

#### Parameters

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

#### Returns

Expand Down
38 changes: 19 additions & 19 deletions docs/api/classes/PuppeteerRunnerOwningBrowserExtension.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -67,14 +67,14 @@

### afterEachStep

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

#### Parameters

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

#### Returns

Expand All @@ -92,13 +92,13 @@

### beforeAllSteps

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

#### Parameters

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

#### Returns

Expand All @@ -116,14 +116,14 @@

### beforeEachStep

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

#### Parameters

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

#### Returns

Expand All @@ -141,14 +141,14 @@

### runStep

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

#### Parameters

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

#### Returns

Expand Down
Loading

0 comments on commit d368a87

Please sign in to comment.