chore: generate docs

puppeteer · Jan 29, 2024 · 3b12595 · 3b12595
1 parent eeafdbc
commit 3b12595
Show file tree

Hide file tree

Showing 12 changed files with 168 additions and 132 deletions.
diff --git a/docs/api/README.md b/docs/api/README.md
@@ -359,7 +359,7 @@ The format is [version, [lineNo, length], [lineNo, length] ... [lineNo, length]]
 
 ### mouseButtonMap
 
-• `Const` **mouseButtonMap**: `ReadonlyMap`<`string`, `"left"` \| `"middle"` \| `"right"` \| `"back"` \| `"forward"`\>
+• `Const` **mouseButtonMap**: `ReadonlyMap`\<`string`, `"left"` \| `"middle"` \| `"right"` \| `"back"` \| `"forward"`\>
 
 #### Defined in
 
@@ -369,7 +369,7 @@ The format is [version, [lineNo, length], [lineNo, length] ... [lineNo, length]]
 
 ### pointerDeviceTypes
 
-• `Const` **pointerDeviceTypes**: `ReadonlySet`<`string`\>
+• `Const` **pointerDeviceTypes**: `ReadonlySet`\<`string`\>
 
 #### Defined in
 
@@ -379,7 +379,7 @@ The format is [version, [lineNo, length], [lineNo, length] ... [lineNo, length]]
 
 ### typeableInputTypes
 
-• `Const` **typeableInputTypes**: `ReadonlySet`<`string`\>
+• `Const` **typeableInputTypes**: `ReadonlySet`\<`string`\>
 
 #### Defined in
 
@@ -409,17 +409,17 @@ The format is [version, [lineNo, length], [lineNo, length] ... [lineNo, length]]
 
 ### createRunner
 
-▸ **createRunner**(): `Promise`<[`Runner`](classes/Runner.md)\>
+▸ **createRunner**(): `Promise`\<[`Runner`](classes/Runner.md)\>
 
 #### Returns
 
