@isdk/web-fetcher 0.3.0 → 0.3.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.action.cn.md +53 -312
- package/README.action.extract.cn.md +263 -0
- package/README.action.extract.md +263 -0
- package/README.action.md +53 -311
- package/README.cn.md +10 -2
- package/README.engine.cn.md +22 -1
- package/README.engine.md +22 -1
- package/README.md +8 -1
- package/dist/index.d.mts +147 -1
- package/dist/index.d.ts +147 -1
- package/dist/index.js +1 -1
- package/dist/index.mjs +1 -1
- package/docs/README.md +8 -1
- package/docs/_media/README.action.md +53 -311
- package/docs/_media/README.cn.md +10 -2
- package/docs/_media/README.engine.md +22 -1
- package/docs/classes/CheerioFetchEngine.md +236 -88
- package/docs/classes/ClickAction.md +23 -23
- package/docs/classes/EvaluateAction.md +23 -23
- package/docs/classes/ExtractAction.md +23 -23
- package/docs/classes/FetchAction.md +27 -23
- package/docs/classes/FetchEngine.md +218 -86
- package/docs/classes/FetchSession.md +13 -13
- package/docs/classes/FillAction.md +23 -23
- package/docs/classes/GetContentAction.md +23 -23
- package/docs/classes/GotoAction.md +23 -23
- package/docs/classes/KeyboardPressAction.md +533 -0
- package/docs/classes/KeyboardTypeAction.md +533 -0
- package/docs/classes/MouseClickAction.md +533 -0
- package/docs/classes/MouseMoveAction.md +533 -0
- package/docs/classes/PauseAction.md +23 -23
- package/docs/classes/PlaywrightFetchEngine.md +337 -87
- package/docs/classes/SubmitAction.md +23 -23
- package/docs/classes/TrimAction.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/globals.md +8 -0
- package/docs/interfaces/BaseFetchActionProperties.md +12 -12
- package/docs/interfaces/BaseFetchCollectorActionProperties.md +16 -16
- package/docs/interfaces/BaseFetcherProperties.md +31 -27
- package/docs/interfaces/Cookie.md +14 -14
- package/docs/interfaces/DispatchedEngineAction.md +4 -4
- package/docs/interfaces/EvaluateActionOptions.md +3 -3
- package/docs/interfaces/ExtractActionProperties.md +12 -12
- package/docs/interfaces/FetchActionInContext.md +15 -15
- package/docs/interfaces/FetchActionProperties.md +13 -13
- package/docs/interfaces/FetchActionResult.md +6 -6
- package/docs/interfaces/FetchContext.md +41 -37
- package/docs/interfaces/FetchEngineContext.md +36 -32
- package/docs/interfaces/FetchMetadata.md +5 -5
- package/docs/interfaces/FetchResponse.md +14 -14
- package/docs/interfaces/FetchReturnTypeRegistry.md +7 -7
- package/docs/interfaces/FetchSite.md +34 -30
- package/docs/interfaces/FetcherOptions.md +33 -29
- package/docs/interfaces/GotoActionOptions.md +14 -6
- package/docs/interfaces/KeyboardPressParams.md +25 -0
- package/docs/interfaces/KeyboardTypeParams.md +25 -0
- package/docs/interfaces/MouseClickParams.md +49 -0
- package/docs/interfaces/MouseMoveParams.md +41 -0
- package/docs/interfaces/PendingEngineRequest.md +3 -3
- package/docs/interfaces/StorageOptions.md +5 -5
- package/docs/interfaces/SubmitActionOptions.md +2 -2
- package/docs/interfaces/TrimActionOptions.md +3 -3
- package/docs/interfaces/WaitForActionOptions.md +5 -5
- 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 +2 -2
- 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/type-aliases/TrimPreset.md +1 -1
- package/docs/variables/DefaultFetcherProperties.md +1 -1
- package/docs/variables/FetcherOptionKeys.md +1 -1
- package/docs/variables/TRIM_PRESETS.md +1 -1
- package/package.json +10 -10
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Class: CheerioFetchEngine
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/web-fetcher/src/engine/cheerio.ts:17](https://github.com/isdk/web-fetcher.js/blob/
|
|
9
|
+
Defined in: [packages/web-fetcher/src/engine/cheerio.ts:17](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/cheerio.ts#L17)
|
|
10
10
|
|
|
11
11
|
## Extends
|
|
12
12
|
|
|
@@ -32,7 +32,7 @@ Defined in: [packages/web-fetcher/src/engine/cheerio.ts:17](https://github.com/i
|
|
|
32
32
|
|
|
33
33
|
> `protected` `optional` **\_initialCookies**: [`Cookie`](../interfaces/Cookie.md)[]
|
|
34
34
|
|
|
35
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
35
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:396](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L396)
|
|
36
36
|
|
|
37
37
|
#### Inherited from
|
|
38
38
|
|
|
@@ -44,7 +44,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:379](https://github.com/isd
|
|
|
44
44
|
|
|
45
45
|
> `protected` **\_initializedSessions**: `Set`\<`string`\>
|
|
46
46
|
|
|
47
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
47
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:397](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L397)
|
|
48
48
|
|
|
49
49
|
#### Inherited from
|
|
50
50
|
|
|
@@ -56,7 +56,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:380](https://github.com/isd
|
|
|
56
56
|
|
|
57
57
|
> `protected` **actionEmitter**: `EventEmitter`
|
|
58
58
|
|
|
59
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
59
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:401](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L401)
|
|
60
60
|
|
|
61
61
|
#### Inherited from
|
|
62
62
|
|
|
@@ -68,7 +68,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:384](https://github.com/isd
|
|
|
68
68
|
|
|
69
69
|
> `protected` **actionQueue**: [`DispatchedEngineAction`](../interfaces/DispatchedEngineAction.md)[] = `[]`
|
|
70
70
|
|
|
71
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
71
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:408](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L408)
|
|
72
72
|
|
|
73
73
|
#### Inherited from
|
|
74
74
|
|
|
@@ -80,7 +80,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:391](https://github.com/isd
|
|
|
80
80
|
|
|
81
81
|
> `protected` `optional` **activeContext**: `CheerioCrawlingContext`\<`any`, `any`\>
|
|
82
82
|
|
|
83
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
83
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:405](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L405)
|
|
84
84
|
|
|
85
85
|
#### Inherited from
|
|
86
86
|
|
|
@@ -92,7 +92,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:388](https://github.com/isd
|
|
|
92
92
|
|
|
93
93
|
> `protected` **blockedTypes**: `Set`\<`string`\>
|
|
94
94
|
|
|
95
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
95
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:410](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L410)
|
|
96
96
|
|
|
97
97
|
#### Inherited from
|
|
98
98
|
|
|
@@ -104,7 +104,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:393](https://github.com/isd
|
|
|
104
104
|
|
|
105
105
|
> `protected` `optional` **config**: `Configuration`
|
|
106
106
|
|
|
107
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
107
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:390](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L390)
|
|
108
108
|
|
|
109
109
|
#### Inherited from
|
|
110
110
|
|
|
@@ -116,7 +116,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:373](https://github.com/isd
|
|
|
116
116
|
|
|
117
117
|
> `protected` `optional` **crawler**: `CheerioCrawler`
|
|
118
118
|
|
|
119
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
119
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:387](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L387)
|
|
120
120
|
|
|
121
121
|
#### Inherited from
|
|
122
122
|
|
|
@@ -128,7 +128,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:370](https://github.com/isd
|
|
|
128
128
|
|
|
129
129
|
> `protected` `optional` **crawlerRunPromise**: `Promise`\<`FinalStatistics`\>
|
|
130
130
|
|
|
131
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
131
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:389](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L389)
|
|
132
132
|
|
|
133
133
|
#### Inherited from
|
|
134
134
|
|
|
@@ -140,7 +140,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:372](https://github.com/isd
|
|
|
140
140
|
|
|
141
141
|
> `protected` `optional` **ctx**: [`FetchEngineContext`](../interfaces/FetchEngineContext.md)
|
|
142
142
|
|
|
143
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
143
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:385](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L385)
|
|
144
144
|
|
|
145
145
|
#### Inherited from
|
|
146
146
|
|
|
@@ -152,7 +152,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:368](https://github.com/isd
|
|
|
152
152
|
|
|
153
153
|
> `protected` `optional` **currentSession**: `Session`
|
|
154
154
|
|
|
155
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
155
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:398](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L398)
|
|
156
156
|
|
|
157
157
|
#### Inherited from
|
|
158
158
|
|
|
@@ -164,7 +164,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:381](https://github.com/isd
|
|
|
164
164
|
|
|
165
165
|
> `protected` **hdrs**: `Record`\<`string`, `string`\> = `{}`
|
|
166
166
|
|
|
167
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
167
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:395](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L395)
|
|
168
168
|
|
|
169
169
|
#### Inherited from
|
|
170
170
|
|
|
@@ -176,7 +176,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:378](https://github.com/isd
|
|
|
176
176
|
|
|
177
177
|
> `protected` `optional` **isCrawlerReady**: `boolean`
|
|
178
178
|
|
|
179
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
179
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:388](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L388)
|
|
180
180
|
|
|
181
181
|
#### Inherited from
|
|
182
182
|
|
|
@@ -188,7 +188,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:371](https://github.com/isd
|
|
|
188
188
|
|
|
189
189
|
> `protected` **isEngineDisposed**: `boolean` = `false`
|
|
190
190
|
|
|
191
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
191
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:403](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L403)
|
|
192
192
|
|
|
193
193
|
#### Inherited from
|
|
194
194
|
|
|
@@ -200,7 +200,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:386](https://github.com/isd
|
|
|
200
200
|
|
|
201
201
|
> `protected` **isExecutingAction**: `boolean` = `false`
|
|
202
202
|
|
|
203
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
203
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:406](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L406)
|
|
204
204
|
|
|
205
205
|
#### Inherited from
|
|
206
206
|
|
|
@@ -212,7 +212,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:389](https://github.com/isd
|
|
|
212
212
|
|
|
213
213
|
> `protected` **isPageActive**: `boolean` = `false`
|
|
214
214
|
|
|
215
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
215
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:402](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L402)
|
|
216
216
|
|
|
217
217
|
#### Inherited from
|
|
218
218
|
|
|
@@ -224,7 +224,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:385](https://github.com/isd
|
|
|
224
224
|
|
|
225
225
|
> `protected` **isProcessingActionLoop**: `boolean` = `false`
|
|
226
226
|
|
|
227
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
227
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:409](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L409)
|
|
228
228
|
|
|
229
229
|
#### Inherited from
|
|
230
230
|
|
|
@@ -236,7 +236,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:392](https://github.com/isd
|
|
|
236
236
|
|
|
237
237
|
> `protected` `optional` **kvStore**: `KeyValueStore`
|
|
238
238
|
|
|
239
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
239
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:392](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L392)
|
|
240
240
|
|
|
241
241
|
#### Inherited from
|
|
242
242
|
|
|
@@ -248,7 +248,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:375](https://github.com/isd
|
|
|
248
248
|
|
|
249
249
|
> `protected` `optional` **lastResponse**: [`FetchResponse`](../interfaces/FetchResponse.md)
|
|
250
250
|
|
|
251
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
251
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:407](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L407)
|
|
252
252
|
|
|
253
253
|
#### Inherited from
|
|
254
254
|
|
|
@@ -260,7 +260,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:390](https://github.com/isd
|
|
|
260
260
|
|
|
261
261
|
> `protected` **navigationLock**: `PromiseLock`
|
|
262
262
|
|
|
263
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
263
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:404](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L404)
|
|
264
264
|
|
|
265
265
|
#### Inherited from
|
|
266
266
|
|
|
@@ -272,7 +272,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:387](https://github.com/isd
|
|
|
272
272
|
|
|
273
273
|
> `protected` `optional` **opts**: [`BaseFetcherProperties`](../interfaces/BaseFetcherProperties.md)
|
|
274
274
|
|
|
275
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
275
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:386](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L386)
|
|
276
276
|
|
|
277
277
|
#### Inherited from
|
|
278
278
|
|
|
@@ -284,7 +284,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:369](https://github.com/isd
|
|
|
284
284
|
|
|
285
285
|
> `protected` **pendingRequests**: `Map`\<`string`, [`PendingEngineRequest`](../interfaces/PendingEngineRequest.md)\>
|
|
286
286
|
|
|
287
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
287
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:399](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L399)
|
|
288
288
|
|
|
289
289
|
#### Inherited from
|
|
290
290
|
|
|
@@ -296,7 +296,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:382](https://github.com/isd
|
|
|
296
296
|
|
|
297
297
|
> `protected` `optional` **proxyConfiguration**: `ProxyConfiguration`
|
|
298
298
|
|
|
299
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
299
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:393](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L393)
|
|
300
300
|
|
|
301
301
|
#### Inherited from
|
|
302
302
|
|
|
@@ -308,7 +308,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:376](https://github.com/isd
|
|
|
308
308
|
|
|
309
309
|
> `protected` **requestCounter**: `number` = `0`
|
|
310
310
|
|
|
311
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
311
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:400](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L400)
|
|
312
312
|
|
|
313
313
|
#### Inherited from
|
|
314
314
|
|
|
@@ -320,7 +320,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:383](https://github.com/isd
|
|
|
320
320
|
|
|
321
321
|
> `protected` `optional` **requestQueue**: `RequestQueue`
|
|
322
322
|
|
|
323
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
323
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:391](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L391)
|
|
324
324
|
|
|
325
325
|
#### Inherited from
|
|
326
326
|
|
|
@@ -332,7 +332,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:374](https://github.com/isd
|
|
|
332
332
|
|
|
333
333
|
> `readonly` `static` **id**: `"cheerio"` = `'cheerio'`
|
|
334
334
|
|
|
335
|
-
Defined in: [packages/web-fetcher/src/engine/cheerio.ts:22](https://github.com/isdk/web-fetcher.js/blob/
|
|
335
|
+
Defined in: [packages/web-fetcher/src/engine/cheerio.ts:22](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/cheerio.ts#L22)
|
|
336
336
|
|
|
337
337
|
Unique identifier for the engine implementation.
|
|
338
338
|
|
|
@@ -350,7 +350,7 @@ Must be defined by concrete implementations. Used for registration and lookup in
|
|
|
350
350
|
|
|
351
351
|
> `readonly` `static` **mode**: `"http"` = `'http'`
|
|
352
352
|
|
|
353
|
-
Defined in: [packages/web-fetcher/src/engine/cheerio.ts:23](https://github.com/isdk/web-fetcher.js/blob/
|
|
353
|
+
Defined in: [packages/web-fetcher/src/engine/cheerio.ts:23](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/cheerio.ts#L23)
|
|
354
354
|
|
|
355
355
|
Execution mode of the engine (`'http'` or `'browser'`).
|
|
356
356
|
|
|
@@ -370,7 +370,7 @@ Must be defined by concrete implementations. Indicates whether engine operates a
|
|
|
370
370
|
|
|
371
371
|
> **get** **context**(): [`FetchEngineContext`](../interfaces/FetchEngineContext.md) \| `undefined`
|
|
372
372
|
|
|
373
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
373
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:919](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L919)
|
|
374
374
|
|
|
375
375
|
Gets the fetch engine context associated with this instance.
|
|
376
376
|
|
|
@@ -390,7 +390,7 @@ Gets the fetch engine context associated with this instance.
|
|
|
390
390
|
|
|
391
391
|
> **get** **id**(): `string`
|
|
392
392
|
|
|
393
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
393
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:894](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L894)
|
|
394
394
|
|
|
395
395
|
Gets the unique identifier of this engine implementation.
|
|
396
396
|
|
|
@@ -410,7 +410,7 @@ Gets the unique identifier of this engine implementation.
|
|
|
410
410
|
|
|
411
411
|
> **get** **mode**(): [`FetchEngineType`](../type-aliases/FetchEngineType.md)
|
|
412
412
|
|
|
413
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
413
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:912](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L912)
|
|
414
414
|
|
|
415
415
|
Gets the execution mode of this engine (`'http'` or `'browser'`).
|
|
416
416
|
|
|
@@ -428,7 +428,7 @@ Gets the execution mode of this engine (`'http'` or `'browser'`).
|
|
|
428
428
|
|
|
429
429
|
> `protected` **\_buildResponse**(`context`): `Promise`\<[`FetchResponse`](../interfaces/FetchResponse.md)\>
|
|
430
430
|
|
|
431
|
-
Defined in: [packages/web-fetcher/src/engine/cheerio.ts:41](https://github.com/isdk/web-fetcher.js/blob/
|
|
431
|
+
Defined in: [packages/web-fetcher/src/engine/cheerio.ts:41](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/cheerio.ts#L41)
|
|
432
432
|
|
|
433
433
|
**`Internal`**
|
|
434
434
|
|
|
@@ -462,7 +462,7 @@ Converts implementation-specific context (Playwright `page` or Cheerio `$`) to s
|
|
|
462
462
|
|
|
463
463
|
> `protected` `optional` **\_cleanup**(): `Promise`\<`void`\>
|
|
464
464
|
|
|
465
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
465
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:420](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L420)
|
|
466
466
|
|
|
467
467
|
#### Returns
|
|
468
468
|
|
|
@@ -478,7 +478,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:399](https://github.com/isd
|
|
|
478
478
|
|
|
479
479
|
> `protected` **\_commonCleanup**(): `Promise`\<`void`\>
|
|
480
480
|
|
|
481
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
481
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:1321](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L1321)
|
|
482
482
|
|
|
483
483
|
#### Returns
|
|
484
484
|
|
|
@@ -494,7 +494,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:1237](https://github.com/is
|
|
|
494
494
|
|
|
495
495
|
> **\_contains**(`container`, `element`): `Promise`\<`boolean`\>
|
|
496
496
|
|
|
497
|
-
Defined in: [packages/web-fetcher/src/engine/cheerio.ts:172](https://github.com/isdk/web-fetcher.js/blob/
|
|
497
|
+
Defined in: [packages/web-fetcher/src/engine/cheerio.ts:172](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/cheerio.ts#L172)
|
|
498
498
|
|
|
499
499
|
**`Internal`**
|
|
500
500
|
|
|
@@ -546,7 +546,7 @@ IExtractEngine.\_contains for implementation details.
|
|
|
546
546
|
|
|
547
547
|
> `protected` **\_createCrawler**(`options`, `config?`): `CheerioCrawler`
|
|
548
548
|
|
|
549
|
-
Defined in: [packages/web-fetcher/src/engine/cheerio.ts:
|
|
549
|
+
Defined in: [packages/web-fetcher/src/engine/cheerio.ts:698](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/cheerio.ts#L698)
|
|
550
550
|
|
|
551
551
|
**`Internal`**
|
|
552
552
|
|
|
@@ -578,7 +578,7 @@ The final crawler options.
|
|
|
578
578
|
|
|
579
579
|
> `protected` **\_executePendingActions**(`context`): `Promise`\<`void`\>
|
|
580
580
|
|
|
581
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
581
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:1162](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L1162)
|
|
582
582
|
|
|
583
583
|
**`Internal`**
|
|
584
584
|
|
|
@@ -631,7 +631,7 @@ If called outside valid page context window (`!this.isPageActive`)
|
|
|
631
631
|
|
|
632
632
|
> `protected` **\_extract**(`schema`, `scope`, `parentStrict?`): `Promise`\<`any`\>
|
|
633
633
|
|
|
634
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
634
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:563](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L563)
|
|
635
635
|
|
|
636
636
|
#### Parameters
|
|
637
637
|
|
|
@@ -661,7 +661,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:542](https://github.com/isd
|
|
|
661
661
|
|
|
662
662
|
> `protected` **\_extractColumnar**(`schema`, `container`, `opts?`): `Promise`\<`any`[] \| `null`\>
|
|
663
663
|
|
|
664
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
664
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:605](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L605)
|
|
665
665
|
|
|
666
666
|
**`Internal`**
|
|
667
667
|
|
|
@@ -703,7 +703,7 @@ An array of extracted items, or null if requirements aren't met.
|
|
|
703
703
|
|
|
704
704
|
> `protected` **\_extractNested**(`items`, `elements`, `opts?`): `Promise`\<`any`[]\>
|
|
705
705
|
|
|
706
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
706
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:588](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L588)
|
|
707
707
|
|
|
708
708
|
**`Internal`**
|
|
709
709
|
|
|
@@ -743,7 +743,7 @@ The list of item elements.
|
|
|
743
743
|
|
|
744
744
|
> `protected` **\_extractSegmented**(`schema`, `container`, `opts?`): `Promise`\<`any`[] \| `null`\>
|
|
745
745
|
|
|
746
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
746
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:622](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L622)
|
|
747
747
|
|
|
748
748
|
**`Internal`**
|
|
749
749
|
|
|
@@ -785,7 +785,7 @@ An array of extracted items.
|
|
|
785
785
|
|
|
786
786
|
> **\_extractValue**(`schema`, `scope`): `Promise`\<`any`\>
|
|
787
787
|
|
|
788
|
-
Defined in: [packages/web-fetcher/src/engine/cheerio.ts:240](https://github.com/isdk/web-fetcher.js/blob/
|
|
788
|
+
Defined in: [packages/web-fetcher/src/engine/cheerio.ts:240](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/cheerio.ts#L240)
|
|
789
789
|
|
|
790
790
|
**`Internal`**
|
|
791
791
|
|
|
@@ -831,7 +831,7 @@ IExtractEngine.\_extractValue for behavior contract.
|
|
|
831
831
|
|
|
832
832
|
> **\_findClosestAncestor**(`scope`, `candidates`): `Promise`\<`any`\>
|
|
833
833
|
|
|
834
|
-
Defined in: [packages/web-fetcher/src/engine/cheerio.ts:151](https://github.com/isdk/web-fetcher.js/blob/
|
|
834
|
+
Defined in: [packages/web-fetcher/src/engine/cheerio.ts:151](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/cheerio.ts#L151)
|
|
835
835
|
|
|
836
836
|
**`Internal`**
|
|
837
837
|
|
|
@@ -877,7 +877,7 @@ IExtractEngine.\_findClosestAncestor for implementation details.
|
|
|
877
877
|
|
|
878
878
|
> **\_findCommonAncestor**(`scope1`, `scope2`): `Promise`\<`any`\>
|
|
879
879
|
|
|
880
|
-
Defined in: [packages/web-fetcher/src/engine/cheerio.ts:186](https://github.com/isdk/web-fetcher.js/blob/
|
|
880
|
+
Defined in: [packages/web-fetcher/src/engine/cheerio.ts:186](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/cheerio.ts#L186)
|
|
881
881
|
|
|
882
882
|
**`Internal`**
|
|
883
883
|
|
|
@@ -925,7 +925,7 @@ A promise resolving to the LCA element scope, or `null` if none found.
|
|
|
925
925
|
|
|
926
926
|
> **\_findContainerChild**(`element`, `container`): `Promise`\<`any`\>
|
|
927
927
|
|
|
928
|
-
Defined in: [packages/web-fetcher/src/engine/cheerio.ts:209](https://github.com/isdk/web-fetcher.js/blob/
|
|
928
|
+
Defined in: [packages/web-fetcher/src/engine/cheerio.ts:209](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/cheerio.ts#L209)
|
|
929
929
|
|
|
930
930
|
**`Internal`**
|
|
931
931
|
|
|
@@ -973,7 +973,7 @@ The child element of container, or null.
|
|
|
973
973
|
|
|
974
974
|
> `protected` **\_getInitialElementScope**(`context`): `any`
|
|
975
975
|
|
|
976
|
-
Defined in: [packages/web-fetcher/src/engine/cheerio.ts:281](https://github.com/isdk/web-fetcher.js/blob/
|
|
976
|
+
Defined in: [packages/web-fetcher/src/engine/cheerio.ts:281](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/cheerio.ts#L281)
|
|
977
977
|
|
|
978
978
|
**`Internal`**
|
|
979
979
|
|
|
@@ -1001,7 +1001,7 @@ Crawlee crawling context
|
|
|
1001
1001
|
|
|
1002
1002
|
> `protected` **\_getSpecificCrawlerOptions**(`ctx`): `CheerioCrawlerOptions`
|
|
1003
1003
|
|
|
1004
|
-
Defined in: [packages/web-fetcher/src/engine/cheerio.ts:
|
|
1004
|
+
Defined in: [packages/web-fetcher/src/engine/cheerio.ts:705](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/cheerio.ts#L705)
|
|
1005
1005
|
|
|
1006
1006
|
**`Internal`**
|
|
1007
1007
|
|
|
@@ -1029,7 +1029,7 @@ The fetch engine context.
|
|
|
1029
1029
|
|
|
1030
1030
|
> `protected` **\_getTrimInfo**(`options`): `object`
|
|
1031
1031
|
|
|
1032
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1032
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:422](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L422)
|
|
1033
1033
|
|
|
1034
1034
|
#### Parameters
|
|
1035
1035
|
|
|
@@ -1063,7 +1063,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:401](https://github.com/isd
|
|
|
1063
1063
|
|
|
1064
1064
|
> `protected` **\_handlePause**(`action`): `Promise`\<`void`\>
|
|
1065
1065
|
|
|
1066
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1066
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:1122](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L1122)
|
|
1067
1067
|
|
|
1068
1068
|
#### Parameters
|
|
1069
1069
|
|
|
@@ -1087,7 +1087,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:1049](https://github.com/is
|
|
|
1087
1087
|
|
|
1088
1088
|
> **\_isSameElement**(`scope1`, `scope2`): `Promise`\<`boolean`\>
|
|
1089
1089
|
|
|
1090
|
-
Defined in: [packages/web-fetcher/src/engine/cheerio.ts:144](https://github.com/isdk/web-fetcher.js/blob/
|
|
1090
|
+
Defined in: [packages/web-fetcher/src/engine/cheerio.ts:144](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/cheerio.ts#L144)
|
|
1091
1091
|
|
|
1092
1092
|
**`Internal`**
|
|
1093
1093
|
|
|
@@ -1127,7 +1127,7 @@ True if they are the same DOM node.
|
|
|
1127
1127
|
|
|
1128
1128
|
> **\_logDebug**(`category`, ...`args`): `void`
|
|
1129
1129
|
|
|
1130
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1130
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:412](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L412)
|
|
1131
1131
|
|
|
1132
1132
|
Logs debug information if debug mode is enabled.
|
|
1133
1133
|
|
|
@@ -1159,7 +1159,7 @@ Arguments to log.
|
|
|
1159
1159
|
|
|
1160
1160
|
> **\_nextSiblingsUntil**(`scope`, `untilSelector?`): `Promise`\<`any`[]\>
|
|
1161
1161
|
|
|
1162
|
-
Defined in: [packages/web-fetcher/src/engine/cheerio.ts:123](https://github.com/isdk/web-fetcher.js/blob/
|
|
1162
|
+
Defined in: [packages/web-fetcher/src/engine/cheerio.ts:123](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/cheerio.ts#L123)
|
|
1163
1163
|
|
|
1164
1164
|
**`Internal`**
|
|
1165
1165
|
|
|
@@ -1202,7 +1202,7 @@ List of sibling elements between anchor and untilSelector.
|
|
|
1202
1202
|
|
|
1203
1203
|
> `protected` **\_normalizeArrayMode**(`mode?`): `any`
|
|
1204
1204
|
|
|
1205
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1205
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:576](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L576)
|
|
1206
1206
|
|
|
1207
1207
|
**`Internal`**
|
|
1208
1208
|
|
|
@@ -1230,7 +1230,7 @@ The mode string or options object.
|
|
|
1230
1230
|
|
|
1231
1231
|
> **\_parentElement**(`scope`): `Promise`\<`any`\>
|
|
1232
1232
|
|
|
1233
|
-
Defined in: [packages/web-fetcher/src/engine/cheerio.ts:134](https://github.com/isdk/web-fetcher.js/blob/
|
|
1233
|
+
Defined in: [packages/web-fetcher/src/engine/cheerio.ts:134](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/cheerio.ts#L134)
|
|
1234
1234
|
|
|
1235
1235
|
**`Internal`**
|
|
1236
1236
|
|
|
@@ -1266,7 +1266,7 @@ Parent element or null.
|
|
|
1266
1266
|
|
|
1267
1267
|
> `protected` **\_processAction**(`context`, `action`): `Promise`\<`any`\>
|
|
1268
1268
|
|
|
1269
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1269
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:1093](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L1093)
|
|
1270
1270
|
|
|
1271
1271
|
**`Internal`**
|
|
1272
1272
|
|
|
@@ -1300,7 +1300,7 @@ Action to execute
|
|
|
1300
1300
|
|
|
1301
1301
|
> **\_querySelectorAll**(`scope`, `selector`): `Promise`\<`any`[]\>
|
|
1302
1302
|
|
|
1303
|
-
Defined in: [packages/web-fetcher/src/engine/cheerio.ts:95](https://github.com/isdk/web-fetcher.js/blob/
|
|
1303
|
+
Defined in: [packages/web-fetcher/src/engine/cheerio.ts:95](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/cheerio.ts#L95)
|
|
1304
1304
|
|
|
1305
1305
|
**`Internal`**
|
|
1306
1306
|
|
|
@@ -1340,7 +1340,7 @@ IExtractEngine.\_querySelectorAll for behavior contract.
|
|
|
1340
1340
|
|
|
1341
1341
|
> `protected` **\_requestWithRedirects**(`context`, `options`): `Promise`\<`any`\>
|
|
1342
1342
|
|
|
1343
|
-
Defined in: [packages/web-fetcher/src/engine/cheerio.ts:
|
|
1343
|
+
Defined in: [packages/web-fetcher/src/engine/cheerio.ts:599](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/cheerio.ts#L599)
|
|
1344
1344
|
|
|
1345
1345
|
#### Parameters
|
|
1346
1346
|
|
|
@@ -1376,7 +1376,7 @@ Defined in: [packages/web-fetcher/src/engine/cheerio.ts:583](https://github.com/
|
|
|
1376
1376
|
|
|
1377
1377
|
> `protected` **\_sharedFailedRequestHandler**(`context`, `error?`): `Promise`\<`void`\>
|
|
1378
1378
|
|
|
1379
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1379
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:1269](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L1269)
|
|
1380
1380
|
|
|
1381
1381
|
#### Parameters
|
|
1382
1382
|
|
|
@@ -1402,7 +1402,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:1185](https://github.com/is
|
|
|
1402
1402
|
|
|
1403
1403
|
> `protected` **\_sharedRequestHandler**(`context`): `Promise`\<`void`\>
|
|
1404
1404
|
|
|
1405
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1405
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:1228](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L1228)
|
|
1406
1406
|
|
|
1407
1407
|
#### Parameters
|
|
1408
1408
|
|
|
@@ -1424,7 +1424,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:1144](https://github.com/is
|
|
|
1424
1424
|
|
|
1425
1425
|
> `protected` **\_updateStateAfterNavigation**(`context`, `loadedRequest`): `Promise`\<`void`\>
|
|
1426
1426
|
|
|
1427
|
-
Defined in: [packages/web-fetcher/src/engine/cheerio.ts:
|
|
1427
|
+
Defined in: [packages/web-fetcher/src/engine/cheerio.ts:680](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/cheerio.ts#L680)
|
|
1428
1428
|
|
|
1429
1429
|
#### Parameters
|
|
1430
1430
|
|
|
@@ -1446,7 +1446,7 @@ Defined in: [packages/web-fetcher/src/engine/cheerio.ts:656](https://github.com/
|
|
|
1446
1446
|
|
|
1447
1447
|
> **blockResources**(`types`, `overwrite?`): `Promise`\<`number`\>
|
|
1448
1448
|
|
|
1449
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1449
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:1385](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L1385)
|
|
1450
1450
|
|
|
1451
1451
|
Blocks specified resource types from loading.
|
|
1452
1452
|
|
|
@@ -1487,7 +1487,7 @@ await engine.blockResources(['script'], true); // Replace existing
|
|
|
1487
1487
|
|
|
1488
1488
|
> `protected` **buildResponse**(`context`): `Promise`\<[`FetchResponse`](../interfaces/FetchResponse.md)\>
|
|
1489
1489
|
|
|
1490
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1490
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:659](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L659)
|
|
1491
1491
|
|
|
1492
1492
|
#### Parameters
|
|
1493
1493
|
|
|
@@ -1509,7 +1509,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:638](https://github.com/isd
|
|
|
1509
1509
|
|
|
1510
1510
|
> **cleanup**(): `Promise`\<`void`\>
|
|
1511
1511
|
|
|
1512
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1512
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:1065](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L1065)
|
|
1513
1513
|
|
|
1514
1514
|
#### Returns
|
|
1515
1515
|
|
|
@@ -1525,7 +1525,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:992](https://github.com/isd
|
|
|
1525
1525
|
|
|
1526
1526
|
> **click**(`selector`): `Promise`\<`void`\>
|
|
1527
1527
|
|
|
1528
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1528
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:753](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L753)
|
|
1529
1529
|
|
|
1530
1530
|
Clicks on element matching selector.
|
|
1531
1531
|
|
|
@@ -1559,7 +1559,7 @@ When no active page context exists
|
|
|
1559
1559
|
|
|
1560
1560
|
> **cookies**(): `Promise`\<[`Cookie`](../interfaces/Cookie.md)[]\>
|
|
1561
1561
|
|
|
1562
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1562
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:1501](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L1501)
|
|
1563
1563
|
|
|
1564
1564
|
Manages cookies for current session with multiple overloads.
|
|
1565
1565
|
|
|
@@ -1588,7 +1588,7 @@ await engine.cookies([{ name: 'session', value: '123' }]);
|
|
|
1588
1588
|
|
|
1589
1589
|
> **cookies**(`cookies`): `Promise`\<`boolean`\>
|
|
1590
1590
|
|
|
1591
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1591
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:1502](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L1502)
|
|
1592
1592
|
|
|
1593
1593
|
Manages cookies for current session with multiple overloads.
|
|
1594
1594
|
|
|
@@ -1627,7 +1627,7 @@ await engine.cookies([{ name: 'session', value: '123' }]);
|
|
|
1627
1627
|
|
|
1628
1628
|
> `protected` **dispatchAction**\<`T`\>(`action`): `Promise`\<`T`\>
|
|
1629
1629
|
|
|
1630
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1630
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:1292](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L1292)
|
|
1631
1631
|
|
|
1632
1632
|
#### Type Parameters
|
|
1633
1633
|
|
|
@@ -1655,7 +1655,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:1208](https://github.com/is
|
|
|
1655
1655
|
|
|
1656
1656
|
> **dispose**(): `Promise`\<`void`\>
|
|
1657
1657
|
|
|
1658
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1658
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:1537](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L1537)
|
|
1659
1659
|
|
|
1660
1660
|
Disposes of engine, cleaning up all resources.
|
|
1661
1661
|
|
|
@@ -1675,7 +1675,7 @@ Promise resolving when disposal completes
|
|
|
1675
1675
|
|
|
1676
1676
|
> **evaluate**(`params`): `Promise`\<`any`\>
|
|
1677
1677
|
|
|
1678
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1678
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:873](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L873)
|
|
1679
1679
|
|
|
1680
1680
|
Executes a custom function or expression within the current page context.
|
|
1681
1681
|
|
|
@@ -1721,7 +1721,7 @@ If no active page context exists or if execution fails.
|
|
|
1721
1721
|
|
|
1722
1722
|
> `protected` **executeAction**(`context`, `action`): `Promise`\<`any`\>
|
|
1723
1723
|
|
|
1724
|
-
Defined in: [packages/web-fetcher/src/engine/cheerio.ts:289](https://github.com/isdk/web-fetcher.js/blob/
|
|
1724
|
+
Defined in: [packages/web-fetcher/src/engine/cheerio.ts:289](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/cheerio.ts#L289)
|
|
1725
1725
|
|
|
1726
1726
|
**`Internal`**
|
|
1727
1727
|
|
|
@@ -1761,7 +1761,7 @@ Handles specific user interactions using underlying technology (Playwright/Cheer
|
|
|
1761
1761
|
|
|
1762
1762
|
> **extract**\<`T`\>(`schema`): `Promise`\<`T`\>
|
|
1763
1763
|
|
|
1764
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1764
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:883](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L883)
|
|
1765
1765
|
|
|
1766
1766
|
Extracts structured data from the current page content.
|
|
1767
1767
|
|
|
@@ -1795,7 +1795,7 @@ A promise that resolves to an object with the extracted data.
|
|
|
1795
1795
|
|
|
1796
1796
|
> **fill**(`selector`, `value`): `Promise`\<`void`\>
|
|
1797
1797
|
|
|
1798
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1798
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:817](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L817)
|
|
1799
1799
|
|
|
1800
1800
|
Fills input element with specified value.
|
|
1801
1801
|
|
|
@@ -1833,7 +1833,7 @@ When no active page context exists
|
|
|
1833
1833
|
|
|
1834
1834
|
> **getContent**(): `Promise`\<[`FetchResponse`](../interfaces/FetchResponse.md)\>
|
|
1835
1835
|
|
|
1836
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1836
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:1399](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L1399)
|
|
1837
1837
|
|
|
1838
1838
|
Gets content of current page.
|
|
1839
1839
|
|
|
@@ -1857,7 +1857,7 @@ When no content has been fetched yet
|
|
|
1857
1857
|
|
|
1858
1858
|
> **getState**(): `Promise`\<\{ `cookies`: [`Cookie`](../interfaces/Cookie.md)[]; `sessionState?`: `any`; \}\>
|
|
1859
1859
|
|
|
1860
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1860
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:902](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L902)
|
|
1861
1861
|
|
|
1862
1862
|
Returns the current state of the engine (cookies)
|
|
1863
1863
|
that can be used to restore the session later.
|
|
@@ -1876,7 +1876,7 @@ that can be used to restore the session later.
|
|
|
1876
1876
|
|
|
1877
1877
|
> **goto**(`url`, `params?`): `Promise`\<`void` \| [`FetchResponse`](../interfaces/FetchResponse.md)\>
|
|
1878
1878
|
|
|
1879
|
-
Defined in: [packages/web-fetcher/src/engine/cheerio.ts:
|
|
1879
|
+
Defined in: [packages/web-fetcher/src/engine/cheerio.ts:725](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/cheerio.ts#L725)
|
|
1880
1880
|
|
|
1881
1881
|
Navigates to the specified URL.
|
|
1882
1882
|
|
|
@@ -1918,7 +1918,7 @@ await engine.goto('https://example.com');
|
|
|
1918
1918
|
|
|
1919
1919
|
> **headers**(): `Promise`\<`Record`\<`string`, `string`\>\>
|
|
1920
1920
|
|
|
1921
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1921
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:1440](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L1440)
|
|
1922
1922
|
|
|
1923
1923
|
Manages HTTP headers for requests with multiple overloads.
|
|
1924
1924
|
|
|
@@ -1949,7 +1949,7 @@ await engine.headers('auth', 'token');
|
|
|
1949
1949
|
|
|
1950
1950
|
> **headers**(`name`): `Promise`\<`string`\>
|
|
1951
1951
|
|
|
1952
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1952
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:1441](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L1441)
|
|
1953
1953
|
|
|
1954
1954
|
Manages HTTP headers for requests with multiple overloads.
|
|
1955
1955
|
|
|
@@ -1988,7 +1988,7 @@ await engine.headers('auth', 'token');
|
|
|
1988
1988
|
|
|
1989
1989
|
> **headers**(`headers`, `replaced?`): `Promise`\<`boolean`\>
|
|
1990
1990
|
|
|
1991
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1991
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:1442](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L1442)
|
|
1992
1992
|
|
|
1993
1993
|
Manages HTTP headers for requests with multiple overloads.
|
|
1994
1994
|
|
|
@@ -2033,7 +2033,7 @@ await engine.headers('auth', 'token');
|
|
|
2033
2033
|
|
|
2034
2034
|
> **headers**(`name`, `value`): `Promise`\<`boolean`\>
|
|
2035
2035
|
|
|
2036
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
2036
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:1446](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L1446)
|
|
2037
2037
|
|
|
2038
2038
|
Manages HTTP headers for requests with multiple overloads.
|
|
2039
2039
|
|
|
@@ -2080,7 +2080,7 @@ await engine.headers('auth', 'token');
|
|
|
2080
2080
|
|
|
2081
2081
|
> **initialize**(`context`, `options?`): `Promise`\<`void`\>
|
|
2082
2082
|
|
|
2083
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
2083
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:934](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L934)
|
|
2084
2084
|
|
|
2085
2085
|
Initializes the fetch engine with provided context and options.
|
|
2086
2086
|
|
|
@@ -2115,11 +2115,159 @@ Automatically called when creating engine via `FetchEngine.create()`.
|
|
|
2115
2115
|
|
|
2116
2116
|
***
|
|
2117
2117
|
|
|
2118
|
+
### keyboardPress()
|
|
2119
|
+
|
|
2120
|
+
> **keyboardPress**(`key`, `delay?`): `Promise`\<`void`\>
|
|
2121
|
+
|
|
2122
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:802](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L802)
|
|
2123
|
+
|
|
2124
|
+
Presses specified key.
|
|
2125
|
+
|
|
2126
|
+
#### Parameters
|
|
2127
|
+
|
|
2128
|
+
##### key
|
|
2129
|
+
|
|
2130
|
+
`string`
|
|
2131
|
+
|
|
2132
|
+
Key to press
|
|
2133
|
+
|
|
2134
|
+
##### delay?
|
|
2135
|
+
|
|
2136
|
+
`number`
|
|
2137
|
+
|
|
2138
|
+
Delay after key press
|
|
2139
|
+
|
|
2140
|
+
#### Returns
|
|
2141
|
+
|
|
2142
|
+
`Promise`\<`void`\>
|
|
2143
|
+
|
|
2144
|
+
#### Inherited from
|
|
2145
|
+
|
|
2146
|
+
[`FetchEngine`](FetchEngine.md).[`keyboardPress`](FetchEngine.md#keyboardpress)
|
|
2147
|
+
|
|
2148
|
+
***
|
|
2149
|
+
|
|
2150
|
+
### keyboardType()
|
|
2151
|
+
|
|
2152
|
+
> **keyboardType**(`text`, `delay?`): `Promise`\<`void`\>
|
|
2153
|
+
|
|
2154
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:792](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L792)
|
|
2155
|
+
|
|
2156
|
+
Types text into current focused element.
|
|
2157
|
+
|
|
2158
|
+
#### Parameters
|
|
2159
|
+
|
|
2160
|
+
##### text
|
|
2161
|
+
|
|
2162
|
+
`string`
|
|
2163
|
+
|
|
2164
|
+
Text to type
|
|
2165
|
+
|
|
2166
|
+
##### delay?
|
|
2167
|
+
|
|
2168
|
+
`number`
|
|
2169
|
+
|
|
2170
|
+
Delay between key presses
|
|
2171
|
+
|
|
2172
|
+
#### Returns
|
|
2173
|
+
|
|
2174
|
+
`Promise`\<`void`\>
|
|
2175
|
+
|
|
2176
|
+
#### Inherited from
|
|
2177
|
+
|
|
2178
|
+
[`FetchEngine`](FetchEngine.md).[`keyboardType`](FetchEngine.md#keyboardtype)
|
|
2179
|
+
|
|
2180
|
+
***
|
|
2181
|
+
|
|
2182
|
+
### mouseClick()
|
|
2183
|
+
|
|
2184
|
+
> **mouseClick**(`params`): `Promise`\<`void`\>
|
|
2185
|
+
|
|
2186
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:776](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L776)
|
|
2187
|
+
|
|
2188
|
+
Clicks at current position or specified position.
|
|
2189
|
+
|
|
2190
|
+
#### Parameters
|
|
2191
|
+
|
|
2192
|
+
##### params
|
|
2193
|
+
|
|
2194
|
+
Click parameters (x, y, button, clickCount, delay)
|
|
2195
|
+
|
|
2196
|
+
###### button?
|
|
2197
|
+
|
|
2198
|
+
`"left"` \| `"right"` \| `"middle"`
|
|
2199
|
+
|
|
2200
|
+
###### clickCount?
|
|
2201
|
+
|
|
2202
|
+
`number`
|
|
2203
|
+
|
|
2204
|
+
###### delay?
|
|
2205
|
+
|
|
2206
|
+
`number`
|
|
2207
|
+
|
|
2208
|
+
###### x?
|
|
2209
|
+
|
|
2210
|
+
`number`
|
|
2211
|
+
|
|
2212
|
+
###### y?
|
|
2213
|
+
|
|
2214
|
+
`number`
|
|
2215
|
+
|
|
2216
|
+
#### Returns
|
|
2217
|
+
|
|
2218
|
+
`Promise`\<`void`\>
|
|
2219
|
+
|
|
2220
|
+
#### Inherited from
|
|
2221
|
+
|
|
2222
|
+
[`FetchEngine`](FetchEngine.md).[`mouseClick`](FetchEngine.md#mouseclick)
|
|
2223
|
+
|
|
2224
|
+
***
|
|
2225
|
+
|
|
2226
|
+
### mouseMove()
|
|
2227
|
+
|
|
2228
|
+
> **mouseMove**(`params`): `Promise`\<`void`\>
|
|
2229
|
+
|
|
2230
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:762](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L762)
|
|
2231
|
+
|
|
2232
|
+
Moves mouse to specified position or element.
|
|
2233
|
+
|
|
2234
|
+
#### Parameters
|
|
2235
|
+
|
|
2236
|
+
##### params
|
|
2237
|
+
|
|
2238
|
+
Move parameters (x, y, selector, steps)
|
|
2239
|
+
|
|
2240
|
+
###### selector?
|
|
2241
|
+
|
|
2242
|
+
`string`
|
|
2243
|
+
|
|
2244
|
+
###### steps?
|
|
2245
|
+
|
|
2246
|
+
`number`
|
|
2247
|
+
|
|
2248
|
+
###### x?
|
|
2249
|
+
|
|
2250
|
+
`number`
|
|
2251
|
+
|
|
2252
|
+
###### y?
|
|
2253
|
+
|
|
2254
|
+
`number`
|
|
2255
|
+
|
|
2256
|
+
#### Returns
|
|
2257
|
+
|
|
2258
|
+
`Promise`\<`void`\>
|
|
2259
|
+
|
|
2260
|
+
#### Inherited from
|
|
2261
|
+
|
|
2262
|
+
[`FetchEngine`](FetchEngine.md).[`mouseMove`](FetchEngine.md#mousemove)
|
|
2263
|
+
|
|
2264
|
+
***
|
|
2265
|
+
|
|
2118
2266
|
### pause()
|
|
2119
2267
|
|
|
2120
2268
|
> **pause**(`message?`): `Promise`\<`void`\>
|
|
2121
2269
|
|
|
2122
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
2270
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:851](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L851)
|
|
2123
2271
|
|
|
2124
2272
|
Pauses execution, allowing for manual intervention or inspection.
|
|
2125
2273
|
|
|
@@ -2151,7 +2299,7 @@ When no active page context exists
|
|
|
2151
2299
|
|
|
2152
2300
|
> **submit**(`selector?`, `options?`): `Promise`\<`void`\>
|
|
2153
2301
|
|
|
2154
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
2302
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:829](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L829)
|
|
2155
2303
|
|
|
2156
2304
|
Submits a form.
|
|
2157
2305
|
|
|
@@ -2189,7 +2337,7 @@ When no active page context exists
|
|
|
2189
2337
|
|
|
2190
2338
|
> **trim**(`options`): `Promise`\<`void`\>
|
|
2191
2339
|
|
|
2192
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
2340
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:840](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L840)
|
|
2193
2341
|
|
|
2194
2342
|
Removes elements from the DOM based on selectors and presets.
|
|
2195
2343
|
|
|
@@ -2221,7 +2369,7 @@ When no active page context exists
|
|
|
2221
2369
|
|
|
2222
2370
|
> **waitFor**(`params?`): `Promise`\<`void`\>
|
|
2223
2371
|
|
|
2224
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
2372
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:742](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L742)
|
|
2225
2373
|
|
|
2226
2374
|
Waits for specified condition before continuing.
|
|
2227
2375
|
|
|
@@ -2256,7 +2404,7 @@ await engine.waitFor({ selector: '#content' }); // Wait for element
|
|
|
2256
2404
|
|
|
2257
2405
|
> `static` **create**(`ctx`, `options?`): `Promise`\<`AnyFetchEngine` \| `undefined`\>
|
|
2258
2406
|
|
|
2259
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
2407
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:349](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L349)
|
|
2260
2408
|
|
|
2261
2409
|
Factory method to create and initialize a fetch engine instance.
|
|
2262
2410
|
|
|
@@ -2298,7 +2446,7 @@ Primary entry point for engine creation. Selects appropriate implementation base
|
|
|
2298
2446
|
|
|
2299
2447
|
> `static` **get**(`id`): `AnyFetchEngineCtor` \| `undefined`
|
|
2300
2448
|
|
|
2301
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
2449
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:322](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L322)
|
|
2302
2450
|
|
|
2303
2451
|
Retrieves a fetch engine implementation by its unique ID.
|
|
2304
2452
|
|
|
@@ -2326,7 +2474,7 @@ Engine class if found, otherwise `undefined`
|
|
|
2326
2474
|
|
|
2327
2475
|
> `static` **getByMode**(`mode`): `AnyFetchEngineCtor` \| `undefined`
|
|
2328
2476
|
|
|
2329
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
2477
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:332](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L332)
|
|
2330
2478
|
|
|
2331
2479
|
Retrieves a fetch engine implementation by execution mode.
|
|
2332
2480
|
|
|
@@ -2354,7 +2502,7 @@ Engine class if found, otherwise `undefined`
|
|
|
2354
2502
|
|
|
2355
2503
|
> `static` **register**(`engineClass`): `void`
|
|
2356
2504
|
|
|
2357
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
2505
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:309](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L309)
|
|
2358
2506
|
|
|
2359
2507
|
Registers a fetch engine implementation with the global registry.
|
|
2360
2508
|
|