@isdk/web-fetcher 0.2.3 → 0.2.4
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/dist/index.d.mts +1 -0
- package/dist/index.d.ts +1 -0
- package/dist/index.js +1 -1
- package/dist/index.mjs +1 -1
- package/docs/classes/CheerioFetchEngine.md +57 -57
- 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 +57 -57
- 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 +57 -57
- 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 +22 -22
- 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 +32 -32
- package/docs/interfaces/FetchEngineContext.md +27 -27
- 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 +25 -25
- package/docs/interfaces/FetcherOptions.md +24 -24
- 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 +12 -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/docs/variables/FetcherOptionKeys.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/8bd7a48c89b74012f283a5397c5c3b526fdb7b09/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:
|
|
35
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:236](https://github.com/isdk/web-fetcher.js/blob/8bd7a48c89b74012f283a5397c5c3b526fdb7b09/src/engine/base.ts#L236)
|
|
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:
|
|
47
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:240](https://github.com/isdk/web-fetcher.js/blob/8bd7a48c89b74012f283a5397c5c3b526fdb7b09/src/engine/base.ts#L240)
|
|
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:
|
|
59
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:228](https://github.com/isdk/web-fetcher.js/blob/8bd7a48c89b74012f283a5397c5c3b526fdb7b09/src/engine/base.ts#L228)
|
|
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:
|
|
71
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:226](https://github.com/isdk/web-fetcher.js/blob/8bd7a48c89b74012f283a5397c5c3b526fdb7b09/src/engine/base.ts#L226)
|
|
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:
|
|
83
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:232](https://github.com/isdk/web-fetcher.js/blob/8bd7a48c89b74012f283a5397c5c3b526fdb7b09/src/engine/base.ts#L232)
|
|
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:
|
|
95
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:229](https://github.com/isdk/web-fetcher.js/blob/8bd7a48c89b74012f283a5397c5c3b526fdb7b09/src/engine/base.ts#L229)
|
|
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:
|
|
107
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:237](https://github.com/isdk/web-fetcher.js/blob/8bd7a48c89b74012f283a5397c5c3b526fdb7b09/src/engine/base.ts#L237)
|
|
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:
|
|
119
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:233](https://github.com/isdk/web-fetcher.js/blob/8bd7a48c89b74012f283a5397c5c3b526fdb7b09/src/engine/base.ts#L233)
|
|
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:
|
|
131
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:239](https://github.com/isdk/web-fetcher.js/blob/8bd7a48c89b74012f283a5397c5c3b526fdb7b09/src/engine/base.ts#L239)
|
|
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:
|
|
143
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:238](https://github.com/isdk/web-fetcher.js/blob/8bd7a48c89b74012f283a5397c5c3b526fdb7b09/src/engine/base.ts#L238)
|
|
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:
|
|
155
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:227](https://github.com/isdk/web-fetcher.js/blob/8bd7a48c89b74012f283a5397c5c3b526fdb7b09/src/engine/base.ts#L227)
|
|
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:
|
|
167
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:234](https://github.com/isdk/web-fetcher.js/blob/8bd7a48c89b74012f283a5397c5c3b526fdb7b09/src/engine/base.ts#L234)
|
|
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:
|
|
179
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:235](https://github.com/isdk/web-fetcher.js/blob/8bd7a48c89b74012f283a5397c5c3b526fdb7b09/src/engine/base.ts#L235)
|
|
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:
|
|
191
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:230](https://github.com/isdk/web-fetcher.js/blob/8bd7a48c89b74012f283a5397c5c3b526fdb7b09/src/engine/base.ts#L230)
|
|
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/8bd7a48c89b74012f283a5397c5c3b526fdb7b09/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/8bd7a48c89b74012f283a5397c5c3b526fdb7b09/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:
|
|
241
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:481](https://github.com/isdk/web-fetcher.js/blob/8bd7a48c89b74012f283a5397c5c3b526fdb7b09/src/engine/base.ts#L481)
|
|
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:
|
|
261
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:467](https://github.com/isdk/web-fetcher.js/blob/8bd7a48c89b74012f283a5397c5c3b526fdb7b09/src/engine/base.ts#L467)
|
|
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:
|
|
281
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:474](https://github.com/isdk/web-fetcher.js/blob/8bd7a48c89b74012f283a5397c5c3b526fdb7b09/src/engine/base.ts#L474)
|
|
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` **\_buildResponse**(`context`): `Promise`\<[`FetchResponse`](../interfaces/FetchResponse.md)\>
|
|
298
298
|
|
|
299
|
-
Defined in: [packages/web-fetcher/src/engine/cheerio.ts:28](https://github.com/isdk/web-fetcher.js/blob/
|
|
299
|
+
Defined in: [packages/web-fetcher/src/engine/cheerio.ts:28](https://github.com/isdk/web-fetcher.js/blob/8bd7a48c89b74012f283a5397c5c3b526fdb7b09/src/engine/cheerio.ts#L28)
|
|
300
300
|
|
|
301
301
|
**`Internal`**
|
|
302
302
|
|
|
@@ -330,7 +330,7 @@ Converts implementation-specific context (Playwright `page` or Cheerio `$`) to s
|
|
|
330
330
|
|
|
331
331
|
> `protected` `optional` **\_cleanup**(): `Promise`\<`void`\>
|
|
332
332
|
|
|
333
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
333
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:242](https://github.com/isdk/web-fetcher.js/blob/8bd7a48c89b74012f283a5397c5c3b526fdb7b09/src/engine/base.ts#L242)
|
|
334
334
|
|
|
335
335
|
#### Returns
|
|
336
336
|
|
|
@@ -346,7 +346,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:241](https://github.com/isd
|
|
|
346
346
|
|
|
347
347
|
> `protected` **\_commonCleanup**(): `Promise`\<`void`\>
|
|
348
348
|
|
|
349
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
349
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:665](https://github.com/isdk/web-fetcher.js/blob/8bd7a48c89b74012f283a5397c5c3b526fdb7b09/src/engine/base.ts#L665)
|
|
350
350
|
|
|
351
351
|
#### Returns
|
|
352
352
|
|
|
@@ -362,7 +362,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:664](https://github.com/isd
|
|
|
362
362
|
|
|
363
363
|
> `protected` **\_createCrawler**(`options`): `CheerioCrawler`
|
|
364
364
|
|
|
365
|
-
Defined in: [packages/web-fetcher/src/engine/cheerio.ts:246](https://github.com/isdk/web-fetcher.js/blob/
|
|
365
|
+
Defined in: [packages/web-fetcher/src/engine/cheerio.ts:246](https://github.com/isdk/web-fetcher.js/blob/8bd7a48c89b74012f283a5397c5c3b526fdb7b09/src/engine/cheerio.ts#L246)
|
|
366
366
|
|
|
367
367
|
**`Internal`**
|
|
368
368
|
|
|
@@ -390,7 +390,7 @@ The final crawler options.
|
|
|
390
390
|
|
|
391
391
|
> `protected` **\_executePendingActions**(`context`): `Promise`\<`void`\>
|
|
392
392
|
|
|
393
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
393
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:581](https://github.com/isdk/web-fetcher.js/blob/8bd7a48c89b74012f283a5397c5c3b526fdb7b09/src/engine/base.ts#L581)
|
|
394
394
|
|
|
395
395
|
**`Internal`**
|
|
396
396
|
|
|
@@ -443,7 +443,7 @@ If called outside valid page context window (`!this.isPageActive`)
|
|
|
443
443
|
|
|
444
444
|
> `protected` **\_extract**(`schema`, `context`): `Promise`\<`any`\>
|
|
445
445
|
|
|
446
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
446
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:247](https://github.com/isdk/web-fetcher.js/blob/8bd7a48c89b74012f283a5397c5c3b526fdb7b09/src/engine/base.ts#L247)
|
|
447
447
|
|
|
448
448
|
#### Parameters
|
|
449
449
|
|
|
@@ -469,7 +469,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:246](https://github.com/isd
|
|
|
469
469
|
|
|
470
470
|
> `protected` **\_extractValue**(`schema`, `context`): `Promise`\<`any`\>
|
|
471
471
|
|
|
472
|
-
Defined in: [packages/web-fetcher/src/engine/cheerio.ts:63](https://github.com/isdk/web-fetcher.js/blob/
|
|
472
|
+
Defined in: [packages/web-fetcher/src/engine/cheerio.ts:63](https://github.com/isdk/web-fetcher.js/blob/8bd7a48c89b74012f283a5397c5c3b526fdb7b09/src/engine/cheerio.ts#L63)
|
|
473
473
|
|
|
474
474
|
#### Parameters
|
|
475
475
|
|
|
@@ -497,7 +497,7 @@ Defined in: [packages/web-fetcher/src/engine/cheerio.ts:63](https://github.com/i
|
|
|
497
497
|
|
|
498
498
|
> `protected` **\_getSpecificCrawlerOptions**(`ctx`): `CheerioCrawlerOptions`
|
|
499
499
|
|
|
500
|
-
Defined in: [packages/web-fetcher/src/engine/cheerio.ts:250](https://github.com/isdk/web-fetcher.js/blob/
|
|
500
|
+
Defined in: [packages/web-fetcher/src/engine/cheerio.ts:250](https://github.com/isdk/web-fetcher.js/blob/8bd7a48c89b74012f283a5397c5c3b526fdb7b09/src/engine/cheerio.ts#L250)
|
|
501
501
|
|
|
502
502
|
**`Internal`**
|
|
503
503
|
|
|
@@ -525,7 +525,7 @@ The fetch engine context.
|
|
|
525
525
|
|
|
526
526
|
> `protected` **\_normalizeSchema**(`schema`): `ExtractSchema`
|
|
527
527
|
|
|
528
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
528
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:423](https://github.com/isdk/web-fetcher.js/blob/8bd7a48c89b74012f283a5397c5c3b526fdb7b09/src/engine/base.ts#L423)
|
|
529
529
|
|
|
530
530
|
#### Parameters
|
|
531
531
|
|
|
@@ -547,7 +547,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:422](https://github.com/isd
|
|
|
547
547
|
|
|
548
548
|
> `protected` **\_querySelectorAll**(`context`, `selector`): `Promise`\<`any`[]\>
|
|
549
549
|
|
|
550
|
-
Defined in: [packages/web-fetcher/src/engine/cheerio.ts:58](https://github.com/isdk/web-fetcher.js/blob/
|
|
550
|
+
Defined in: [packages/web-fetcher/src/engine/cheerio.ts:58](https://github.com/isdk/web-fetcher.js/blob/8bd7a48c89b74012f283a5397c5c3b526fdb7b09/src/engine/cheerio.ts#L58)
|
|
551
551
|
|
|
552
552
|
#### Parameters
|
|
553
553
|
|
|
@@ -579,7 +579,7 @@ Defined in: [packages/web-fetcher/src/engine/cheerio.ts:58](https://github.com/i
|
|
|
579
579
|
|
|
580
580
|
> `protected` **\_sharedFailedRequestHandler**(`context`, `error?`): `Promise`\<`void`\>
|
|
581
581
|
|
|
582
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
582
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:632](https://github.com/isdk/web-fetcher.js/blob/8bd7a48c89b74012f283a5397c5c3b526fdb7b09/src/engine/base.ts#L632)
|
|
583
583
|
|
|
584
584
|
#### Parameters
|
|
585
585
|
|
|
@@ -605,7 +605,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:631](https://github.com/isd
|
|
|
605
605
|
|
|
606
606
|
> `protected` **\_sharedRequestHandler**(`context`): `Promise`\<`void`\>
|
|
607
607
|
|
|
608
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
608
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:604](https://github.com/isdk/web-fetcher.js/blob/8bd7a48c89b74012f283a5397c5c3b526fdb7b09/src/engine/base.ts#L604)
|
|
609
609
|
|
|
610
610
|
#### Parameters
|
|
611
611
|
|
|
@@ -627,7 +627,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:603](https://github.com/isd
|
|
|
627
627
|
|
|
628
628
|
> **blockResources**(`types`, `overwrite?`): `Promise`\<`number`\>
|
|
629
629
|
|
|
630
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
630
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:709](https://github.com/isdk/web-fetcher.js/blob/8bd7a48c89b74012f283a5397c5c3b526fdb7b09/src/engine/base.ts#L709)
|
|
631
631
|
|
|
632
632
|
Blocks specified resource types from loading.
|
|
633
633
|
|
|
@@ -668,7 +668,7 @@ await engine.blockResources(['script'], true); // Replace existing
|
|
|
668
668
|
|
|
669
669
|
> `protected` **buildResponse**(`context`): `Promise`\<[`FetchResponse`](../interfaces/FetchResponse.md)\>
|
|
670
670
|
|
|
671
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
671
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:316](https://github.com/isdk/web-fetcher.js/blob/8bd7a48c89b74012f283a5397c5c3b526fdb7b09/src/engine/base.ts#L316)
|
|
672
672
|
|
|
673
673
|
#### Parameters
|
|
674
674
|
|
|
@@ -690,7 +690,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:315](https://github.com/isd
|
|
|
690
690
|
|
|
691
691
|
> **cleanup**(): `Promise`\<`void`\>
|
|
692
692
|
|
|
693
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
693
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:545](https://github.com/isdk/web-fetcher.js/blob/8bd7a48c89b74012f283a5397c5c3b526fdb7b09/src/engine/base.ts#L545)
|
|
694
694
|
|
|
695
695
|
#### Returns
|
|
696
696
|
|
|
@@ -706,7 +706,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:544](https://github.com/isd
|
|
|
706
706
|
|
|
707
707
|
> **click**(`selector`): `Promise`\<`void`\>
|
|
708
708
|
|
|
709
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
709
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:373](https://github.com/isdk/web-fetcher.js/blob/8bd7a48c89b74012f283a5397c5c3b526fdb7b09/src/engine/base.ts#L373)
|
|
710
710
|
|
|
711
711
|
Clicks on element matching selector.
|
|
712
712
|
|
|
@@ -740,7 +740,7 @@ When no active page context exists
|
|
|
740
740
|
|
|
741
741
|
> **cookies**(): `Promise`\<[`Cookie`](../interfaces/Cookie.md)[]\>
|
|
742
742
|
|
|
743
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
743
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:820](https://github.com/isdk/web-fetcher.js/blob/8bd7a48c89b74012f283a5397c5c3b526fdb7b09/src/engine/base.ts#L820)
|
|
744
744
|
|
|
745
745
|
Manages cookies for current session with multiple overloads.
|
|
746
746
|
|
|
@@ -769,7 +769,7 @@ await engine.cookies([{ name: 'session', value: '123' }]);
|
|
|
769
769
|
|
|
770
770
|
> **cookies**(`cookies`): `Promise`\<`boolean`\>
|
|
771
771
|
|
|
772
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
772
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:821](https://github.com/isdk/web-fetcher.js/blob/8bd7a48c89b74012f283a5397c5c3b526fdb7b09/src/engine/base.ts#L821)
|
|
773
773
|
|
|
774
774
|
Manages cookies for current session with multiple overloads.
|
|
775
775
|
|
|
@@ -808,7 +808,7 @@ await engine.cookies([{ name: 'session', value: '123' }]);
|
|
|
808
808
|
|
|
809
809
|
> `protected` **dispatchAction**\<`T`\>(`action`): `Promise`\<`T`\>
|
|
810
810
|
|
|
811
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
811
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:648](https://github.com/isdk/web-fetcher.js/blob/8bd7a48c89b74012f283a5397c5c3b526fdb7b09/src/engine/base.ts#L648)
|
|
812
812
|
|
|
813
813
|
#### Type Parameters
|
|
814
814
|
|
|
@@ -836,7 +836,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:647](https://github.com/isd
|
|
|
836
836
|
|
|
837
837
|
> **dispose**(): `Promise`\<`void`\>
|
|
838
838
|
|
|
839
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
839
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:838](https://github.com/isdk/web-fetcher.js/blob/8bd7a48c89b74012f283a5397c5c3b526fdb7b09/src/engine/base.ts#L838)
|
|
840
840
|
|
|
841
841
|
Disposes of engine, cleaning up all resources.
|
|
842
842
|
|
|
@@ -856,7 +856,7 @@ Promise resolving when disposal completes
|
|
|
856
856
|
|
|
857
857
|
> `protected` **executeAction**(`context`, `action`): `Promise`\<`any`\>
|
|
858
858
|
|
|
859
|
-
Defined in: [packages/web-fetcher/src/engine/cheerio.ts:91](https://github.com/isdk/web-fetcher.js/blob/
|
|
859
|
+
Defined in: [packages/web-fetcher/src/engine/cheerio.ts:91](https://github.com/isdk/web-fetcher.js/blob/8bd7a48c89b74012f283a5397c5c3b526fdb7b09/src/engine/cheerio.ts#L91)
|
|
860
860
|
|
|
861
861
|
**`Internal`**
|
|
862
862
|
|
|
@@ -896,7 +896,7 @@ Handles specific user interactions using underlying technology (Playwright/Cheer
|
|
|
896
896
|
|
|
897
897
|
> **extract**\<`T`\>(`schema`): `Promise`\<`T`\>
|
|
898
898
|
|
|
899
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
899
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:418](https://github.com/isdk/web-fetcher.js/blob/8bd7a48c89b74012f283a5397c5c3b526fdb7b09/src/engine/base.ts#L418)
|
|
900
900
|
|
|
901
901
|
Extracts structured data from the current page content.
|
|
902
902
|
|
|
@@ -930,7 +930,7 @@ A promise that resolves to an object with the extracted data.
|
|
|
930
930
|
|
|
931
931
|
> **fill**(`selector`, `value`): `Promise`\<`void`\>
|
|
932
932
|
|
|
933
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
933
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:385](https://github.com/isdk/web-fetcher.js/blob/8bd7a48c89b74012f283a5397c5c3b526fdb7b09/src/engine/base.ts#L385)
|
|
934
934
|
|
|
935
935
|
Fills input element with specified value.
|
|
936
936
|
|
|
@@ -968,7 +968,7 @@ When no active page context exists
|
|
|
968
968
|
|
|
969
969
|
> **getContent**(): `Promise`\<[`FetchResponse`](../interfaces/FetchResponse.md)\>
|
|
970
970
|
|
|
971
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
971
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:723](https://github.com/isdk/web-fetcher.js/blob/8bd7a48c89b74012f283a5397c5c3b526fdb7b09/src/engine/base.ts#L723)
|
|
972
972
|
|
|
973
973
|
Gets content of current page.
|
|
974
974
|
|
|
@@ -992,7 +992,7 @@ When no content has been fetched yet
|
|
|
992
992
|
|
|
993
993
|
> **goto**(`url`, `params?`): `Promise`\<`void` \| [`FetchResponse`](../interfaces/FetchResponse.md)\>
|
|
994
994
|
|
|
995
|
-
Defined in: [packages/web-fetcher/src/engine/cheerio.ts:270](https://github.com/isdk/web-fetcher.js/blob/
|
|
995
|
+
Defined in: [packages/web-fetcher/src/engine/cheerio.ts:270](https://github.com/isdk/web-fetcher.js/blob/8bd7a48c89b74012f283a5397c5c3b526fdb7b09/src/engine/cheerio.ts#L270)
|
|
996
996
|
|
|
997
997
|
Navigates to the specified URL.
|
|
998
998
|
|
|
@@ -1034,7 +1034,7 @@ await engine.goto('https://example.com');
|
|
|
1034
1034
|
|
|
1035
1035
|
> **headers**(): `Promise`\<`Record`\<`string`, `string`\>\>
|
|
1036
1036
|
|
|
1037
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1037
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:762](https://github.com/isdk/web-fetcher.js/blob/8bd7a48c89b74012f283a5397c5c3b526fdb7b09/src/engine/base.ts#L762)
|
|
1038
1038
|
|
|
1039
1039
|
Manages HTTP headers for requests with multiple overloads.
|
|
1040
1040
|
|
|
@@ -1065,7 +1065,7 @@ await engine.headers('auth', 'token');
|
|
|
1065
1065
|
|
|
1066
1066
|
> **headers**(`name`): `Promise`\<`string`\>
|
|
1067
1067
|
|
|
1068
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1068
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:763](https://github.com/isdk/web-fetcher.js/blob/8bd7a48c89b74012f283a5397c5c3b526fdb7b09/src/engine/base.ts#L763)
|
|
1069
1069
|
|
|
1070
1070
|
Manages HTTP headers for requests with multiple overloads.
|
|
1071
1071
|
|
|
@@ -1104,7 +1104,7 @@ await engine.headers('auth', 'token');
|
|
|
1104
1104
|
|
|
1105
1105
|
> **headers**(`headers`, `replaced?`): `Promise`\<`boolean`\>
|
|
1106
1106
|
|
|
1107
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1107
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:764](https://github.com/isdk/web-fetcher.js/blob/8bd7a48c89b74012f283a5397c5c3b526fdb7b09/src/engine/base.ts#L764)
|
|
1108
1108
|
|
|
1109
1109
|
Manages HTTP headers for requests with multiple overloads.
|
|
1110
1110
|
|
|
@@ -1149,7 +1149,7 @@ await engine.headers('auth', 'token');
|
|
|
1149
1149
|
|
|
1150
1150
|
> **headers**(`name`, `value`): `Promise`\<`boolean`\>
|
|
1151
1151
|
|
|
1152
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1152
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:765](https://github.com/isdk/web-fetcher.js/blob/8bd7a48c89b74012f283a5397c5c3b526fdb7b09/src/engine/base.ts#L765)
|
|
1153
1153
|
|
|
1154
1154
|
Manages HTTP headers for requests with multiple overloads.
|
|
1155
1155
|
|
|
@@ -1196,7 +1196,7 @@ await engine.headers('auth', 'token');
|
|
|
1196
1196
|
|
|
1197
1197
|
> **initialize**(`context`, `options?`): `Promise`\<`void`\>
|
|
1198
1198
|
|
|
1199
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1199
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:496](https://github.com/isdk/web-fetcher.js/blob/8bd7a48c89b74012f283a5397c5c3b526fdb7b09/src/engine/base.ts#L496)
|
|
1200
1200
|
|
|
1201
1201
|
Initializes the fetch engine with provided context and options.
|
|
1202
1202
|
|
|
@@ -1235,7 +1235,7 @@ Automatically called when creating engine via `FetchEngine.create()`.
|
|
|
1235
1235
|
|
|
1236
1236
|
> **pause**(`message?`): `Promise`\<`void`\>
|
|
1237
1237
|
|
|
1238
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1238
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:408](https://github.com/isdk/web-fetcher.js/blob/8bd7a48c89b74012f283a5397c5c3b526fdb7b09/src/engine/base.ts#L408)
|
|
1239
1239
|
|
|
1240
1240
|
Pauses execution, allowing for manual intervention or inspection.
|
|
1241
1241
|
|
|
@@ -1267,7 +1267,7 @@ When no active page context exists
|
|
|
1267
1267
|
|
|
1268
1268
|
> **submit**(`selector?`, `options?`): `Promise`\<`void`\>
|
|
1269
1269
|
|
|
1270
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1270
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:397](https://github.com/isdk/web-fetcher.js/blob/8bd7a48c89b74012f283a5397c5c3b526fdb7b09/src/engine/base.ts#L397)
|
|
1271
1271
|
|
|
1272
1272
|
Submits a form.
|
|
1273
1273
|
|
|
@@ -1305,7 +1305,7 @@ When no active page context exists
|
|
|
1305
1305
|
|
|
1306
1306
|
> **waitFor**(`params?`): `Promise`\<`void`\>
|
|
1307
1307
|
|
|
1308
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1308
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:362](https://github.com/isdk/web-fetcher.js/blob/8bd7a48c89b74012f283a5397c5c3b526fdb7b09/src/engine/base.ts#L362)
|
|
1309
1309
|
|
|
1310
1310
|
Waits for specified condition before continuing.
|
|
1311
1311
|
|
|
@@ -1340,7 +1340,7 @@ await engine.waitFor({ selector: '#content' }); // Wait for element
|
|
|
1340
1340
|
|
|
1341
1341
|
> `static` **create**(`ctx`, `options?`): `Promise`\<`undefined` \| `AnyFetchEngine`\>
|
|
1342
1342
|
|
|
1343
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1343
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:199](https://github.com/isdk/web-fetcher.js/blob/8bd7a48c89b74012f283a5397c5c3b526fdb7b09/src/engine/base.ts#L199)
|
|
1344
1344
|
|
|
1345
1345
|
Factory method to create and initialize a fetch engine instance.
|
|
1346
1346
|
|
|
@@ -1382,7 +1382,7 @@ Primary entry point for engine creation. Selects appropriate implementation base
|
|
|
1382
1382
|
|
|
1383
1383
|
> `static` **get**(`id`): `undefined` \| `AnyFetchEngineCtor`
|
|
1384
1384
|
|
|
1385
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1385
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:172](https://github.com/isdk/web-fetcher.js/blob/8bd7a48c89b74012f283a5397c5c3b526fdb7b09/src/engine/base.ts#L172)
|
|
1386
1386
|
|
|
1387
1387
|
Retrieves a fetch engine implementation by its unique ID.
|
|
1388
1388
|
|
|
@@ -1410,7 +1410,7 @@ Engine class if found, otherwise `undefined`
|
|
|
1410
1410
|
|
|
1411
1411
|
> `static` **getByMode**(`mode`): `undefined` \| `AnyFetchEngineCtor`
|
|
1412
1412
|
|
|
1413
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1413
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:182](https://github.com/isdk/web-fetcher.js/blob/8bd7a48c89b74012f283a5397c5c3b526fdb7b09/src/engine/base.ts#L182)
|
|
1414
1414
|
|
|
1415
1415
|
Retrieves a fetch engine implementation by execution mode.
|
|
1416
1416
|
|
|
@@ -1438,7 +1438,7 @@ Engine class if found, otherwise `undefined`
|
|
|
1438
1438
|
|
|
1439
1439
|
> `static` **register**(`engineClass`): `void`
|
|
1440
1440
|
|
|
1441
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1441
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:159](https://github.com/isdk/web-fetcher.js/blob/8bd7a48c89b74012f283a5397c5c3b526fdb7b09/src/engine/base.ts#L159)
|
|
1442
1442
|
|
|
1443
1443
|
Registers a fetch engine implementation with the global registry.
|
|
1444
1444
|
|