@isdk/web-fetcher 0.2.7 → 0.2.8
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.cn.md +4 -1
- package/README.engine.cn.md +3 -1
- package/README.engine.md +3 -1
- package/README.md +4 -1
- package/dist/index.d.mts +4 -1
- package/dist/index.d.ts +4 -1
- package/dist/index.js +1 -1
- package/dist/index.mjs +1 -1
- package/docs/README.md +4 -1
- package/docs/_media/README.cn.md +4 -1
- package/docs/_media/README.engine.md +3 -1
- package/docs/classes/CheerioFetchEngine.md +71 -59
- 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 +67 -59
- package/docs/classes/FetchSession.md +10 -10
- 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 +71 -59
- 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 +11 -11
- package/docs/interfaces/BaseFetchCollectorActionProperties.md +15 -15
- package/docs/interfaces/BaseFetcherProperties.md +32 -24
- package/docs/interfaces/DispatchedEngineAction.md +4 -4
- package/docs/interfaces/ExtractActionProperties.md +11 -11
- package/docs/interfaces/FetchActionInContext.md +15 -15
- package/docs/interfaces/FetchActionProperties.md +12 -12
- package/docs/interfaces/FetchActionResult.md +6 -6
- package/docs/interfaces/FetchContext.md +46 -34
- package/docs/interfaces/FetchEngineContext.md +41 -29
- 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 +39 -27
- package/docs/interfaces/FetcherOptions.md +38 -26
- 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 +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 +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/docs/variables/FetcherOptionKeys.md +1 -1
- package/package.json +3 -2
|
@@ -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/7bb51cb9bc54b4138642b08ddf371740d89af7ca/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` `optional` **\_initialCookies**: [`Cookie`](../interfaces/Cookie.md)[]
|
|
34
34
|
|
|
35
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:236](https://github.com/isdk/web-fetcher.js/blob/
|
|
35
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:236](https://github.com/isdk/web-fetcher.js/blob/7bb51cb9bc54b4138642b08ddf371740d89af7ca/src/engine/base.ts#L236)
|
|
36
36
|
|
|
37
37
|
#### Inherited from
|
|
38
38
|
|
|
@@ -40,11 +40,23 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:236](https://github.com/isd
|
|
|
40
40
|
|
|
41
41
|
***
|
|
42
42
|
|
|
43
|
+
### \_initializedSessions
|
|
44
|
+
|
|
45
|
+
> `protected` **\_initializedSessions**: `Set`\<`string`\>
|
|
46
|
+
|
|
47
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:237](https://github.com/isdk/web-fetcher.js/blob/7bb51cb9bc54b4138642b08ddf371740d89af7ca/src/engine/base.ts#L237)
|
|
48
|
+
|
|
49
|
+
#### Inherited from
|
|
50
|
+
|
|
51
|
+
[`FetchEngine`](FetchEngine.md).[`_initializedSessions`](FetchEngine.md#_initializedsessions)
|
|
52
|
+
|
|
53
|
+
***
|
|
54
|
+
|
|
43
55
|
### actionEmitter
|
|
44
56
|
|
|
45
57
|
> `protected` **actionEmitter**: `EventEmitter`
|
|
46
58
|
|
|
47
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
59
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:241](https://github.com/isdk/web-fetcher.js/blob/7bb51cb9bc54b4138642b08ddf371740d89af7ca/src/engine/base.ts#L241)
|
|
48
60
|
|
|
49
61
|
#### Inherited from
|
|
50
62
|
|
|
@@ -56,7 +68,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:240](https://github.com/isd
|
|
|
56
68
|
|
|
57
69
|
> `protected` **blockedTypes**: `Set`\<`string`\>
|
|
58
70
|
|
|
59
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
71
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:245](https://github.com/isdk/web-fetcher.js/blob/7bb51cb9bc54b4138642b08ddf371740d89af7ca/src/engine/base.ts#L245)
|
|
60
72
|
|
|
61
73
|
#### Inherited from
|
|
62
74
|
|
|
@@ -68,7 +80,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:244](https://github.com/isd
|
|
|
68
80
|
|
|
69
81
|
> `protected` `optional` **crawler**: `CheerioCrawler`
|
|
70
82
|
|
|
71
|
-
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/7bb51cb9bc54b4138642b08ddf371740d89af7ca/src/engine/base.ts#L231)
|
|
72
84
|
|
|
73
85
|
#### Inherited from
|
|
74
86
|
|
|
@@ -80,7 +92,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:231](https://github.com/isd
|
|
|
80
92
|
|
|
81
93
|
> `protected` `optional` **ctx**: [`FetchEngineContext`](../interfaces/FetchEngineContext.md)
|
|
82
94
|
|
|
83
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:229](https://github.com/isdk/web-fetcher.js/blob/
|
|
95
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:229](https://github.com/isdk/web-fetcher.js/blob/7bb51cb9bc54b4138642b08ddf371740d89af7ca/src/engine/base.ts#L229)
|
|
84
96
|
|
|
85
97
|
#### Inherited from
|
|
86
98
|
|
|
@@ -92,7 +104,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:229](https://github.com/isd
|
|
|
92
104
|
|
|
93
105
|
> `protected` `optional` **currentSession**: `Session`
|
|
94
106
|
|
|
95
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
107
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:238](https://github.com/isdk/web-fetcher.js/blob/7bb51cb9bc54b4138642b08ddf371740d89af7ca/src/engine/base.ts#L238)
|
|
96
108
|
|
|
97
109
|
#### Inherited from
|
|
98
110
|
|
|
@@ -104,7 +116,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:237](https://github.com/isd
|
|
|
104
116
|
|
|
105
117
|
> `protected` **hdrs**: `Record`\<`string`, `string`\> = `{}`
|
|
106
118
|
|
|
107
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:235](https://github.com/isdk/web-fetcher.js/blob/
|
|
119
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:235](https://github.com/isdk/web-fetcher.js/blob/7bb51cb9bc54b4138642b08ddf371740d89af7ca/src/engine/base.ts#L235)
|
|
108
120
|
|
|
109
121
|
#### Inherited from
|
|
110
122
|
|
|
@@ -116,7 +128,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:235](https://github.com/isd
|
|
|
116
128
|
|
|
117
129
|
> `protected` `optional` **isCrawlerReady**: `boolean`
|
|
118
130
|
|
|
119
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:232](https://github.com/isdk/web-fetcher.js/blob/
|
|
131
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:232](https://github.com/isdk/web-fetcher.js/blob/7bb51cb9bc54b4138642b08ddf371740d89af7ca/src/engine/base.ts#L232)
|
|
120
132
|
|
|
121
133
|
#### Inherited from
|
|
122
134
|
|
|
@@ -128,7 +140,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:232](https://github.com/isd
|
|
|
128
140
|
|
|
129
141
|
> `protected` **isPageActive**: `boolean` = `false`
|
|
130
142
|
|
|
131
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
143
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:242](https://github.com/isdk/web-fetcher.js/blob/7bb51cb9bc54b4138642b08ddf371740d89af7ca/src/engine/base.ts#L242)
|
|
132
144
|
|
|
133
145
|
#### Inherited from
|
|
134
146
|
|
|
@@ -140,7 +152,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:241](https://github.com/isd
|
|
|
140
152
|
|
|
141
153
|
> `protected` `optional` **lastResponse**: [`FetchResponse`](../interfaces/FetchResponse.md)
|
|
142
154
|
|
|
143
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
155
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:244](https://github.com/isdk/web-fetcher.js/blob/7bb51cb9bc54b4138642b08ddf371740d89af7ca/src/engine/base.ts#L244)
|
|
144
156
|
|
|
145
157
|
#### Inherited from
|
|
146
158
|
|
|
@@ -152,7 +164,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:243](https://github.com/isd
|
|
|
152
164
|
|
|
153
165
|
> `protected` **navigationLock**: `PromiseLock`
|
|
154
166
|
|
|
155
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
167
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:243](https://github.com/isdk/web-fetcher.js/blob/7bb51cb9bc54b4138642b08ddf371740d89af7ca/src/engine/base.ts#L243)
|
|
156
168
|
|
|
157
169
|
#### Inherited from
|
|
158
170
|
|
|
@@ -164,7 +176,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:242](https://github.com/isd
|
|
|
164
176
|
|
|
165
177
|
> `protected` `optional` **opts**: [`BaseFetcherProperties`](../interfaces/BaseFetcherProperties.md)
|
|
166
178
|
|
|
167
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:230](https://github.com/isdk/web-fetcher.js/blob/
|
|
179
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:230](https://github.com/isdk/web-fetcher.js/blob/7bb51cb9bc54b4138642b08ddf371740d89af7ca/src/engine/base.ts#L230)
|
|
168
180
|
|
|
169
181
|
#### Inherited from
|
|
170
182
|
|
|
@@ -176,7 +188,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:230](https://github.com/isd
|
|
|
176
188
|
|
|
177
189
|
> `protected` **pendingRequests**: `Map`\<`string`, [`PendingEngineRequest`](../interfaces/PendingEngineRequest.md)\>
|
|
178
190
|
|
|
179
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
191
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:239](https://github.com/isdk/web-fetcher.js/blob/7bb51cb9bc54b4138642b08ddf371740d89af7ca/src/engine/base.ts#L239)
|
|
180
192
|
|
|
181
193
|
#### Inherited from
|
|
182
194
|
|
|
@@ -188,7 +200,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:238](https://github.com/isd
|
|
|
188
200
|
|
|
189
201
|
> `protected` **requestCounter**: `number` = `0`
|
|
190
202
|
|
|
191
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
203
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:240](https://github.com/isdk/web-fetcher.js/blob/7bb51cb9bc54b4138642b08ddf371740d89af7ca/src/engine/base.ts#L240)
|
|
192
204
|
|
|
193
205
|
#### Inherited from
|
|
194
206
|
|
|
@@ -200,7 +212,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:239](https://github.com/isd
|
|
|
200
212
|
|
|
201
213
|
> `protected` `optional` **requestQueue**: `RequestQueue`
|
|
202
214
|
|
|
203
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:233](https://github.com/isdk/web-fetcher.js/blob/
|
|
215
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:233](https://github.com/isdk/web-fetcher.js/blob/7bb51cb9bc54b4138642b08ddf371740d89af7ca/src/engine/base.ts#L233)
|
|
204
216
|
|
|
205
217
|
#### Inherited from
|
|
206
218
|
|
|
@@ -212,7 +224,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:233](https://github.com/isd
|
|
|
212
224
|
|
|
213
225
|
> `readonly` `static` **id**: `"cheerio"` = `'cheerio'`
|
|
214
226
|
|
|
215
|
-
Defined in: [packages/web-fetcher/src/engine/cheerio.ts:25](https://github.com/isdk/web-fetcher.js/blob/
|
|
227
|
+
Defined in: [packages/web-fetcher/src/engine/cheerio.ts:25](https://github.com/isdk/web-fetcher.js/blob/7bb51cb9bc54b4138642b08ddf371740d89af7ca/src/engine/cheerio.ts#L25)
|
|
216
228
|
|
|
217
229
|
Unique identifier for the engine implementation.
|
|
218
230
|
|
|
@@ -230,7 +242,7 @@ Must be defined by concrete implementations. Used for registration and lookup in
|
|
|
230
242
|
|
|
231
243
|
> `readonly` `static` **mode**: `"http"` = `'http'`
|
|
232
244
|
|
|
233
|
-
Defined in: [packages/web-fetcher/src/engine/cheerio.ts:26](https://github.com/isdk/web-fetcher.js/blob/
|
|
245
|
+
Defined in: [packages/web-fetcher/src/engine/cheerio.ts:26](https://github.com/isdk/web-fetcher.js/blob/7bb51cb9bc54b4138642b08ddf371740d89af7ca/src/engine/cheerio.ts#L26)
|
|
234
246
|
|
|
235
247
|
Execution mode of the engine (`'http'` or `'browser'`).
|
|
236
248
|
|
|
@@ -250,7 +262,7 @@ Must be defined by concrete implementations. Indicates whether engine operates a
|
|
|
250
262
|
|
|
251
263
|
> **get** **context**(): `undefined` \| [`FetchEngineContext`](../interfaces/FetchEngineContext.md)
|
|
252
264
|
|
|
253
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
265
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:497](https://github.com/isdk/web-fetcher.js/blob/7bb51cb9bc54b4138642b08ddf371740d89af7ca/src/engine/base.ts#L497)
|
|
254
266
|
|
|
255
267
|
Gets the fetch engine context associated with this instance.
|
|
256
268
|
|
|
@@ -270,7 +282,7 @@ Gets the fetch engine context associated with this instance.
|
|
|
270
282
|
|
|
271
283
|
> **get** **id**(): `string`
|
|
272
284
|
|
|
273
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
285
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:472](https://github.com/isdk/web-fetcher.js/blob/7bb51cb9bc54b4138642b08ddf371740d89af7ca/src/engine/base.ts#L472)
|
|
274
286
|
|
|
275
287
|
Gets the unique identifier of this engine implementation.
|
|
276
288
|
|
|
@@ -290,7 +302,7 @@ Gets the unique identifier of this engine implementation.
|
|
|
290
302
|
|
|
291
303
|
> **get** **mode**(): [`FetchEngineType`](../type-aliases/FetchEngineType.md)
|
|
292
304
|
|
|
293
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
305
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:490](https://github.com/isdk/web-fetcher.js/blob/7bb51cb9bc54b4138642b08ddf371740d89af7ca/src/engine/base.ts#L490)
|
|
294
306
|
|
|
295
307
|
Gets the execution mode of this engine (`'http'` or `'browser'`).
|
|
296
308
|
|
|
@@ -308,7 +320,7 @@ Gets the execution mode of this engine (`'http'` or `'browser'`).
|
|
|
308
320
|
|
|
309
321
|
> `protected` **\_buildResponse**(`context`): `Promise`\<[`FetchResponse`](../interfaces/FetchResponse.md)\>
|
|
310
322
|
|
|
311
|
-
Defined in: [packages/web-fetcher/src/engine/cheerio.ts:
|
|
323
|
+
Defined in: [packages/web-fetcher/src/engine/cheerio.ts:39](https://github.com/isdk/web-fetcher.js/blob/7bb51cb9bc54b4138642b08ddf371740d89af7ca/src/engine/cheerio.ts#L39)
|
|
312
324
|
|
|
313
325
|
**`Internal`**
|
|
314
326
|
|
|
@@ -342,7 +354,7 @@ Converts implementation-specific context (Playwright `page` or Cheerio `$`) to s
|
|
|
342
354
|
|
|
343
355
|
> `protected` `optional` **\_cleanup**(): `Promise`\<`void`\>
|
|
344
356
|
|
|
345
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
357
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:247](https://github.com/isdk/web-fetcher.js/blob/7bb51cb9bc54b4138642b08ddf371740d89af7ca/src/engine/base.ts#L247)
|
|
346
358
|
|
|
347
359
|
#### Returns
|
|
348
360
|
|
|
@@ -358,7 +370,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:246](https://github.com/isd
|
|
|
358
370
|
|
|
359
371
|
> `protected` **\_commonCleanup**(): `Promise`\<`void`\>
|
|
360
372
|
|
|
361
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
373
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:718](https://github.com/isdk/web-fetcher.js/blob/7bb51cb9bc54b4138642b08ddf371740d89af7ca/src/engine/base.ts#L718)
|
|
362
374
|
|
|
363
375
|
#### Returns
|
|
364
376
|
|
|
@@ -374,7 +386,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:710](https://github.com/isd
|
|
|
374
386
|
|
|
375
387
|
> `protected` **\_createCrawler**(`options`): `CheerioCrawler`
|
|
376
388
|
|
|
377
|
-
Defined in: [packages/web-fetcher/src/engine/cheerio.ts:
|
|
389
|
+
Defined in: [packages/web-fetcher/src/engine/cheerio.ts:259](https://github.com/isdk/web-fetcher.js/blob/7bb51cb9bc54b4138642b08ddf371740d89af7ca/src/engine/cheerio.ts#L259)
|
|
378
390
|
|
|
379
391
|
**`Internal`**
|
|
380
392
|
|
|
@@ -402,7 +414,7 @@ The final crawler options.
|
|
|
402
414
|
|
|
403
415
|
> `protected` **\_executePendingActions**(`context`): `Promise`\<`void`\>
|
|
404
416
|
|
|
405
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
417
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:627](https://github.com/isdk/web-fetcher.js/blob/7bb51cb9bc54b4138642b08ddf371740d89af7ca/src/engine/base.ts#L627)
|
|
406
418
|
|
|
407
419
|
**`Internal`**
|
|
408
420
|
|
|
@@ -455,7 +467,7 @@ If called outside valid page context window (`!this.isPageActive`)
|
|
|
455
467
|
|
|
456
468
|
> `protected` **\_extract**(`schema`, `context`): `Promise`\<`any`\>
|
|
457
469
|
|
|
458
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
470
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:252](https://github.com/isdk/web-fetcher.js/blob/7bb51cb9bc54b4138642b08ddf371740d89af7ca/src/engine/base.ts#L252)
|
|
459
471
|
|
|
460
472
|
#### Parameters
|
|
461
473
|
|
|
@@ -481,7 +493,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:251](https://github.com/isd
|
|
|
481
493
|
|
|
482
494
|
> `protected` **\_extractValue**(`schema`, `context`): `Promise`\<`any`\>
|
|
483
495
|
|
|
484
|
-
Defined in: [packages/web-fetcher/src/engine/cheerio.ts:
|
|
496
|
+
Defined in: [packages/web-fetcher/src/engine/cheerio.ts:76](https://github.com/isdk/web-fetcher.js/blob/7bb51cb9bc54b4138642b08ddf371740d89af7ca/src/engine/cheerio.ts#L76)
|
|
485
497
|
|
|
486
498
|
#### Parameters
|
|
487
499
|
|
|
@@ -509,7 +521,7 @@ Defined in: [packages/web-fetcher/src/engine/cheerio.ts:64](https://github.com/i
|
|
|
509
521
|
|
|
510
522
|
> `protected` **\_getSpecificCrawlerOptions**(`ctx`): `CheerioCrawlerOptions`
|
|
511
523
|
|
|
512
|
-
Defined in: [packages/web-fetcher/src/engine/cheerio.ts:
|
|
524
|
+
Defined in: [packages/web-fetcher/src/engine/cheerio.ts:263](https://github.com/isdk/web-fetcher.js/blob/7bb51cb9bc54b4138642b08ddf371740d89af7ca/src/engine/cheerio.ts#L263)
|
|
513
525
|
|
|
514
526
|
**`Internal`**
|
|
515
527
|
|
|
@@ -537,7 +549,7 @@ The fetch engine context.
|
|
|
537
549
|
|
|
538
550
|
> `protected` **\_normalizeSchema**(`schema`): `ExtractSchema`
|
|
539
551
|
|
|
540
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
552
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:428](https://github.com/isdk/web-fetcher.js/blob/7bb51cb9bc54b4138642b08ddf371740d89af7ca/src/engine/base.ts#L428)
|
|
541
553
|
|
|
542
554
|
#### Parameters
|
|
543
555
|
|
|
@@ -559,7 +571,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:427](https://github.com/isd
|
|
|
559
571
|
|
|
560
572
|
> `protected` **\_querySelectorAll**(`context`, `selector`): `Promise`\<`any`[]\>
|
|
561
573
|
|
|
562
|
-
Defined in: [packages/web-fetcher/src/engine/cheerio.ts:
|
|
574
|
+
Defined in: [packages/web-fetcher/src/engine/cheerio.ts:71](https://github.com/isdk/web-fetcher.js/blob/7bb51cb9bc54b4138642b08ddf371740d89af7ca/src/engine/cheerio.ts#L71)
|
|
563
575
|
|
|
564
576
|
#### Parameters
|
|
565
577
|
|
|
@@ -591,7 +603,7 @@ Defined in: [packages/web-fetcher/src/engine/cheerio.ts:59](https://github.com/i
|
|
|
591
603
|
|
|
592
604
|
> `protected` **\_sharedFailedRequestHandler**(`context`, `error?`): `Promise`\<`void`\>
|
|
593
605
|
|
|
594
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
606
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:685](https://github.com/isdk/web-fetcher.js/blob/7bb51cb9bc54b4138642b08ddf371740d89af7ca/src/engine/base.ts#L685)
|
|
595
607
|
|
|
596
608
|
#### Parameters
|
|
597
609
|
|
|
@@ -617,7 +629,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:677](https://github.com/isd
|
|
|
617
629
|
|
|
618
630
|
> `protected` **\_sharedRequestHandler**(`context`): `Promise`\<`void`\>
|
|
619
631
|
|
|
620
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
632
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:650](https://github.com/isdk/web-fetcher.js/blob/7bb51cb9bc54b4138642b08ddf371740d89af7ca/src/engine/base.ts#L650)
|
|
621
633
|
|
|
622
634
|
#### Parameters
|
|
623
635
|
|
|
@@ -639,7 +651,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:648](https://github.com/isd
|
|
|
639
651
|
|
|
640
652
|
> **blockResources**(`types`, `overwrite?`): `Promise`\<`number`\>
|
|
641
653
|
|
|
642
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
654
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:763](https://github.com/isdk/web-fetcher.js/blob/7bb51cb9bc54b4138642b08ddf371740d89af7ca/src/engine/base.ts#L763)
|
|
643
655
|
|
|
644
656
|
Blocks specified resource types from loading.
|
|
645
657
|
|
|
@@ -680,7 +692,7 @@ await engine.blockResources(['script'], true); // Replace existing
|
|
|
680
692
|
|
|
681
693
|
> `protected` **buildResponse**(`context`): `Promise`\<[`FetchResponse`](../interfaces/FetchResponse.md)\>
|
|
682
694
|
|
|
683
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
695
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:321](https://github.com/isdk/web-fetcher.js/blob/7bb51cb9bc54b4138642b08ddf371740d89af7ca/src/engine/base.ts#L321)
|
|
684
696
|
|
|
685
697
|
#### Parameters
|
|
686
698
|
|
|
@@ -702,7 +714,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:320](https://github.com/isd
|
|
|
702
714
|
|
|
703
715
|
> **cleanup**(): `Promise`\<`void`\>
|
|
704
716
|
|
|
705
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
717
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:591](https://github.com/isdk/web-fetcher.js/blob/7bb51cb9bc54b4138642b08ddf371740d89af7ca/src/engine/base.ts#L591)
|
|
706
718
|
|
|
707
719
|
#### Returns
|
|
708
720
|
|
|
@@ -718,7 +730,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:589](https://github.com/isd
|
|
|
718
730
|
|
|
719
731
|
> **click**(`selector`): `Promise`\<`void`\>
|
|
720
732
|
|
|
721
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
733
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:378](https://github.com/isdk/web-fetcher.js/blob/7bb51cb9bc54b4138642b08ddf371740d89af7ca/src/engine/base.ts#L378)
|
|
722
734
|
|
|
723
735
|
Clicks on element matching selector.
|
|
724
736
|
|
|
@@ -752,7 +764,7 @@ When no active page context exists
|
|
|
752
764
|
|
|
753
765
|
> **cookies**(): `Promise`\<[`Cookie`](../interfaces/Cookie.md)[]\>
|
|
754
766
|
|
|
755
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
767
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:874](https://github.com/isdk/web-fetcher.js/blob/7bb51cb9bc54b4138642b08ddf371740d89af7ca/src/engine/base.ts#L874)
|
|
756
768
|
|
|
757
769
|
Manages cookies for current session with multiple overloads.
|
|
758
770
|
|
|
@@ -781,7 +793,7 @@ await engine.cookies([{ name: 'session', value: '123' }]);
|
|
|
781
793
|
|
|
782
794
|
> **cookies**(`cookies`): `Promise`\<`boolean`\>
|
|
783
795
|
|
|
784
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
796
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:875](https://github.com/isdk/web-fetcher.js/blob/7bb51cb9bc54b4138642b08ddf371740d89af7ca/src/engine/base.ts#L875)
|
|
785
797
|
|
|
786
798
|
Manages cookies for current session with multiple overloads.
|
|
787
799
|
|
|
@@ -820,7 +832,7 @@ await engine.cookies([{ name: 'session', value: '123' }]);
|
|
|
820
832
|
|
|
821
833
|
> `protected` **dispatchAction**\<`T`\>(`action`): `Promise`\<`T`\>
|
|
822
834
|
|
|
823
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
835
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:701](https://github.com/isdk/web-fetcher.js/blob/7bb51cb9bc54b4138642b08ddf371740d89af7ca/src/engine/base.ts#L701)
|
|
824
836
|
|
|
825
837
|
#### Type Parameters
|
|
826
838
|
|
|
@@ -848,7 +860,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:693](https://github.com/isd
|
|
|
848
860
|
|
|
849
861
|
> **dispose**(): `Promise`\<`void`\>
|
|
850
862
|
|
|
851
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
863
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:910](https://github.com/isdk/web-fetcher.js/blob/7bb51cb9bc54b4138642b08ddf371740d89af7ca/src/engine/base.ts#L910)
|
|
852
864
|
|
|
853
865
|
Disposes of engine, cleaning up all resources.
|
|
854
866
|
|
|
@@ -868,7 +880,7 @@ Promise resolving when disposal completes
|
|
|
868
880
|
|
|
869
881
|
> `protected` **executeAction**(`context`, `action`): `Promise`\<`any`\>
|
|
870
882
|
|
|
871
|
-
Defined in: [packages/web-fetcher/src/engine/cheerio.ts:
|
|
883
|
+
Defined in: [packages/web-fetcher/src/engine/cheerio.ts:104](https://github.com/isdk/web-fetcher.js/blob/7bb51cb9bc54b4138642b08ddf371740d89af7ca/src/engine/cheerio.ts#L104)
|
|
872
884
|
|
|
873
885
|
**`Internal`**
|
|
874
886
|
|
|
@@ -908,7 +920,7 @@ Handles specific user interactions using underlying technology (Playwright/Cheer
|
|
|
908
920
|
|
|
909
921
|
> **extract**\<`T`\>(`schema`): `Promise`\<`T`\>
|
|
910
922
|
|
|
911
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
923
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:423](https://github.com/isdk/web-fetcher.js/blob/7bb51cb9bc54b4138642b08ddf371740d89af7ca/src/engine/base.ts#L423)
|
|
912
924
|
|
|
913
925
|
Extracts structured data from the current page content.
|
|
914
926
|
|
|
@@ -942,7 +954,7 @@ A promise that resolves to an object with the extracted data.
|
|
|
942
954
|
|
|
943
955
|
> **fill**(`selector`, `value`): `Promise`\<`void`\>
|
|
944
956
|
|
|
945
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
957
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:390](https://github.com/isdk/web-fetcher.js/blob/7bb51cb9bc54b4138642b08ddf371740d89af7ca/src/engine/base.ts#L390)
|
|
946
958
|
|
|
947
959
|
Fills input element with specified value.
|
|
948
960
|
|
|
@@ -980,7 +992,7 @@ When no active page context exists
|
|
|
980
992
|
|
|
981
993
|
> **getContent**(): `Promise`\<[`FetchResponse`](../interfaces/FetchResponse.md)\>
|
|
982
994
|
|
|
983
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
995
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:777](https://github.com/isdk/web-fetcher.js/blob/7bb51cb9bc54b4138642b08ddf371740d89af7ca/src/engine/base.ts#L777)
|
|
984
996
|
|
|
985
997
|
Gets content of current page.
|
|
986
998
|
|
|
@@ -1004,7 +1016,7 @@ When no content has been fetched yet
|
|
|
1004
1016
|
|
|
1005
1017
|
> **getState**(): `Promise`\<\{ `cookies`: [`Cookie`](../interfaces/Cookie.md)[]; `sessionState?`: `any`; \}\>
|
|
1006
1018
|
|
|
1007
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1019
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:480](https://github.com/isdk/web-fetcher.js/blob/7bb51cb9bc54b4138642b08ddf371740d89af7ca/src/engine/base.ts#L480)
|
|
1008
1020
|
|
|
1009
1021
|
Returns the current state of the engine (cookies)
|
|
1010
1022
|
that can be used to restore the session later.
|
|
@@ -1023,7 +1035,7 @@ that can be used to restore the session later.
|
|
|
1023
1035
|
|
|
1024
1036
|
> **goto**(`url`, `params?`): `Promise`\<`void` \| [`FetchResponse`](../interfaces/FetchResponse.md)\>
|
|
1025
1037
|
|
|
1026
|
-
Defined in: [packages/web-fetcher/src/engine/cheerio.ts:
|
|
1038
|
+
Defined in: [packages/web-fetcher/src/engine/cheerio.ts:283](https://github.com/isdk/web-fetcher.js/blob/7bb51cb9bc54b4138642b08ddf371740d89af7ca/src/engine/cheerio.ts#L283)
|
|
1027
1039
|
|
|
1028
1040
|
Navigates to the specified URL.
|
|
1029
1041
|
|
|
@@ -1065,7 +1077,7 @@ await engine.goto('https://example.com');
|
|
|
1065
1077
|
|
|
1066
1078
|
> **headers**(): `Promise`\<`Record`\<`string`, `string`\>\>
|
|
1067
1079
|
|
|
1068
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1080
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:816](https://github.com/isdk/web-fetcher.js/blob/7bb51cb9bc54b4138642b08ddf371740d89af7ca/src/engine/base.ts#L816)
|
|
1069
1081
|
|
|
1070
1082
|
Manages HTTP headers for requests with multiple overloads.
|
|
1071
1083
|
|
|
@@ -1096,7 +1108,7 @@ await engine.headers('auth', 'token');
|
|
|
1096
1108
|
|
|
1097
1109
|
> **headers**(`name`): `Promise`\<`string`\>
|
|
1098
1110
|
|
|
1099
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1111
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:817](https://github.com/isdk/web-fetcher.js/blob/7bb51cb9bc54b4138642b08ddf371740d89af7ca/src/engine/base.ts#L817)
|
|
1100
1112
|
|
|
1101
1113
|
Manages HTTP headers for requests with multiple overloads.
|
|
1102
1114
|
|
|
@@ -1135,7 +1147,7 @@ await engine.headers('auth', 'token');
|
|
|
1135
1147
|
|
|
1136
1148
|
> **headers**(`headers`, `replaced?`): `Promise`\<`boolean`\>
|
|
1137
1149
|
|
|
1138
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1150
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:818](https://github.com/isdk/web-fetcher.js/blob/7bb51cb9bc54b4138642b08ddf371740d89af7ca/src/engine/base.ts#L818)
|
|
1139
1151
|
|
|
1140
1152
|
Manages HTTP headers for requests with multiple overloads.
|
|
1141
1153
|
|
|
@@ -1180,7 +1192,7 @@ await engine.headers('auth', 'token');
|
|
|
1180
1192
|
|
|
1181
1193
|
> **headers**(`name`, `value`): `Promise`\<`boolean`\>
|
|
1182
1194
|
|
|
1183
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1195
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:819](https://github.com/isdk/web-fetcher.js/blob/7bb51cb9bc54b4138642b08ddf371740d89af7ca/src/engine/base.ts#L819)
|
|
1184
1196
|
|
|
1185
1197
|
Manages HTTP headers for requests with multiple overloads.
|
|
1186
1198
|
|
|
@@ -1227,7 +1239,7 @@ await engine.headers('auth', 'token');
|
|
|
1227
1239
|
|
|
1228
1240
|
> **initialize**(`context`, `options?`): `Promise`\<`void`\>
|
|
1229
1241
|
|
|
1230
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1242
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:512](https://github.com/isdk/web-fetcher.js/blob/7bb51cb9bc54b4138642b08ddf371740d89af7ca/src/engine/base.ts#L512)
|
|
1231
1243
|
|
|
1232
1244
|
Initializes the fetch engine with provided context and options.
|
|
1233
1245
|
|
|
@@ -1266,7 +1278,7 @@ Automatically called when creating engine via `FetchEngine.create()`.
|
|
|
1266
1278
|
|
|
1267
1279
|
> **pause**(`message?`): `Promise`\<`void`\>
|
|
1268
1280
|
|
|
1269
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1281
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:413](https://github.com/isdk/web-fetcher.js/blob/7bb51cb9bc54b4138642b08ddf371740d89af7ca/src/engine/base.ts#L413)
|
|
1270
1282
|
|
|
1271
1283
|
Pauses execution, allowing for manual intervention or inspection.
|
|
1272
1284
|
|
|
@@ -1298,7 +1310,7 @@ When no active page context exists
|
|
|
1298
1310
|
|
|
1299
1311
|
> **submit**(`selector?`, `options?`): `Promise`\<`void`\>
|
|
1300
1312
|
|
|
1301
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1313
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:402](https://github.com/isdk/web-fetcher.js/blob/7bb51cb9bc54b4138642b08ddf371740d89af7ca/src/engine/base.ts#L402)
|
|
1302
1314
|
|
|
1303
1315
|
Submits a form.
|
|
1304
1316
|
|
|
@@ -1336,7 +1348,7 @@ When no active page context exists
|
|
|
1336
1348
|
|
|
1337
1349
|
> **waitFor**(`params?`): `Promise`\<`void`\>
|
|
1338
1350
|
|
|
1339
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1351
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:367](https://github.com/isdk/web-fetcher.js/blob/7bb51cb9bc54b4138642b08ddf371740d89af7ca/src/engine/base.ts#L367)
|
|
1340
1352
|
|
|
1341
1353
|
Waits for specified condition before continuing.
|
|
1342
1354
|
|
|
@@ -1371,7 +1383,7 @@ await engine.waitFor({ selector: '#content' }); // Wait for element
|
|
|
1371
1383
|
|
|
1372
1384
|
> `static` **create**(`ctx`, `options?`): `Promise`\<`undefined` \| `AnyFetchEngine`\>
|
|
1373
1385
|
|
|
1374
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:202](https://github.com/isdk/web-fetcher.js/blob/
|
|
1386
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:202](https://github.com/isdk/web-fetcher.js/blob/7bb51cb9bc54b4138642b08ddf371740d89af7ca/src/engine/base.ts#L202)
|
|
1375
1387
|
|
|
1376
1388
|
Factory method to create and initialize a fetch engine instance.
|
|
1377
1389
|
|
|
@@ -1413,7 +1425,7 @@ Primary entry point for engine creation. Selects appropriate implementation base
|
|
|
1413
1425
|
|
|
1414
1426
|
> `static` **get**(`id`): `undefined` \| `AnyFetchEngineCtor`
|
|
1415
1427
|
|
|
1416
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:175](https://github.com/isdk/web-fetcher.js/blob/
|
|
1428
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:175](https://github.com/isdk/web-fetcher.js/blob/7bb51cb9bc54b4138642b08ddf371740d89af7ca/src/engine/base.ts#L175)
|
|
1417
1429
|
|
|
1418
1430
|
Retrieves a fetch engine implementation by its unique ID.
|
|
1419
1431
|
|
|
@@ -1441,7 +1453,7 @@ Engine class if found, otherwise `undefined`
|
|
|
1441
1453
|
|
|
1442
1454
|
> `static` **getByMode**(`mode`): `undefined` \| `AnyFetchEngineCtor`
|
|
1443
1455
|
|
|
1444
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:185](https://github.com/isdk/web-fetcher.js/blob/
|
|
1456
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:185](https://github.com/isdk/web-fetcher.js/blob/7bb51cb9bc54b4138642b08ddf371740d89af7ca/src/engine/base.ts#L185)
|
|
1445
1457
|
|
|
1446
1458
|
Retrieves a fetch engine implementation by execution mode.
|
|
1447
1459
|
|
|
@@ -1469,7 +1481,7 @@ Engine class if found, otherwise `undefined`
|
|
|
1469
1481
|
|
|
1470
1482
|
> `static` **register**(`engineClass`): `void`
|
|
1471
1483
|
|
|
1472
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:162](https://github.com/isdk/web-fetcher.js/blob/
|
|
1484
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:162](https://github.com/isdk/web-fetcher.js/blob/7bb51cb9bc54b4138642b08ddf371740d89af7ca/src/engine/base.ts#L162)
|
|
1473
1485
|
|
|
1474
1486
|
Registers a fetch engine implementation with the global registry.
|
|
1475
1487
|
|