-`Promise`<[`Runner`](classes/Runner.md)\>
+`Promise`\<[`Runner`](classes/Runner.md)\>
 
 #### Defined in
 
 [Runner.ts:102](https://github.com/puppeteer/replay/blob/main/src/Runner.ts#L102)
 
-▸ **createRunner**(`flow`): `Promise`<[`Runner`](classes/Runner.md)\>
+▸ **createRunner**(`flow`): `Promise`\<[`Runner`](classes/Runner.md)\>
 
 #### Parameters
 
@@ -429,13 +429,13 @@ The format is [version, [lineNo, length], [lineNo, length] ... [lineNo, length]]
 
 #### Returns
 
-`Promise`<[`Runner`](classes/Runner.md)\>
+`Promise`\<[`Runner`](classes/Runner.md)\>
 
 #### Defined in
 
 [Runner.ts:103](https://github.com/puppeteer/replay/blob/main/src/Runner.ts#L103)
 
-▸ **createRunner**(`extension`): `Promise`<[`Runner`](classes/Runner.md)\>
+▸ **createRunner**(`extension`): `Promise`\<[`Runner`](classes/Runner.md)\>
 
 #### Parameters
 
@@ -445,13 +445,13 @@ The format is [version, [lineNo, length], [lineNo, length] ... [lineNo, length]]
 
 #### Returns
 
-`Promise`<[`Runner`](classes/Runner.md)\>
+`Promise`\<[`Runner`](classes/Runner.md)\>
 
 #### Defined in
 
 [Runner.ts:104](https://github.com/puppeteer/replay/blob/main/src/Runner.ts#L104)
 
-▸ **createRunner**(`flow`, `extension`): `Promise`<[`Runner`](classes/Runner.md)\>
+▸ **createRunner**(`flow`, `extension`): `Promise`\<[`Runner`](classes/Runner.md)\>
 
 #### Parameters
 
@@ -462,7 +462,7 @@ The format is [version, [lineNo, length], [lineNo, length] ... [lineNo, length]]
 
 #### Returns
 
-`Promise`<[`Runner`](classes/Runner.md)\>
+`Promise`\<[`Runner`](classes/Runner.md)\>
 
 #### Defined in
 
@@ -632,7 +632,7 @@ https://pptr.dev/guides/query-selectors#p-elements
 
 ### stringify
 
-▸ **stringify**(`flow`, `opts?`): `Promise`<`string`\>
+▸ **stringify**(`flow`, `opts?`): `Promise`\<`string`\>
 
 Stringifes an entire recording. The following hooks are invoked with the `flow` parameter containing the entire flow:
 
@@ -651,7 +651,7 @@ Stringifes an entire recording. The following hooks are invoked with the `flow`
 
 #### Returns
 
-`Promise`<`string`\>
+`Promise`\<`string`\>
 
 #### Defined in
 
@@ -661,7 +661,7 @@ Stringifes an entire recording. The following hooks are invoked with the `flow`
 
 ### stringifyStep
 
-▸ **stringifyStep**(`step`, `opts?`): `Promise`<`string`\>
+▸ **stringifyStep**(`step`, `opts?`): `Promise`\<`string`\>
 
 Stringifes a single step. Only the following hooks are invoked with the `flow` parameter as undefined:
 
@@ -678,7 +678,7 @@ Stringifes a single step. Only the following hooks are invoked with the `flow` p
 
 #### Returns
 
-`Promise`<`string`\>
+`Promise`\<`string`\>
 
 #### Defined in
 

diff --git a/docs/api/classes/JSONStringifyExtension.md b/docs/api/classes/JSONStringifyExtension.md
@@ -31,7 +31,11 @@ parsers support comments in JSON.
 
 ### constructor
 
-• **new JSONStringifyExtension**()
+• **new JSONStringifyExtension**(): [`JSONStringifyExtension`](JSONStringifyExtension.md)
+
+#### Returns
+
+[`JSONStringifyExtension`](JSONStringifyExtension.md)
 
 #### Inherited from
 
@@ -41,7 +45,7 @@ parsers support comments in JSON.
 
 ### afterAllSteps
 
-▸ **afterAllSteps**(`out`): `Promise`<`void`\>
+▸ **afterAllSteps**(`out`): `Promise`\<`void`\>
 
 #### Parameters
 
@@ -51,7 +55,7 @@ parsers support comments in JSON.
 
 #### Returns
 
-`Promise`<`void`\>
+`Promise`\<`void`\>
 
 #### Overrides
 
@@ -65,7 +69,7 @@ parsers support comments in JSON.
 
 ### afterEachStep
 
-▸ `Optional` **afterEachStep**(`out`, `step`, `flow?`): `Promise`<`void`\>
+▸ **afterEachStep**(`out`, `step`, `flow?`): `Promise`\<`void`\>
 
 #### Parameters
 
@@ -77,7 +81,7 @@ parsers support comments in JSON.
 
 #### Returns
 
-`Promise`<`void`\>
+`Promise`\<`void`\>
 
 #### Inherited from
 
@@ -91,7 +95,7 @@ parsers support comments in JSON.
 
 ### beforeAllSteps
 
-▸ **beforeAllSteps**(`out`, `flow`): `Promise`<`void`\>
+▸ **beforeAllSteps**(`out`, `flow`): `Promise`\<`void`\>
 
 #### Parameters
 
@@ -102,7 +106,7 @@ parsers support comments in JSON.
 
 #### Returns
 
-`Promise`<`void`\>
+`Promise`\<`void`\>
 
 #### Overrides
 
@@ -116,7 +120,7 @@ parsers support comments in JSON.
 
 ### beforeEachStep
 
-▸ `Optional` **beforeEachStep**(`out`, `step`, `flow?`): `Promise`<`void`\>
+▸ **beforeEachStep**(`out`, `step`, `flow?`): `Promise`\<`void`\>
 
 #### Parameters
 
@@ -128,7 +132,7 @@ parsers support comments in JSON.
 
 #### Returns
 
-`Promise`<`void`\>
+`Promise`\<`void`\>
 
 #### Inherited from
 
@@ -142,7 +146,7 @@ parsers support comments in JSON.
 
 ### stringifyStep
 
-▸ **stringifyStep**(`out`, `step`, `flow?`): `Promise`<`void`\>
+▸ **stringifyStep**(`out`, `step`, `flow?`): `Promise`\<`void`\>
 
 #### Parameters
 
@@ -154,7 +158,7 @@ parsers support comments in JSON.
 
 #### Returns
 
-`Promise`<`void`\>
+`Promise`\<`void`\>
 
 #### Overrides
 

diff --git a/docs/api/classes/LighthouseRunnerExtension.md b/docs/api/classes/LighthouseRunnerExtension.md
@@ -27,7 +27,7 @@
 
 ### constructor
 
-• **new LighthouseRunnerExtension**(`browser`, `page`, `opts?`)
+• **new LighthouseRunnerExtension**(`browser`, `page`, `opts?`): [`LighthouseRunnerExtension`](LighthouseRunnerExtension.md)
 
 #### Parameters
 
@@ -38,19 +38,23 @@
 | `opts?`         | `Object`  |
 | `opts.timeout?` | `number`  |
 
+#### Returns
+
+[`LighthouseRunnerExtension`](LighthouseRunnerExtension.md)
+
 #### Inherited from
 
 [PuppeteerRunnerExtension](PuppeteerRunnerExtension.md).[constructor](PuppeteerRunnerExtension.md#constructor)
 
 #### Defined in
 
-[PuppeteerRunnerExtension.ts:45](https://github.com/puppeteer/replay/blob/main/src/PuppeteerRunnerExtension.ts#L45)
+[PuppeteerRunnerExtension.ts:51](https://github.com/puppeteer/replay/blob/main/src/PuppeteerRunnerExtension.ts#L51)
 
 ## Methods
 
 ### afterAllSteps
 
-▸ **afterAllSteps**(`flow`): `Promise`<`void`\>
+▸ **afterAllSteps**(`flow`): `Promise`\<`void`\>
 
 #### Parameters
 
@@ -60,7 +64,7 @@
 
 #### Returns
 
-`Promise`<`void`\>
+`Promise`\<`void`\>
 
 #### Overrides
 
@@ -74,7 +78,7 @@
 
 ### afterEachStep
 
-▸ **afterEachStep**(`step`, `flow?`): `Promise`<`void`\>
+▸ **afterEachStep**(`step`, `flow?`): `Promise`\<`void`\>
 
 #### Parameters
 
@@ -85,7 +89,7 @@
 
 #### Returns
 
-`Promise`<`void`\>
+`Promise`\<`void`\>
 
 #### Overrides
 
@@ -99,7 +103,7 @@
 
 ### beforeAllSteps
 
-▸ **beforeAllSteps**(`flow`): `Promise`<`void`\>
+▸ **beforeAllSteps**(`flow`): `Promise`\<`void`\>
 
 #### Parameters
 
@@ -109,7 +113,7 @@
 
 #### Returns
 
-`Promise`<`void`\>
+`Promise`\<`void`\>
 
 #### Overrides
 
@@ -123,7 +127,7 @@
 
 ### beforeEachStep
 
-▸ **beforeEachStep**(`step`, `flow?`): `Promise`<`void`\>
+▸ **beforeEachStep**(`step`, `flow?`): `Promise`\<`void`\>
 
 #### Parameters
 
@@ -134,7 +138,7 @@
 
 #### Returns
 
-`Promise`<`void`\>
+`Promise`\<`void`\>
 
 #### Overrides
 
@@ -148,11 +152,11 @@
 
 ### createFlowResult
 
-▸ **createFlowResult**(): `Promise`<`FlowResult`\>
+▸ **createFlowResult**(): `Promise`\<`FlowResult`\>
 
 #### Returns
 
-`Promise`<`FlowResult`\>
+`Promise`\<`FlowResult`\>
 
 #### Defined in
 
@@ -162,7 +166,7 @@
 
 ### runStep
 
-▸ **runStep**(`step`, `flow?`): `Promise`<`void`\>
+▸ **runStep**(`step`, `flow?`): `Promise`\<`void`\>
 
 #### Parameters
 
@@ -173,12 +177,12 @@
 
 #### Returns
 
-`Promise`<`void`\>
+`Promise`\<`void`\>
 
 #### Inherited from
 
 [PuppeteerRunnerExtension](PuppeteerRunnerExtension.md).[runStep](PuppeteerRunnerExtension.md#runstep)
 
 #### Defined in
 
-[PuppeteerRunnerExtension.ts:66](https://github.com/puppeteer/replay/blob/main/src/PuppeteerRunnerExtension.ts#L66)
+[PuppeteerRunnerExtension.ts:72](https://github.com/puppeteer/replay/blob/main/src/PuppeteerRunnerExtension.ts#L72)