@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: CheerioFetchEngine
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/web-fetcher/src/engine/cheerio.ts:20](https://github.com/isdk/web-fetcher.js/blob/
|
|
9
|
+
Defined in: [packages/web-fetcher/src/engine/cheerio.ts:20](https://github.com/isdk/web-fetcher.js/blob/db611cb04a516e006310c5e147f90026827d6d80/src/engine/cheerio.ts#L20)
|
|
10
10
|
|
|
11
11
|
## Extends
|
|
12
12
|
|
|
@@ -32,7 +32,7 @@ Defined in: [packages/web-fetcher/src/engine/cheerio.ts:20](https://github.com/i
|
|
|
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**: `CheerioCrawler`
|
|
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**: `"cheerio"` = `'cheerio'`
|
|
202
202
|
|
|
203
|
-
Defined in: [packages/web-fetcher/src/engine/cheerio.ts:25](https://github.com/isdk/web-fetcher.js/blob/
|
|
203
|
+
Defined in: [packages/web-fetcher/src/engine/cheerio.ts:25](https://github.com/isdk/web-fetcher.js/blob/db611cb04a516e006310c5e147f90026827d6d80/src/engine/cheerio.ts#L25)
|
|
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**: `"http"` = `'http'`
|
|
220
220
|
|
|
221
|
-
Defined in: [packages/web-fetcher/src/engine/cheerio.ts:26](https://github.com/isdk/web-fetcher.js/blob/
|
|
221
|
+
Defined in: [packages/web-fetcher/src/engine/cheerio.ts:26](https://github.com/isdk/web-fetcher.js/blob/db611cb04a516e006310c5e147f90026827d6d80/src/engine/cheerio.ts#L26)
|
|
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`): `CheerioCrawler`
|
|
330
330
|
|
|
331
|
-
Defined in: [packages/web-fetcher/src/engine/cheerio.ts:221](https://github.com/isdk/web-fetcher.js/blob/
|
|
331
|
+
Defined in: [packages/web-fetcher/src/engine/cheerio.ts:221](https://github.com/isdk/web-fetcher.js/blob/db611cb04a516e006310c5e147f90026827d6d80/src/engine/cheerio.ts#L221)
|
|
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/cheerio.ts:52](https://github.com/isdk/web-fetcher.js/blob/
|
|
438
|
+
Defined in: [packages/web-fetcher/src/engine/cheerio.ts:52](https://github.com/isdk/web-fetcher.js/blob/db611cb04a516e006310c5e147f90026827d6d80/src/engine/cheerio.ts#L52)
|
|
439
439
|
|
|
440
440
|
#### Parameters
|
|
441
441
|
|
|
@@ -463,7 +463,7 @@ Defined in: [packages/web-fetcher/src/engine/cheerio.ts:52](https://github.com/i
|
|
|
463
463
|
|
|
464
464
|
> `protected` **\_getSpecificCrawlerOptions**(`ctx`): `CheerioCrawlerOptions`
|
|
465
465
|
|
|
466
|
-
Defined in: [packages/web-fetcher/src/engine/cheerio.ts:225](https://github.com/isdk/web-fetcher.js/blob/
|
|
466
|
+
Defined in: [packages/web-fetcher/src/engine/cheerio.ts:225](https://github.com/isdk/web-fetcher.js/blob/db611cb04a516e006310c5e147f90026827d6d80/src/engine/cheerio.ts#L225)
|
|
467
467
|
|
|
468
468
|
**`Internal`**
|
|
469
469
|
|
|
@@ -491,7 +491,7 @@ The fetch engine context.
|
|
|
491
491
|
|
|
492
492
|
> `protected` **\_normalizeSchema**(`schema`): `ExtractSchema`
|
|
493
493
|
|
|
494
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:415](https://github.com/isdk/web-fetcher.js/blob/
|
|
494
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:415](https://github.com/isdk/web-fetcher.js/blob/db611cb04a516e006310c5e147f90026827d6d80/src/engine/base.ts#L415)
|
|
495
495
|
|
|
496
496
|
#### Parameters
|
|
497
497
|
|
|
@@ -513,7 +513,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:415](https://github.com/isd
|
|
|
513
513
|
|
|
514
514
|
> `protected` **\_querySelectorAll**(`context`, `selector`): `Promise`\<`any`[]\>
|
|
515
515
|
|
|
516
|
-
Defined in: [packages/web-fetcher/src/engine/cheerio.ts:47](https://github.com/isdk/web-fetcher.js/blob/
|
|
516
|
+
Defined in: [packages/web-fetcher/src/engine/cheerio.ts:47](https://github.com/isdk/web-fetcher.js/blob/db611cb04a516e006310c5e147f90026827d6d80/src/engine/cheerio.ts#L47)
|
|
517
517
|
|
|
518
518
|
#### Parameters
|
|
519
519
|
|
|
@@ -545,7 +545,7 @@ Defined in: [packages/web-fetcher/src/engine/cheerio.ts:47](https://github.com/i
|
|
|
545
545
|
|
|
546
546
|
> `protected` **\_sharedFailedRequestHandler**(`context`, `error?`): `Promise`\<`void`\>
|
|
547
547
|
|
|
548
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:623](https://github.com/isdk/web-fetcher.js/blob/
|
|
548
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:623](https://github.com/isdk/web-fetcher.js/blob/db611cb04a516e006310c5e147f90026827d6d80/src/engine/base.ts#L623)
|
|
549
549
|
|
|
550
550
|
#### Parameters
|
|
551
551
|
|
|
@@ -571,7 +571,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:623](https://github.com/isd
|
|
|
571
571
|
|
|
572
572
|
> `protected` **\_sharedRequestHandler**(`context`): `Promise`\<`void`\>
|
|
573
573
|
|
|
574
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:595](https://github.com/isdk/web-fetcher.js/blob/
|
|
574
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:595](https://github.com/isdk/web-fetcher.js/blob/db611cb04a516e006310c5e147f90026827d6d80/src/engine/base.ts#L595)
|
|
575
575
|
|
|
576
576
|
#### Parameters
|
|
577
577
|
|
|
@@ -593,7 +593,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:595](https://github.com/isd
|
|
|
593
593
|
|
|
594
594
|
> **blockResources**(`types`, `overwrite?`): `Promise`\<`number`\>
|
|
595
595
|
|
|
596
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:700](https://github.com/isdk/web-fetcher.js/blob/
|
|
596
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:700](https://github.com/isdk/web-fetcher.js/blob/db611cb04a516e006310c5e147f90026827d6d80/src/engine/base.ts#L700)
|
|
597
597
|
|
|
598
598
|
Blocks specified resource types from loading.
|
|
599
599
|
|
|
@@ -634,7 +634,7 @@ await engine.blockResources(['script'], true); // Replace existing
|
|
|
634
634
|
|
|
635
635
|
> `protected` **buildResponse**(`context`): `Promise`\<[`FetchResponse`](../interfaces/FetchResponse.md)\>
|
|
636
636
|
|
|
637
|
-
Defined in: [packages/web-fetcher/src/engine/cheerio.ts:28](https://github.com/isdk/web-fetcher.js/blob/
|
|
637
|
+
Defined in: [packages/web-fetcher/src/engine/cheerio.ts:28](https://github.com/isdk/web-fetcher.js/blob/db611cb04a516e006310c5e147f90026827d6d80/src/engine/cheerio.ts#L28)
|
|
638
638
|
|
|
639
639
|
**`Internal`**
|
|
640
640
|
|
|
@@ -668,7 +668,7 @@ Converts implementation-specific context (Playwright `page` or Cheerio `$`) to s
|
|
|
668
668
|
|
|
669
669
|
> **cleanup**(): `Promise`\<`void`\>
|
|
670
670
|
|
|
671
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:536](https://github.com/isdk/web-fetcher.js/blob/
|
|
671
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:536](https://github.com/isdk/web-fetcher.js/blob/db611cb04a516e006310c5e147f90026827d6d80/src/engine/base.ts#L536)
|
|
672
672
|
|
|
673
673
|
#### Returns
|
|
674
674
|
|
|
@@ -684,7 +684,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:536](https://github.com/isd
|
|
|
684
684
|
|
|
685
685
|
> **click**(`selector`): `Promise`\<`void`\>
|
|
686
686
|
|
|
687
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:365](https://github.com/isdk/web-fetcher.js/blob/
|
|
687
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:365](https://github.com/isdk/web-fetcher.js/blob/db611cb04a516e006310c5e147f90026827d6d80/src/engine/base.ts#L365)
|
|
688
688
|
|
|
689
689
|
Clicks on element matching selector.
|
|
690
690
|
|
|
@@ -718,7 +718,7 @@ When no active page context exists
|
|
|
718
718
|
|
|
719
719
|
> **cookies**(): `Promise`\<[`Cookie`](../interfaces/Cookie.md)[]\>
|
|
720
720
|
|
|
721
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:811](https://github.com/isdk/web-fetcher.js/blob/
|
|
721
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:811](https://github.com/isdk/web-fetcher.js/blob/db611cb04a516e006310c5e147f90026827d6d80/src/engine/base.ts#L811)
|
|
722
722
|
|
|
723
723
|
Manages cookies for current session with multiple overloads.
|
|
724
724
|
|
|
@@ -747,7 +747,7 @@ await engine.cookies([{ name: 'session', value: '123' }]);
|
|
|
747
747
|
|
|
748
748
|
> **cookies**(`cookies`): `Promise`\<`boolean`\>
|
|
749
749
|
|
|
750
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:812](https://github.com/isdk/web-fetcher.js/blob/
|
|
750
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:812](https://github.com/isdk/web-fetcher.js/blob/db611cb04a516e006310c5e147f90026827d6d80/src/engine/base.ts#L812)
|
|
751
751
|
|
|
752
752
|
Manages cookies for current session with multiple overloads.
|
|
753
753
|
|
|
@@ -786,7 +786,7 @@ await engine.cookies([{ name: 'session', value: '123' }]);
|
|
|
786
786
|
|
|
787
787
|
> `protected` **dispatchAction**\<`T`\>(`action`): `Promise`\<`T`\>
|
|
788
788
|
|
|
789
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:639](https://github.com/isdk/web-fetcher.js/blob/
|
|
789
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:639](https://github.com/isdk/web-fetcher.js/blob/db611cb04a516e006310c5e147f90026827d6d80/src/engine/base.ts#L639)
|
|
790
790
|
|
|
791
791
|
#### Type Parameters
|
|
792
792
|
|
|
@@ -814,7 +814,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:639](https://github.com/isd
|
|
|
814
814
|
|
|
815
815
|
> **dispose**(): `Promise`\<`void`\>
|
|
816
816
|
|
|
817
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:829](https://github.com/isdk/web-fetcher.js/blob/
|
|
817
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:829](https://github.com/isdk/web-fetcher.js/blob/db611cb04a516e006310c5e147f90026827d6d80/src/engine/base.ts#L829)
|
|
818
818
|
|
|
819
819
|
Disposes of engine, cleaning up all resources.
|
|
820
820
|
|
|
@@ -834,7 +834,7 @@ Promise resolving when disposal completes
|
|
|
834
834
|
|
|
835
835
|
> `protected` **executeAction**(`context`, `action`): `Promise`\<`any`\>
|
|
836
836
|
|
|
837
|
-
Defined in: [packages/web-fetcher/src/engine/cheerio.ts:80](https://github.com/isdk/web-fetcher.js/blob/
|
|
837
|
+
Defined in: [packages/web-fetcher/src/engine/cheerio.ts:80](https://github.com/isdk/web-fetcher.js/blob/db611cb04a516e006310c5e147f90026827d6d80/src/engine/cheerio.ts#L80)
|
|
838
838
|
|
|
839
839
|
**`Internal`**
|
|
840
840
|
|
|
@@ -874,7 +874,7 @@ Handles specific user interactions using underlying technology (Playwright/Cheer
|
|
|
874
874
|
|
|
875
875
|
> **extract**\<`T`\>(`schema`): `Promise`\<`T`\>
|
|
876
876
|
|
|
877
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:410](https://github.com/isdk/web-fetcher.js/blob/
|
|
877
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:410](https://github.com/isdk/web-fetcher.js/blob/db611cb04a516e006310c5e147f90026827d6d80/src/engine/base.ts#L410)
|
|
878
878
|
|
|
879
879
|
Extracts structured data from the current page content.
|
|
880
880
|
|
|
@@ -908,7 +908,7 @@ A promise that resolves to an object with the extracted data.
|
|
|
908
908
|
|
|
909
909
|
> **fill**(`selector`, `value`): `Promise`\<`void`\>
|
|
910
910
|
|
|
911
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:377](https://github.com/isdk/web-fetcher.js/blob/
|
|
911
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:377](https://github.com/isdk/web-fetcher.js/blob/db611cb04a516e006310c5e147f90026827d6d80/src/engine/base.ts#L377)
|
|
912
912
|
|
|
913
913
|
Fills input element with specified value.
|
|
914
914
|
|
|
@@ -946,7 +946,7 @@ When no active page context exists
|
|
|
946
946
|
|
|
947
947
|
> **getContent**(): `Promise`\<[`FetchResponse`](../interfaces/FetchResponse.md)\>
|
|
948
948
|
|
|
949
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:714](https://github.com/isdk/web-fetcher.js/blob/
|
|
949
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:714](https://github.com/isdk/web-fetcher.js/blob/db611cb04a516e006310c5e147f90026827d6d80/src/engine/base.ts#L714)
|
|
950
950
|
|
|
951
951
|
Gets content of current page.
|
|
952
952
|
|
|
@@ -970,7 +970,7 @@ When no content has been fetched yet
|
|
|
970
970
|
|
|
971
971
|
> **goto**(`url`, `params?`): `Promise`\<`void` \| [`FetchResponse`](../interfaces/FetchResponse.md)\>
|
|
972
972
|
|
|
973
|
-
Defined in: [packages/web-fetcher/src/engine/cheerio.ts:245](https://github.com/isdk/web-fetcher.js/blob/
|
|
973
|
+
Defined in: [packages/web-fetcher/src/engine/cheerio.ts:245](https://github.com/isdk/web-fetcher.js/blob/db611cb04a516e006310c5e147f90026827d6d80/src/engine/cheerio.ts#L245)
|
|
974
974
|
|
|
975
975
|
Navigates to the specified URL.
|
|
976
976
|
|
|
@@ -1012,7 +1012,7 @@ await engine.goto('https://example.com');
|
|
|
1012
1012
|
|
|
1013
1013
|
> **headers**(): `Promise`\<`Record`\<`string`, `string`\>\>
|
|
1014
1014
|
|
|
1015
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:753](https://github.com/isdk/web-fetcher.js/blob/
|
|
1015
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:753](https://github.com/isdk/web-fetcher.js/blob/db611cb04a516e006310c5e147f90026827d6d80/src/engine/base.ts#L753)
|
|
1016
1016
|
|
|
1017
1017
|
Manages HTTP headers for requests with multiple overloads.
|
|
1018
1018
|
|
|
@@ -1043,7 +1043,7 @@ await engine.headers('auth', 'token');
|
|
|
1043
1043
|
|
|
1044
1044
|
> **headers**(`name`): `Promise`\<`string`\>
|
|
1045
1045
|
|
|
1046
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:754](https://github.com/isdk/web-fetcher.js/blob/
|
|
1046
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:754](https://github.com/isdk/web-fetcher.js/blob/db611cb04a516e006310c5e147f90026827d6d80/src/engine/base.ts#L754)
|
|
1047
1047
|
|
|
1048
1048
|
Manages HTTP headers for requests with multiple overloads.
|
|
1049
1049
|
|
|
@@ -1082,7 +1082,7 @@ await engine.headers('auth', 'token');
|
|
|
1082
1082
|
|
|
1083
1083
|
> **headers**(`headers`, `replaced?`): `Promise`\<`boolean`\>
|
|
1084
1084
|
|
|
1085
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:755](https://github.com/isdk/web-fetcher.js/blob/
|
|
1085
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:755](https://github.com/isdk/web-fetcher.js/blob/db611cb04a516e006310c5e147f90026827d6d80/src/engine/base.ts#L755)
|
|
1086
1086
|
|
|
1087
1087
|
Manages HTTP headers for requests with multiple overloads.
|
|
1088
1088
|
|
|
@@ -1127,7 +1127,7 @@ await engine.headers('auth', 'token');
|
|
|
1127
1127
|
|
|
1128
1128
|
> **headers**(`name`, `value`): `Promise`\<`boolean`\>
|
|
1129
1129
|
|
|
1130
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:756](https://github.com/isdk/web-fetcher.js/blob/
|
|
1130
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:756](https://github.com/isdk/web-fetcher.js/blob/db611cb04a516e006310c5e147f90026827d6d80/src/engine/base.ts#L756)
|
|
1131
1131
|
|
|
1132
1132
|
Manages HTTP headers for requests with multiple overloads.
|
|
1133
1133
|
|
|
@@ -1174,7 +1174,7 @@ await engine.headers('auth', 'token');
|
|
|
1174
1174
|
|
|
1175
1175
|
> **initialize**(`context`, `options?`): `Promise`\<`void`\>
|
|
1176
1176
|
|
|
1177
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:488](https://github.com/isdk/web-fetcher.js/blob/
|
|
1177
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:488](https://github.com/isdk/web-fetcher.js/blob/db611cb04a516e006310c5e147f90026827d6d80/src/engine/base.ts#L488)
|
|
1178
1178
|
|
|
1179
1179
|
Initializes the fetch engine with provided context and options.
|
|
1180
1180
|
|
|
@@ -1213,7 +1213,7 @@ Automatically called when creating engine via `FetchEngine.create()`.
|
|
|
1213
1213
|
|
|
1214
1214
|
> **pause**(`message?`): `Promise`\<`void`\>
|
|
1215
1215
|
|
|
1216
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:400](https://github.com/isdk/web-fetcher.js/blob/
|
|
1216
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:400](https://github.com/isdk/web-fetcher.js/blob/db611cb04a516e006310c5e147f90026827d6d80/src/engine/base.ts#L400)
|
|
1217
1217
|
|
|
1218
1218
|
Pauses execution, allowing for manual intervention or inspection.
|
|
1219
1219
|
|
|
@@ -1245,7 +1245,7 @@ When no active page context exists
|
|
|
1245
1245
|
|
|
1246
1246
|
> **submit**(`selector?`, `options?`): `Promise`\<`void`\>
|
|
1247
1247
|
|
|
1248
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:389](https://github.com/isdk/web-fetcher.js/blob/
|
|
1248
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:389](https://github.com/isdk/web-fetcher.js/blob/db611cb04a516e006310c5e147f90026827d6d80/src/engine/base.ts#L389)
|
|
1249
1249
|
|
|
1250
1250
|
Submits a form.
|
|
1251
1251
|
|
|
@@ -1283,7 +1283,7 @@ When no active page context exists
|
|
|
1283
1283
|
|
|
1284
1284
|
> **waitFor**(`params?`): `Promise`\<`void`\>
|
|
1285
1285
|
|
|
1286
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:354](https://github.com/isdk/web-fetcher.js/blob/
|
|
1286
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:354](https://github.com/isdk/web-fetcher.js/blob/db611cb04a516e006310c5e147f90026827d6d80/src/engine/base.ts#L354)
|
|
1287
1287
|
|
|
1288
1288
|
Waits for specified condition before continuing.
|
|
1289
1289
|
|
|
@@ -1318,7 +1318,7 @@ await engine.waitFor({ selector: '#content' }); // Wait for element
|
|
|
1318
1318
|
|
|
1319
1319
|
> `static` **create**(`ctx`, `options?`): `Promise`\<`undefined` \| `AnyFetchEngine`\>
|
|
1320
1320
|
|
|
1321
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:198](https://github.com/isdk/web-fetcher.js/blob/
|
|
1321
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:198](https://github.com/isdk/web-fetcher.js/blob/db611cb04a516e006310c5e147f90026827d6d80/src/engine/base.ts#L198)
|
|
1322
1322
|
|
|
1323
1323
|
Factory method to create and initialize a fetch engine instance.
|
|
1324
1324
|
|
|
@@ -1360,7 +1360,7 @@ Primary entry point for engine creation. Selects appropriate implementation base
|
|
|
1360
1360
|
|
|
1361
1361
|
> `static` **get**(`id`): `undefined` \| `AnyFetchEngineCtor`
|
|
1362
1362
|
|
|
1363
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:171](https://github.com/isdk/web-fetcher.js/blob/
|
|
1363
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:171](https://github.com/isdk/web-fetcher.js/blob/db611cb04a516e006310c5e147f90026827d6d80/src/engine/base.ts#L171)
|
|
1364
1364
|
|
|
1365
1365
|
Retrieves a fetch engine implementation by its unique ID.
|
|
1366
1366
|
|
|
@@ -1388,7 +1388,7 @@ Engine class if found, otherwise `undefined`
|
|
|
1388
1388
|
|
|
1389
1389
|
> `static` **getByMode**(`mode`): `undefined` \| `AnyFetchEngineCtor`
|
|
1390
1390
|
|
|
1391
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:181](https://github.com/isdk/web-fetcher.js/blob/
|
|
1391
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:181](https://github.com/isdk/web-fetcher.js/blob/db611cb04a516e006310c5e147f90026827d6d80/src/engine/base.ts#L181)
|
|
1392
1392
|
|
|
1393
1393
|
Retrieves a fetch engine implementation by execution mode.
|
|
1394
1394
|
|
|
@@ -1416,7 +1416,7 @@ Engine class if found, otherwise `undefined`
|
|
|
1416
1416
|
|
|
1417
1417
|
> `static` **register**(`engineClass`): `void`
|
|
1418
1418
|
|
|
1419
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:158](https://github.com/isdk/web-fetcher.js/blob/
|
|
1419
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:158](https://github.com/isdk/web-fetcher.js/blob/db611cb04a516e006310c5e147f90026827d6d80/src/engine/base.ts#L158)
|
|
1420
1420
|
|
|
1421
1421
|
Registers a fetch engine implementation with the global registry.
|
|
1422
1422
|
|