@isdk/web-fetcher 0.2.0 → 0.2.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.reddit.md +248 -0
- package/README.v2ex.md +109 -0
- package/dist/index.js +1 -1
- package/dist/index.mjs +1 -1
- package/docs/classes/CheerioFetchEngine.md +56 -56
- package/docs/classes/ClickAction.md +23 -23
- package/docs/classes/ExtractAction.md +23 -23
- package/docs/classes/FetchAction.md +23 -23
- package/docs/classes/FetchEngine.md +56 -56
- package/docs/classes/FetchSession.md +8 -8
- package/docs/classes/FillAction.md +23 -23
- package/docs/classes/GetContentAction.md +23 -23
- package/docs/classes/GotoAction.md +23 -23
- package/docs/classes/PauseAction.md +23 -23
- package/docs/classes/PlaywrightFetchEngine.md +56 -56
- package/docs/classes/SubmitAction.md +23 -23
- package/docs/classes/WaitForAction.md +23 -23
- package/docs/classes/WebFetcher.md +5 -5
- package/docs/enumerations/FetchActionResultStatus.md +4 -4
- package/docs/functions/fetchWeb.md +2 -2
- package/docs/interfaces/BaseFetchActionProperties.md +9 -9
- package/docs/interfaces/BaseFetchCollectorActionProperties.md +13 -13
- package/docs/interfaces/BaseFetcherProperties.md +21 -21
- package/docs/interfaces/DispatchedEngineAction.md +4 -4
- package/docs/interfaces/ExtractActionProperties.md +9 -9
- package/docs/interfaces/FetchActionInContext.md +13 -13
- package/docs/interfaces/FetchActionProperties.md +10 -10
- package/docs/interfaces/FetchActionResult.md +6 -6
- package/docs/interfaces/FetchContext.md +31 -31
- package/docs/interfaces/FetchEngineContext.md +26 -26
- package/docs/interfaces/FetchMetadata.md +5 -5
- package/docs/interfaces/FetchResponse.md +13 -13
- package/docs/interfaces/FetchReturnTypeRegistry.md +7 -7
- package/docs/interfaces/FetchSite.md +24 -24
- package/docs/interfaces/FetcherOptions.md +23 -23
- package/docs/interfaces/GotoActionOptions.md +6 -6
- package/docs/interfaces/PendingEngineRequest.md +3 -3
- package/docs/interfaces/SubmitActionOptions.md +2 -2
- package/docs/interfaces/WaitForActionOptions.md +4 -4
- package/docs/type-aliases/BaseFetchActionOptions.md +1 -1
- package/docs/type-aliases/BaseFetchCollectorOptions.md +1 -1
- package/docs/type-aliases/BrowserEngine.md +1 -1
- package/docs/type-aliases/FetchActionCapabilities.md +1 -1
- package/docs/type-aliases/FetchActionCapabilityMode.md +1 -1
- package/docs/type-aliases/FetchActionOptions.md +1 -1
- package/docs/type-aliases/FetchEngineAction.md +1 -1
- package/docs/type-aliases/FetchEngineType.md +1 -1
- package/docs/type-aliases/FetchReturnType.md +1 -1
- package/docs/type-aliases/FetchReturnTypeFor.md +1 -1
- package/docs/type-aliases/OnFetchPauseCallback.md +1 -1
- package/docs/type-aliases/ResourceType.md +1 -1
- package/docs/variables/DefaultFetcherProperties.md +1 -1
- package/package.json +1 -1
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Class: PlaywrightFetchEngine
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/web-fetcher/src/engine/playwright.ts:16](https://github.com/isdk/web-fetcher.js/blob/
|
|
9
|
+
Defined in: [packages/web-fetcher/src/engine/playwright.ts:16](https://github.com/isdk/web-fetcher.js/blob/db611cb04a516e006310c5e147f90026827d6d80/src/engine/playwright.ts#L16)
|
|
10
10
|
|
|
11
11
|
## Extends
|
|
12
12
|
|
|
@@ -32,7 +32,7 @@ Defined in: [packages/web-fetcher/src/engine/playwright.ts:16](https://github.co
|
|
|
32
32
|
|
|
33
33
|
> `protected` **actionEmitter**: `EventEmitter`
|
|
34
34
|
|
|
35
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:235](https://github.com/isdk/web-fetcher.js/blob/
|
|
35
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:235](https://github.com/isdk/web-fetcher.js/blob/db611cb04a516e006310c5e147f90026827d6d80/src/engine/base.ts#L235)
|
|
36
36
|
|
|
37
37
|
#### Inherited from
|
|
38
38
|
|
|
@@ -44,7 +44,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:235](https://github.com/isd
|
|
|
44
44
|
|
|
45
45
|
> `protected` **blockedTypes**: `Set`\<`string`\>
|
|
46
46
|
|
|
47
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:239](https://github.com/isdk/web-fetcher.js/blob/
|
|
47
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:239](https://github.com/isdk/web-fetcher.js/blob/db611cb04a516e006310c5e147f90026827d6d80/src/engine/base.ts#L239)
|
|
48
48
|
|
|
49
49
|
#### Inherited from
|
|
50
50
|
|
|
@@ -56,7 +56,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:239](https://github.com/isd
|
|
|
56
56
|
|
|
57
57
|
> `protected` `optional` **crawler**: `PlaywrightCrawler`
|
|
58
58
|
|
|
59
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:227](https://github.com/isdk/web-fetcher.js/blob/
|
|
59
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:227](https://github.com/isdk/web-fetcher.js/blob/db611cb04a516e006310c5e147f90026827d6d80/src/engine/base.ts#L227)
|
|
60
60
|
|
|
61
61
|
#### Inherited from
|
|
62
62
|
|
|
@@ -68,7 +68,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:227](https://github.com/isd
|
|
|
68
68
|
|
|
69
69
|
> `protected` `optional` **ctx**: [`FetchEngineContext`](../interfaces/FetchEngineContext.md)
|
|
70
70
|
|
|
71
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:225](https://github.com/isdk/web-fetcher.js/blob/
|
|
71
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:225](https://github.com/isdk/web-fetcher.js/blob/db611cb04a516e006310c5e147f90026827d6d80/src/engine/base.ts#L225)
|
|
72
72
|
|
|
73
73
|
#### Inherited from
|
|
74
74
|
|
|
@@ -80,7 +80,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:225](https://github.com/isd
|
|
|
80
80
|
|
|
81
81
|
> `protected` **hdrs**: `Record`\<`string`, `string`\> = `{}`
|
|
82
82
|
|
|
83
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:231](https://github.com/isdk/web-fetcher.js/blob/
|
|
83
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:231](https://github.com/isdk/web-fetcher.js/blob/db611cb04a516e006310c5e147f90026827d6d80/src/engine/base.ts#L231)
|
|
84
84
|
|
|
85
85
|
#### Inherited from
|
|
86
86
|
|
|
@@ -92,7 +92,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:231](https://github.com/isd
|
|
|
92
92
|
|
|
93
93
|
> `protected` `optional` **isCrawlerReady**: `boolean`
|
|
94
94
|
|
|
95
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:228](https://github.com/isdk/web-fetcher.js/blob/
|
|
95
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:228](https://github.com/isdk/web-fetcher.js/blob/db611cb04a516e006310c5e147f90026827d6d80/src/engine/base.ts#L228)
|
|
96
96
|
|
|
97
97
|
#### Inherited from
|
|
98
98
|
|
|
@@ -104,7 +104,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:228](https://github.com/isd
|
|
|
104
104
|
|
|
105
105
|
> `protected` **isPageActive**: `boolean` = `false`
|
|
106
106
|
|
|
107
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:236](https://github.com/isdk/web-fetcher.js/blob/
|
|
107
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:236](https://github.com/isdk/web-fetcher.js/blob/db611cb04a516e006310c5e147f90026827d6d80/src/engine/base.ts#L236)
|
|
108
108
|
|
|
109
109
|
#### Inherited from
|
|
110
110
|
|
|
@@ -116,7 +116,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:236](https://github.com/isd
|
|
|
116
116
|
|
|
117
117
|
> `protected` **jar**: [`Cookie`](../interfaces/Cookie.md)[] = `[]`
|
|
118
118
|
|
|
119
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:232](https://github.com/isdk/web-fetcher.js/blob/
|
|
119
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:232](https://github.com/isdk/web-fetcher.js/blob/db611cb04a516e006310c5e147f90026827d6d80/src/engine/base.ts#L232)
|
|
120
120
|
|
|
121
121
|
#### Inherited from
|
|
122
122
|
|
|
@@ -128,7 +128,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:232](https://github.com/isd
|
|
|
128
128
|
|
|
129
129
|
> `protected` `optional` **lastResponse**: [`FetchResponse`](../interfaces/FetchResponse.md)
|
|
130
130
|
|
|
131
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:238](https://github.com/isdk/web-fetcher.js/blob/
|
|
131
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:238](https://github.com/isdk/web-fetcher.js/blob/db611cb04a516e006310c5e147f90026827d6d80/src/engine/base.ts#L238)
|
|
132
132
|
|
|
133
133
|
#### Inherited from
|
|
134
134
|
|
|
@@ -140,7 +140,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:238](https://github.com/isd
|
|
|
140
140
|
|
|
141
141
|
> `protected` **navigationLock**: `PromiseLock`
|
|
142
142
|
|
|
143
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:237](https://github.com/isdk/web-fetcher.js/blob/
|
|
143
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:237](https://github.com/isdk/web-fetcher.js/blob/db611cb04a516e006310c5e147f90026827d6d80/src/engine/base.ts#L237)
|
|
144
144
|
|
|
145
145
|
#### Inherited from
|
|
146
146
|
|
|
@@ -152,7 +152,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:237](https://github.com/isd
|
|
|
152
152
|
|
|
153
153
|
> `protected` `optional` **opts**: [`BaseFetcherProperties`](../interfaces/BaseFetcherProperties.md)
|
|
154
154
|
|
|
155
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:226](https://github.com/isdk/web-fetcher.js/blob/
|
|
155
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:226](https://github.com/isdk/web-fetcher.js/blob/db611cb04a516e006310c5e147f90026827d6d80/src/engine/base.ts#L226)
|
|
156
156
|
|
|
157
157
|
#### Inherited from
|
|
158
158
|
|
|
@@ -164,7 +164,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:226](https://github.com/isd
|
|
|
164
164
|
|
|
165
165
|
> `protected` **pendingRequests**: `Map`\<`string`, [`PendingEngineRequest`](../interfaces/PendingEngineRequest.md)\>
|
|
166
166
|
|
|
167
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:233](https://github.com/isdk/web-fetcher.js/blob/
|
|
167
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:233](https://github.com/isdk/web-fetcher.js/blob/db611cb04a516e006310c5e147f90026827d6d80/src/engine/base.ts#L233)
|
|
168
168
|
|
|
169
169
|
#### Inherited from
|
|
170
170
|
|
|
@@ -176,7 +176,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:233](https://github.com/isd
|
|
|
176
176
|
|
|
177
177
|
> `protected` **requestCounter**: `number` = `0`
|
|
178
178
|
|
|
179
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:234](https://github.com/isdk/web-fetcher.js/blob/
|
|
179
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:234](https://github.com/isdk/web-fetcher.js/blob/db611cb04a516e006310c5e147f90026827d6d80/src/engine/base.ts#L234)
|
|
180
180
|
|
|
181
181
|
#### Inherited from
|
|
182
182
|
|
|
@@ -188,7 +188,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:234](https://github.com/isd
|
|
|
188
188
|
|
|
189
189
|
> `protected` `optional` **requestQueue**: `RequestQueue`
|
|
190
190
|
|
|
191
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:229](https://github.com/isdk/web-fetcher.js/blob/
|
|
191
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:229](https://github.com/isdk/web-fetcher.js/blob/db611cb04a516e006310c5e147f90026827d6d80/src/engine/base.ts#L229)
|
|
192
192
|
|
|
193
193
|
#### Inherited from
|
|
194
194
|
|
|
@@ -200,7 +200,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:229](https://github.com/isd
|
|
|
200
200
|
|
|
201
201
|
> `readonly` `static` **id**: `"playwright"` = `'playwright'`
|
|
202
202
|
|
|
203
|
-
Defined in: [packages/web-fetcher/src/engine/playwright.ts:21](https://github.com/isdk/web-fetcher.js/blob/
|
|
203
|
+
Defined in: [packages/web-fetcher/src/engine/playwright.ts:21](https://github.com/isdk/web-fetcher.js/blob/db611cb04a516e006310c5e147f90026827d6d80/src/engine/playwright.ts#L21)
|
|
204
204
|
|
|
205
205
|
Unique identifier for the engine implementation.
|
|
206
206
|
|
|
@@ -218,7 +218,7 @@ Must be defined by concrete implementations. Used for registration and lookup in
|
|
|
218
218
|
|
|
219
219
|
> `readonly` `static` **mode**: `"browser"` = `'browser'`
|
|
220
220
|
|
|
221
|
-
Defined in: [packages/web-fetcher/src/engine/playwright.ts:22](https://github.com/isdk/web-fetcher.js/blob/
|
|
221
|
+
Defined in: [packages/web-fetcher/src/engine/playwright.ts:22](https://github.com/isdk/web-fetcher.js/blob/db611cb04a516e006310c5e147f90026827d6d80/src/engine/playwright.ts#L22)
|
|
222
222
|
|
|
223
223
|
Execution mode of the engine (`'http'` or `'browser'`).
|
|
224
224
|
|
|
@@ -238,7 +238,7 @@ Must be defined by concrete implementations. Indicates whether engine operates a
|
|
|
238
238
|
|
|
239
239
|
> **get** **context**(): `undefined` \| [`FetchEngineContext`](../interfaces/FetchEngineContext.md)
|
|
240
240
|
|
|
241
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:473](https://github.com/isdk/web-fetcher.js/blob/
|
|
241
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:473](https://github.com/isdk/web-fetcher.js/blob/db611cb04a516e006310c5e147f90026827d6d80/src/engine/base.ts#L473)
|
|
242
242
|
|
|
243
243
|
Gets the fetch engine context associated with this instance.
|
|
244
244
|
|
|
@@ -258,7 +258,7 @@ Gets the fetch engine context associated with this instance.
|
|
|
258
258
|
|
|
259
259
|
> **get** **id**(): `string`
|
|
260
260
|
|
|
261
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:459](https://github.com/isdk/web-fetcher.js/blob/
|
|
261
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:459](https://github.com/isdk/web-fetcher.js/blob/db611cb04a516e006310c5e147f90026827d6d80/src/engine/base.ts#L459)
|
|
262
262
|
|
|
263
263
|
Gets the unique identifier of this engine implementation.
|
|
264
264
|
|
|
@@ -278,7 +278,7 @@ Gets the unique identifier of this engine implementation.
|
|
|
278
278
|
|
|
279
279
|
> **get** **mode**(): [`FetchEngineType`](../type-aliases/FetchEngineType.md)
|
|
280
280
|
|
|
281
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:466](https://github.com/isdk/web-fetcher.js/blob/
|
|
281
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:466](https://github.com/isdk/web-fetcher.js/blob/db611cb04a516e006310c5e147f90026827d6d80/src/engine/base.ts#L466)
|
|
282
282
|
|
|
283
283
|
Gets the execution mode of this engine (`'http'` or `'browser'`).
|
|
284
284
|
|
|
@@ -296,7 +296,7 @@ Gets the execution mode of this engine (`'http'` or `'browser'`).
|
|
|
296
296
|
|
|
297
297
|
> `protected` `optional` **\_cleanup**(): `Promise`\<`void`\>
|
|
298
298
|
|
|
299
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:241](https://github.com/isdk/web-fetcher.js/blob/
|
|
299
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:241](https://github.com/isdk/web-fetcher.js/blob/db611cb04a516e006310c5e147f90026827d6d80/src/engine/base.ts#L241)
|
|
300
300
|
|
|
301
301
|
#### Returns
|
|
302
302
|
|
|
@@ -312,7 +312,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:241](https://github.com/isd
|
|
|
312
312
|
|
|
313
313
|
> `protected` **\_commonCleanup**(): `Promise`\<`void`\>
|
|
314
314
|
|
|
315
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:656](https://github.com/isdk/web-fetcher.js/blob/
|
|
315
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:656](https://github.com/isdk/web-fetcher.js/blob/db611cb04a516e006310c5e147f90026827d6d80/src/engine/base.ts#L656)
|
|
316
316
|
|
|
317
317
|
#### Returns
|
|
318
318
|
|
|
@@ -328,7 +328,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:656](https://github.com/isd
|
|
|
328
328
|
|
|
329
329
|
> `protected` **\_createCrawler**(`options`): `PlaywrightCrawler`
|
|
330
330
|
|
|
331
|
-
Defined in: [packages/web-fetcher/src/engine/playwright.ts:202](https://github.com/isdk/web-fetcher.js/blob/
|
|
331
|
+
Defined in: [packages/web-fetcher/src/engine/playwright.ts:202](https://github.com/isdk/web-fetcher.js/blob/db611cb04a516e006310c5e147f90026827d6d80/src/engine/playwright.ts#L202)
|
|
332
332
|
|
|
333
333
|
**`Internal`**
|
|
334
334
|
|
|
@@ -356,7 +356,7 @@ The final crawler options.
|
|
|
356
356
|
|
|
357
357
|
> `protected` **\_executePendingActions**(`context`): `Promise`\<`void`\>
|
|
358
358
|
|
|
359
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:572](https://github.com/isdk/web-fetcher.js/blob/
|
|
359
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:572](https://github.com/isdk/web-fetcher.js/blob/db611cb04a516e006310c5e147f90026827d6d80/src/engine/base.ts#L572)
|
|
360
360
|
|
|
361
361
|
**`Internal`**
|
|
362
362
|
|
|
@@ -409,7 +409,7 @@ If called outside valid page context window (`!this.isPageActive`)
|
|
|
409
409
|
|
|
410
410
|
> `protected` **\_extract**(`schema`, `context`): `Promise`\<`any`\>
|
|
411
411
|
|
|
412
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:246](https://github.com/isdk/web-fetcher.js/blob/
|
|
412
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:246](https://github.com/isdk/web-fetcher.js/blob/db611cb04a516e006310c5e147f90026827d6d80/src/engine/base.ts#L246)
|
|
413
413
|
|
|
414
414
|
#### Parameters
|
|
415
415
|
|
|
@@ -435,7 +435,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:246](https://github.com/isd
|
|
|
435
435
|
|
|
436
436
|
> `protected` **\_extractValue**(`schema`, `context`): `Promise`\<`any`\>
|
|
437
437
|
|
|
438
|
-
Defined in: [packages/web-fetcher/src/engine/playwright.ts:57](https://github.com/isdk/web-fetcher.js/blob/
|
|
438
|
+
Defined in: [packages/web-fetcher/src/engine/playwright.ts:57](https://github.com/isdk/web-fetcher.js/blob/db611cb04a516e006310c5e147f90026827d6d80/src/engine/playwright.ts#L57)
|
|
439
439
|
|
|
440
440
|
#### Parameters
|
|
441
441
|
|
|
@@ -461,7 +461,7 @@ Defined in: [packages/web-fetcher/src/engine/playwright.ts:57](https://github.co
|
|
|
461
461
|
|
|
462
462
|
> `protected` **\_getSpecificCrawlerOptions**(`ctx`): `Promise`\<`Partial`\<`PlaywrightCrawlerOptions`\>\>
|
|
463
463
|
|
|
464
|
-
Defined in: [packages/web-fetcher/src/engine/playwright.ts:206](https://github.com/isdk/web-fetcher.js/blob/
|
|
464
|
+
Defined in: [packages/web-fetcher/src/engine/playwright.ts:206](https://github.com/isdk/web-fetcher.js/blob/db611cb04a516e006310c5e147f90026827d6d80/src/engine/playwright.ts#L206)
|
|
465
465
|
|
|
466
466
|
**`Internal`**
|
|
467
467
|
|
|
@@ -489,7 +489,7 @@ The fetch engine context.
|
|
|
489
489
|
|
|
490
490
|
> `protected` **\_normalizeSchema**(`schema`): `ExtractSchema`
|
|
491
491
|
|
|
492
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:415](https://github.com/isdk/web-fetcher.js/blob/
|
|
492
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:415](https://github.com/isdk/web-fetcher.js/blob/db611cb04a516e006310c5e147f90026827d6d80/src/engine/base.ts#L415)
|
|
493
493
|
|
|
494
494
|
#### Parameters
|
|
495
495
|
|
|
@@ -511,7 +511,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:415](https://github.com/isd
|
|
|
511
511
|
|
|
512
512
|
> `protected` **\_querySelectorAll**(`context`, `selector`): `Promise`\<`any`[]\>
|
|
513
513
|
|
|
514
|
-
Defined in: [packages/web-fetcher/src/engine/playwright.ts:53](https://github.com/isdk/web-fetcher.js/blob/
|
|
514
|
+
Defined in: [packages/web-fetcher/src/engine/playwright.ts:53](https://github.com/isdk/web-fetcher.js/blob/db611cb04a516e006310c5e147f90026827d6d80/src/engine/playwright.ts#L53)
|
|
515
515
|
|
|
516
516
|
#### Parameters
|
|
517
517
|
|
|
@@ -537,7 +537,7 @@ Defined in: [packages/web-fetcher/src/engine/playwright.ts:53](https://github.co
|
|
|
537
537
|
|
|
538
538
|
> `protected` **\_sharedFailedRequestHandler**(`context`, `error?`): `Promise`\<`void`\>
|
|
539
539
|
|
|
540
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:623](https://github.com/isdk/web-fetcher.js/blob/
|
|
540
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:623](https://github.com/isdk/web-fetcher.js/blob/db611cb04a516e006310c5e147f90026827d6d80/src/engine/base.ts#L623)
|
|
541
541
|
|
|
542
542
|
#### Parameters
|
|
543
543
|
|
|
@@ -563,7 +563,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:623](https://github.com/isd
|
|
|
563
563
|
|
|
564
564
|
> `protected` **\_sharedRequestHandler**(`context`): `Promise`\<`void`\>
|
|
565
565
|
|
|
566
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:595](https://github.com/isdk/web-fetcher.js/blob/
|
|
566
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:595](https://github.com/isdk/web-fetcher.js/blob/db611cb04a516e006310c5e147f90026827d6d80/src/engine/base.ts#L595)
|
|
567
567
|
|
|
568
568
|
#### Parameters
|
|
569
569
|
|
|
@@ -585,7 +585,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:595](https://github.com/isd
|
|
|
585
585
|
|
|
586
586
|
> **blockResources**(`types`, `overwrite?`): `Promise`\<`number`\>
|
|
587
587
|
|
|
588
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:700](https://github.com/isdk/web-fetcher.js/blob/
|
|
588
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:700](https://github.com/isdk/web-fetcher.js/blob/db611cb04a516e006310c5e147f90026827d6d80/src/engine/base.ts#L700)
|
|
589
589
|
|
|
590
590
|
Blocks specified resource types from loading.
|
|
591
591
|
|
|
@@ -626,7 +626,7 @@ await engine.blockResources(['script'], true); // Replace existing
|
|
|
626
626
|
|
|
627
627
|
> `protected` **buildResponse**(`context`): `Promise`\<[`FetchResponse`](../interfaces/FetchResponse.md)\>
|
|
628
628
|
|
|
629
|
-
Defined in: [packages/web-fetcher/src/engine/playwright.ts:24](https://github.com/isdk/web-fetcher.js/blob/
|
|
629
|
+
Defined in: [packages/web-fetcher/src/engine/playwright.ts:24](https://github.com/isdk/web-fetcher.js/blob/db611cb04a516e006310c5e147f90026827d6d80/src/engine/playwright.ts#L24)
|
|
630
630
|
|
|
631
631
|
**`Internal`**
|
|
632
632
|
|
|
@@ -660,7 +660,7 @@ Converts implementation-specific context (Playwright `page` or Cheerio `$`) to s
|
|
|
660
660
|
|
|
661
661
|
> **cleanup**(): `Promise`\<`void`\>
|
|
662
662
|
|
|
663
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:536](https://github.com/isdk/web-fetcher.js/blob/
|
|
663
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:536](https://github.com/isdk/web-fetcher.js/blob/db611cb04a516e006310c5e147f90026827d6d80/src/engine/base.ts#L536)
|
|
664
664
|
|
|
665
665
|
#### Returns
|
|
666
666
|
|
|
@@ -676,7 +676,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:536](https://github.com/isd
|
|
|
676
676
|
|
|
677
677
|
> **click**(`selector`): `Promise`\<`void`\>
|
|
678
678
|
|
|
679
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:365](https://github.com/isdk/web-fetcher.js/blob/
|
|
679
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:365](https://github.com/isdk/web-fetcher.js/blob/db611cb04a516e006310c5e147f90026827d6d80/src/engine/base.ts#L365)
|
|
680
680
|
|
|
681
681
|
Clicks on element matching selector.
|
|
682
682
|
|
|
@@ -710,7 +710,7 @@ When no active page context exists
|
|
|
710
710
|
|
|
711
711
|
> **cookies**(): `Promise`\<[`Cookie`](../interfaces/Cookie.md)[]\>
|
|
712
712
|
|
|
713
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:811](https://github.com/isdk/web-fetcher.js/blob/
|
|
713
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:811](https://github.com/isdk/web-fetcher.js/blob/db611cb04a516e006310c5e147f90026827d6d80/src/engine/base.ts#L811)
|
|
714
714
|
|
|
715
715
|
Manages cookies for current session with multiple overloads.
|
|
716
716
|
|
|
@@ -739,7 +739,7 @@ await engine.cookies([{ name: 'session', value: '123' }]);
|
|
|
739
739
|
|
|
740
740
|
> **cookies**(`cookies`): `Promise`\<`boolean`\>
|
|
741
741
|
|
|
742
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:812](https://github.com/isdk/web-fetcher.js/blob/
|
|
742
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:812](https://github.com/isdk/web-fetcher.js/blob/db611cb04a516e006310c5e147f90026827d6d80/src/engine/base.ts#L812)
|
|
743
743
|
|
|
744
744
|
Manages cookies for current session with multiple overloads.
|
|
745
745
|
|
|
@@ -778,7 +778,7 @@ await engine.cookies([{ name: 'session', value: '123' }]);
|
|
|
778
778
|
|
|
779
779
|
> `protected` **dispatchAction**\<`T`\>(`action`): `Promise`\<`T`\>
|
|
780
780
|
|
|
781
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:639](https://github.com/isdk/web-fetcher.js/blob/
|
|
781
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:639](https://github.com/isdk/web-fetcher.js/blob/db611cb04a516e006310c5e147f90026827d6d80/src/engine/base.ts#L639)
|
|
782
782
|
|
|
783
783
|
#### Type Parameters
|
|
784
784
|
|
|
@@ -806,7 +806,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:639](https://github.com/isd
|
|
|
806
806
|
|
|
807
807
|
> **dispose**(): `Promise`\<`void`\>
|
|
808
808
|
|
|
809
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:829](https://github.com/isdk/web-fetcher.js/blob/
|
|
809
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:829](https://github.com/isdk/web-fetcher.js/blob/db611cb04a516e006310c5e147f90026827d6d80/src/engine/base.ts#L829)
|
|
810
810
|
|
|
811
811
|
Disposes of engine, cleaning up all resources.
|
|
812
812
|
|
|
@@ -826,7 +826,7 @@ Promise resolving when disposal completes
|
|
|
826
826
|
|
|
827
827
|
> `protected` **executeAction**(`context`, `action`): `Promise`\<`any`\>
|
|
828
828
|
|
|
829
|
-
Defined in: [packages/web-fetcher/src/engine/playwright.ts:85](https://github.com/isdk/web-fetcher.js/blob/
|
|
829
|
+
Defined in: [packages/web-fetcher/src/engine/playwright.ts:85](https://github.com/isdk/web-fetcher.js/blob/db611cb04a516e006310c5e147f90026827d6d80/src/engine/playwright.ts#L85)
|
|
830
830
|
|
|
831
831
|
**`Internal`**
|
|
832
832
|
|
|
@@ -866,7 +866,7 @@ Handles specific user interactions using underlying technology (Playwright/Cheer
|
|
|
866
866
|
|
|
867
867
|
> **extract**\<`T`\>(`schema`): `Promise`\<`T`\>
|
|
868
868
|
|
|
869
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:410](https://github.com/isdk/web-fetcher.js/blob/
|
|
869
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:410](https://github.com/isdk/web-fetcher.js/blob/db611cb04a516e006310c5e147f90026827d6d80/src/engine/base.ts#L410)
|
|
870
870
|
|
|
871
871
|
Extracts structured data from the current page content.
|
|
872
872
|
|
|
@@ -900,7 +900,7 @@ A promise that resolves to an object with the extracted data.
|
|
|
900
900
|
|
|
901
901
|
> **fill**(`selector`, `value`): `Promise`\<`void`\>
|
|
902
902
|
|
|
903
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:377](https://github.com/isdk/web-fetcher.js/blob/
|
|
903
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:377](https://github.com/isdk/web-fetcher.js/blob/db611cb04a516e006310c5e147f90026827d6d80/src/engine/base.ts#L377)
|
|
904
904
|
|
|
905
905
|
Fills input element with specified value.
|
|
906
906
|
|
|
@@ -938,7 +938,7 @@ When no active page context exists
|
|
|
938
938
|
|
|
939
939
|
> **getContent**(): `Promise`\<[`FetchResponse`](../interfaces/FetchResponse.md)\>
|
|
940
940
|
|
|
941
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:714](https://github.com/isdk/web-fetcher.js/blob/
|
|
941
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:714](https://github.com/isdk/web-fetcher.js/blob/db611cb04a516e006310c5e147f90026827d6d80/src/engine/base.ts#L714)
|
|
942
942
|
|
|
943
943
|
Gets content of current page.
|
|
944
944
|
|
|
@@ -962,7 +962,7 @@ When no content has been fetched yet
|
|
|
962
962
|
|
|
963
963
|
> **goto**(`url`, `opts?`): `Promise`\<[`FetchResponse`](../interfaces/FetchResponse.md)\>
|
|
964
964
|
|
|
965
|
-
Defined in: [packages/web-fetcher/src/engine/playwright.ts:
|
|
965
|
+
Defined in: [packages/web-fetcher/src/engine/playwright.ts:264](https://github.com/isdk/web-fetcher.js/blob/db611cb04a516e006310c5e147f90026827d6d80/src/engine/playwright.ts#L264)
|
|
966
966
|
|
|
967
967
|
Navigates to the specified URL.
|
|
968
968
|
|
|
@@ -1002,7 +1002,7 @@ await engine.goto('https://example.com');
|
|
|
1002
1002
|
|
|
1003
1003
|
> **headers**(): `Promise`\<`Record`\<`string`, `string`\>\>
|
|
1004
1004
|
|
|
1005
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:753](https://github.com/isdk/web-fetcher.js/blob/
|
|
1005
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:753](https://github.com/isdk/web-fetcher.js/blob/db611cb04a516e006310c5e147f90026827d6d80/src/engine/base.ts#L753)
|
|
1006
1006
|
|
|
1007
1007
|
Manages HTTP headers for requests with multiple overloads.
|
|
1008
1008
|
|
|
@@ -1033,7 +1033,7 @@ await engine.headers('auth', 'token');
|
|
|
1033
1033
|
|
|
1034
1034
|
> **headers**(`name`): `Promise`\<`string`\>
|
|
1035
1035
|
|
|
1036
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:754](https://github.com/isdk/web-fetcher.js/blob/
|
|
1036
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:754](https://github.com/isdk/web-fetcher.js/blob/db611cb04a516e006310c5e147f90026827d6d80/src/engine/base.ts#L754)
|
|
1037
1037
|
|
|
1038
1038
|
Manages HTTP headers for requests with multiple overloads.
|
|
1039
1039
|
|
|
@@ -1072,7 +1072,7 @@ await engine.headers('auth', 'token');
|
|
|
1072
1072
|
|
|
1073
1073
|
> **headers**(`headers`, `replaced?`): `Promise`\<`boolean`\>
|
|
1074
1074
|
|
|
1075
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:755](https://github.com/isdk/web-fetcher.js/blob/
|
|
1075
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:755](https://github.com/isdk/web-fetcher.js/blob/db611cb04a516e006310c5e147f90026827d6d80/src/engine/base.ts#L755)
|
|
1076
1076
|
|
|
1077
1077
|
Manages HTTP headers for requests with multiple overloads.
|
|
1078
1078
|
|
|
@@ -1117,7 +1117,7 @@ await engine.headers('auth', 'token');
|
|
|
1117
1117
|
|
|
1118
1118
|
> **headers**(`name`, `value`): `Promise`\<`boolean`\>
|
|
1119
1119
|
|
|
1120
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:756](https://github.com/isdk/web-fetcher.js/blob/
|
|
1120
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:756](https://github.com/isdk/web-fetcher.js/blob/db611cb04a516e006310c5e147f90026827d6d80/src/engine/base.ts#L756)
|
|
1121
1121
|
|
|
1122
1122
|
Manages HTTP headers for requests with multiple overloads.
|
|
1123
1123
|
|
|
@@ -1164,7 +1164,7 @@ await engine.headers('auth', 'token');
|
|
|
1164
1164
|
|
|
1165
1165
|
> **initialize**(`context`, `options?`): `Promise`\<`void`\>
|
|
1166
1166
|
|
|
1167
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:488](https://github.com/isdk/web-fetcher.js/blob/
|
|
1167
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:488](https://github.com/isdk/web-fetcher.js/blob/db611cb04a516e006310c5e147f90026827d6d80/src/engine/base.ts#L488)
|
|
1168
1168
|
|
|
1169
1169
|
Initializes the fetch engine with provided context and options.
|
|
1170
1170
|
|
|
@@ -1203,7 +1203,7 @@ Automatically called when creating engine via `FetchEngine.create()`.
|
|
|
1203
1203
|
|
|
1204
1204
|
> **pause**(`message?`): `Promise`\<`void`\>
|
|
1205
1205
|
|
|
1206
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:400](https://github.com/isdk/web-fetcher.js/blob/
|
|
1206
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:400](https://github.com/isdk/web-fetcher.js/blob/db611cb04a516e006310c5e147f90026827d6d80/src/engine/base.ts#L400)
|
|
1207
1207
|
|
|
1208
1208
|
Pauses execution, allowing for manual intervention or inspection.
|
|
1209
1209
|
|
|
@@ -1235,7 +1235,7 @@ When no active page context exists
|
|
|
1235
1235
|
|
|
1236
1236
|
> **submit**(`selector?`, `options?`): `Promise`\<`void`\>
|
|
1237
1237
|
|
|
1238
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:389](https://github.com/isdk/web-fetcher.js/blob/
|
|
1238
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:389](https://github.com/isdk/web-fetcher.js/blob/db611cb04a516e006310c5e147f90026827d6d80/src/engine/base.ts#L389)
|
|
1239
1239
|
|
|
1240
1240
|
Submits a form.
|
|
1241
1241
|
|
|
@@ -1273,7 +1273,7 @@ When no active page context exists
|
|
|
1273
1273
|
|
|
1274
1274
|
> **waitFor**(`params?`): `Promise`\<`void`\>
|
|
1275
1275
|
|
|
1276
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:354](https://github.com/isdk/web-fetcher.js/blob/
|
|
1276
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:354](https://github.com/isdk/web-fetcher.js/blob/db611cb04a516e006310c5e147f90026827d6d80/src/engine/base.ts#L354)
|
|
1277
1277
|
|
|
1278
1278
|
Waits for specified condition before continuing.
|
|
1279
1279
|
|
|
@@ -1308,7 +1308,7 @@ await engine.waitFor({ selector: '#content' }); // Wait for element
|
|
|
1308
1308
|
|
|
1309
1309
|
> `static` **create**(`ctx`, `options?`): `Promise`\<`undefined` \| `AnyFetchEngine`\>
|
|
1310
1310
|
|
|
1311
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:198](https://github.com/isdk/web-fetcher.js/blob/
|
|
1311
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:198](https://github.com/isdk/web-fetcher.js/blob/db611cb04a516e006310c5e147f90026827d6d80/src/engine/base.ts#L198)
|
|
1312
1312
|
|
|
1313
1313
|
Factory method to create and initialize a fetch engine instance.
|
|
1314
1314
|
|
|
@@ -1350,7 +1350,7 @@ Primary entry point for engine creation. Selects appropriate implementation base
|
|
|
1350
1350
|
|
|
1351
1351
|
> `static` **get**(`id`): `undefined` \| `AnyFetchEngineCtor`
|
|
1352
1352
|
|
|
1353
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:171](https://github.com/isdk/web-fetcher.js/blob/
|
|
1353
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:171](https://github.com/isdk/web-fetcher.js/blob/db611cb04a516e006310c5e147f90026827d6d80/src/engine/base.ts#L171)
|
|
1354
1354
|
|
|
1355
1355
|
Retrieves a fetch engine implementation by its unique ID.
|
|
1356
1356
|
|
|
@@ -1378,7 +1378,7 @@ Engine class if found, otherwise `undefined`
|
|
|
1378
1378
|
|
|
1379
1379
|
> `static` **getByMode**(`mode`): `undefined` \| `AnyFetchEngineCtor`
|
|
1380
1380
|
|
|
1381
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:181](https://github.com/isdk/web-fetcher.js/blob/
|
|
1381
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:181](https://github.com/isdk/web-fetcher.js/blob/db611cb04a516e006310c5e147f90026827d6d80/src/engine/base.ts#L181)
|
|
1382
1382
|
|
|
1383
1383
|
Retrieves a fetch engine implementation by execution mode.
|
|
1384
1384
|
|
|
@@ -1406,7 +1406,7 @@ Engine class if found, otherwise `undefined`
|
|
|
1406
1406
|
|
|
1407
1407
|
> `static` **register**(`engineClass`): `void`
|
|
1408
1408
|
|
|
1409
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:158](https://github.com/isdk/web-fetcher.js/blob/
|
|
1409
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:158](https://github.com/isdk/web-fetcher.js/blob/db611cb04a516e006310c5e147f90026827d6d80/src/engine/base.ts#L158)
|
|
1410
1410
|
|
|
1411
1411
|
Registers a fetch engine implementation with the global registry.
|
|
1412
1412
|
|