@isdk/web-fetcher 0.2.6 → 0.2.7
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.engine.cn.md +28 -0
- package/README.engine.md +28 -0
- package/dist/index.d.mts +9 -3
- package/dist/index.d.ts +9 -3
- package/dist/index.js +1 -1
- package/dist/index.mjs +1 -1
- package/docs/_media/README.engine.md +28 -0
- package/docs/classes/CheerioFetchEngine.md +83 -71
- 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 +75 -67
- package/docs/classes/FetchSession.md +24 -12
- 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 +83 -71
- 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 +38 -22
- 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 +56 -32
- package/docs/interfaces/FetchEngineContext.md +51 -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 +49 -25
- package/docs/interfaces/FetcherOptions.md +48 -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 +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 +1 -1
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Class: PlaywrightFetchEngine
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/web-fetcher/src/engine/playwright.ts:
|
|
9
|
+
Defined in: [packages/web-fetcher/src/engine/playwright.ts:15](https://github.com/isdk/web-fetcher.js/blob/67ac2abdb01356cc0cf363248f4ef8f77c28d78f/src/engine/playwright.ts#L15)
|
|
10
10
|
|
|
11
11
|
## Extends
|
|
12
12
|
|
|
@@ -28,11 +28,23 @@ Defined in: [packages/web-fetcher/src/engine/playwright.ts:16](https://github.co
|
|
|
28
28
|
|
|
29
29
|
## Properties
|
|
30
30
|
|
|
31
|
+
### \_initialCookies?
|
|
32
|
+
|
|
33
|
+
> `protected` `optional` **\_initialCookies**: [`Cookie`](../interfaces/Cookie.md)[]
|
|
34
|
+
|
|
35
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:236](https://github.com/isdk/web-fetcher.js/blob/67ac2abdb01356cc0cf363248f4ef8f77c28d78f/src/engine/base.ts#L236)
|
|
36
|
+
|
|
37
|
+
#### Inherited from
|
|
38
|
+
|
|
39
|
+
[`FetchEngine`](FetchEngine.md).[`_initialCookies`](FetchEngine.md#_initialcookies)
|
|
40
|
+
|
|
41
|
+
***
|
|
42
|
+
|
|
31
43
|
### actionEmitter
|
|
32
44
|
|
|
33
45
|
> `protected` **actionEmitter**: `EventEmitter`
|
|
34
46
|
|
|
35
|
-
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/67ac2abdb01356cc0cf363248f4ef8f77c28d78f/src/engine/base.ts#L240)
|
|
36
48
|
|
|
37
49
|
#### Inherited from
|
|
38
50
|
|
|
@@ -44,7 +56,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:236](https://github.com/isd
|
|
|
44
56
|
|
|
45
57
|
> `protected` **blockedTypes**: `Set`\<`string`\>
|
|
46
58
|
|
|
47
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
59
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:244](https://github.com/isdk/web-fetcher.js/blob/67ac2abdb01356cc0cf363248f4ef8f77c28d78f/src/engine/base.ts#L244)
|
|
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` `optional` **crawler**: `PlaywrightCrawler`
|
|
58
70
|
|
|
59
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
71
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:231](https://github.com/isdk/web-fetcher.js/blob/67ac2abdb01356cc0cf363248f4ef8f77c28d78f/src/engine/base.ts#L231)
|
|
60
72
|
|
|
61
73
|
#### Inherited from
|
|
62
74
|
|
|
@@ -68,7 +80,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:228](https://github.com/isd
|
|
|
68
80
|
|
|
69
81
|
> `protected` `optional` **ctx**: [`FetchEngineContext`](../interfaces/FetchEngineContext.md)
|
|
70
82
|
|
|
71
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
83
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:229](https://github.com/isdk/web-fetcher.js/blob/67ac2abdb01356cc0cf363248f4ef8f77c28d78f/src/engine/base.ts#L229)
|
|
72
84
|
|
|
73
85
|
#### Inherited from
|
|
74
86
|
|
|
@@ -76,11 +88,23 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:226](https://github.com/isd
|
|
|
76
88
|
|
|
77
89
|
***
|
|
78
90
|
|
|
91
|
+
### currentSession?
|
|
92
|
+
|
|
93
|
+
> `protected` `optional` **currentSession**: `Session`
|
|
94
|
+
|
|
95
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:237](https://github.com/isdk/web-fetcher.js/blob/67ac2abdb01356cc0cf363248f4ef8f77c28d78f/src/engine/base.ts#L237)
|
|
96
|
+
|
|
97
|
+
#### Inherited from
|
|
98
|
+
|
|
99
|
+
[`FetchEngine`](FetchEngine.md).[`currentSession`](FetchEngine.md#currentsession)
|
|
100
|
+
|
|
101
|
+
***
|
|
102
|
+
|
|
79
103
|
### hdrs
|
|
80
104
|
|
|
81
105
|
> `protected` **hdrs**: `Record`\<`string`, `string`\> = `{}`
|
|
82
106
|
|
|
83
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
107
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:235](https://github.com/isdk/web-fetcher.js/blob/67ac2abdb01356cc0cf363248f4ef8f77c28d78f/src/engine/base.ts#L235)
|
|
84
108
|
|
|
85
109
|
#### Inherited from
|
|
86
110
|
|
|
@@ -92,7 +116,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:232](https://github.com/isd
|
|
|
92
116
|
|
|
93
117
|
> `protected` `optional` **isCrawlerReady**: `boolean`
|
|
94
118
|
|
|
95
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
119
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:232](https://github.com/isdk/web-fetcher.js/blob/67ac2abdb01356cc0cf363248f4ef8f77c28d78f/src/engine/base.ts#L232)
|
|
96
120
|
|
|
97
121
|
#### Inherited from
|
|
98
122
|
|
|
@@ -104,7 +128,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:229](https://github.com/isd
|
|
|
104
128
|
|
|
105
129
|
> `protected` **isPageActive**: `boolean` = `false`
|
|
106
130
|
|
|
107
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
131
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:241](https://github.com/isdk/web-fetcher.js/blob/67ac2abdb01356cc0cf363248f4ef8f77c28d78f/src/engine/base.ts#L241)
|
|
108
132
|
|
|
109
133
|
#### Inherited from
|
|
110
134
|
|
|
@@ -112,23 +136,11 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:237](https://github.com/isd
|
|
|
112
136
|
|
|
113
137
|
***
|
|
114
138
|
|
|
115
|
-
### jar
|
|
116
|
-
|
|
117
|
-
> `protected` **jar**: [`Cookie`](../interfaces/Cookie.md)[] = `[]`
|
|
118
|
-
|
|
119
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:233](https://github.com/isdk/web-fetcher.js/blob/d7b505cc39fc821039fb79f641e2e590d2fc028d/src/engine/base.ts#L233)
|
|
120
|
-
|
|
121
|
-
#### Inherited from
|
|
122
|
-
|
|
123
|
-
[`FetchEngine`](FetchEngine.md).[`jar`](FetchEngine.md#jar)
|
|
124
|
-
|
|
125
|
-
***
|
|
126
|
-
|
|
127
139
|
### lastResponse?
|
|
128
140
|
|
|
129
141
|
> `protected` `optional` **lastResponse**: [`FetchResponse`](../interfaces/FetchResponse.md)
|
|
130
142
|
|
|
131
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
143
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:243](https://github.com/isdk/web-fetcher.js/blob/67ac2abdb01356cc0cf363248f4ef8f77c28d78f/src/engine/base.ts#L243)
|
|
132
144
|
|
|
133
145
|
#### Inherited from
|
|
134
146
|
|
|
@@ -140,7 +152,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:239](https://github.com/isd
|
|
|
140
152
|
|
|
141
153
|
> `protected` **navigationLock**: `PromiseLock`
|
|
142
154
|
|
|
143
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
155
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:242](https://github.com/isdk/web-fetcher.js/blob/67ac2abdb01356cc0cf363248f4ef8f77c28d78f/src/engine/base.ts#L242)
|
|
144
156
|
|
|
145
157
|
#### Inherited from
|
|
146
158
|
|
|
@@ -152,7 +164,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:238](https://github.com/isd
|
|
|
152
164
|
|
|
153
165
|
> `protected` `optional` **opts**: [`BaseFetcherProperties`](../interfaces/BaseFetcherProperties.md)
|
|
154
166
|
|
|
155
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
167
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:230](https://github.com/isdk/web-fetcher.js/blob/67ac2abdb01356cc0cf363248f4ef8f77c28d78f/src/engine/base.ts#L230)
|
|
156
168
|
|
|
157
169
|
#### Inherited from
|
|
158
170
|
|
|
@@ -164,7 +176,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:227](https://github.com/isd
|
|
|
164
176
|
|
|
165
177
|
> `protected` **pendingRequests**: `Map`\<`string`, [`PendingEngineRequest`](../interfaces/PendingEngineRequest.md)\>
|
|
166
178
|
|
|
167
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
179
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:238](https://github.com/isdk/web-fetcher.js/blob/67ac2abdb01356cc0cf363248f4ef8f77c28d78f/src/engine/base.ts#L238)
|
|
168
180
|
|
|
169
181
|
#### Inherited from
|
|
170
182
|
|
|
@@ -176,7 +188,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:234](https://github.com/isd
|
|
|
176
188
|
|
|
177
189
|
> `protected` **requestCounter**: `number` = `0`
|
|
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/67ac2abdb01356cc0cf363248f4ef8f77c28d78f/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:235](https://github.com/isd
|
|
|
188
200
|
|
|
189
201
|
> `protected` `optional` **requestQueue**: `RequestQueue`
|
|
190
202
|
|
|
191
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
203
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:233](https://github.com/isdk/web-fetcher.js/blob/67ac2abdb01356cc0cf363248f4ef8f77c28d78f/src/engine/base.ts#L233)
|
|
192
204
|
|
|
193
205
|
#### Inherited from
|
|
194
206
|
|
|
@@ -200,7 +212,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:230](https://github.com/isd
|
|
|
200
212
|
|
|
201
213
|
> `readonly` `static` **id**: `"playwright"` = `'playwright'`
|
|
202
214
|
|
|
203
|
-
Defined in: [packages/web-fetcher/src/engine/playwright.ts:
|
|
215
|
+
Defined in: [packages/web-fetcher/src/engine/playwright.ts:20](https://github.com/isdk/web-fetcher.js/blob/67ac2abdb01356cc0cf363248f4ef8f77c28d78f/src/engine/playwright.ts#L20)
|
|
204
216
|
|
|
205
217
|
Unique identifier for the engine implementation.
|
|
206
218
|
|
|
@@ -218,7 +230,7 @@ Must be defined by concrete implementations. Used for registration and lookup in
|
|
|
218
230
|
|
|
219
231
|
> `readonly` `static` **mode**: `"browser"` = `'browser'`
|
|
220
232
|
|
|
221
|
-
Defined in: [packages/web-fetcher/src/engine/playwright.ts:
|
|
233
|
+
Defined in: [packages/web-fetcher/src/engine/playwright.ts:21](https://github.com/isdk/web-fetcher.js/blob/67ac2abdb01356cc0cf363248f4ef8f77c28d78f/src/engine/playwright.ts#L21)
|
|
222
234
|
|
|
223
235
|
Execution mode of the engine (`'http'` or `'browser'`).
|
|
224
236
|
|
|
@@ -238,7 +250,7 @@ Must be defined by concrete implementations. Indicates whether engine operates a
|
|
|
238
250
|
|
|
239
251
|
> **get** **context**(): `undefined` \| [`FetchEngineContext`](../interfaces/FetchEngineContext.md)
|
|
240
252
|
|
|
241
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
253
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:496](https://github.com/isdk/web-fetcher.js/blob/67ac2abdb01356cc0cf363248f4ef8f77c28d78f/src/engine/base.ts#L496)
|
|
242
254
|
|
|
243
255
|
Gets the fetch engine context associated with this instance.
|
|
244
256
|
|
|
@@ -258,7 +270,7 @@ Gets the fetch engine context associated with this instance.
|
|
|
258
270
|
|
|
259
271
|
> **get** **id**(): `string`
|
|
260
272
|
|
|
261
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
273
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:471](https://github.com/isdk/web-fetcher.js/blob/67ac2abdb01356cc0cf363248f4ef8f77c28d78f/src/engine/base.ts#L471)
|
|
262
274
|
|
|
263
275
|
Gets the unique identifier of this engine implementation.
|
|
264
276
|
|
|
@@ -278,7 +290,7 @@ Gets the unique identifier of this engine implementation.
|
|
|
278
290
|
|
|
279
291
|
> **get** **mode**(): [`FetchEngineType`](../type-aliases/FetchEngineType.md)
|
|
280
292
|
|
|
281
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
293
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:489](https://github.com/isdk/web-fetcher.js/blob/67ac2abdb01356cc0cf363248f4ef8f77c28d78f/src/engine/base.ts#L489)
|
|
282
294
|
|
|
283
295
|
Gets the execution mode of this engine (`'http'` or `'browser'`).
|
|
284
296
|
|
|
@@ -296,7 +308,7 @@ Gets the execution mode of this engine (`'http'` or `'browser'`).
|
|
|
296
308
|
|
|
297
309
|
> `protected` **\_buildResponse**(`context`): `Promise`\<[`FetchResponse`](../interfaces/FetchResponse.md)\>
|
|
298
310
|
|
|
299
|
-
Defined in: [packages/web-fetcher/src/engine/playwright.ts:
|
|
311
|
+
Defined in: [packages/web-fetcher/src/engine/playwright.ts:23](https://github.com/isdk/web-fetcher.js/blob/67ac2abdb01356cc0cf363248f4ef8f77c28d78f/src/engine/playwright.ts#L23)
|
|
300
312
|
|
|
301
313
|
**`Internal`**
|
|
302
314
|
|
|
@@ -330,7 +342,7 @@ Converts implementation-specific context (Playwright `page` or Cheerio `$`) to s
|
|
|
330
342
|
|
|
331
343
|
> `protected` `optional` **\_cleanup**(): `Promise`\<`void`\>
|
|
332
344
|
|
|
333
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
345
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:246](https://github.com/isdk/web-fetcher.js/blob/67ac2abdb01356cc0cf363248f4ef8f77c28d78f/src/engine/base.ts#L246)
|
|
334
346
|
|
|
335
347
|
#### Returns
|
|
336
348
|
|
|
@@ -346,7 +358,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:242](https://github.com/isd
|
|
|
346
358
|
|
|
347
359
|
> `protected` **\_commonCleanup**(): `Promise`\<`void`\>
|
|
348
360
|
|
|
349
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
361
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:710](https://github.com/isdk/web-fetcher.js/blob/67ac2abdb01356cc0cf363248f4ef8f77c28d78f/src/engine/base.ts#L710)
|
|
350
362
|
|
|
351
363
|
#### Returns
|
|
352
364
|
|
|
@@ -362,7 +374,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:675](https://github.com/isd
|
|
|
362
374
|
|
|
363
375
|
> `protected` **\_createCrawler**(`options`): `PlaywrightCrawler`
|
|
364
376
|
|
|
365
|
-
Defined in: [packages/web-fetcher/src/engine/playwright.ts:
|
|
377
|
+
Defined in: [packages/web-fetcher/src/engine/playwright.ts:218](https://github.com/isdk/web-fetcher.js/blob/67ac2abdb01356cc0cf363248f4ef8f77c28d78f/src/engine/playwright.ts#L218)
|
|
366
378
|
|
|
367
379
|
**`Internal`**
|
|
368
380
|
|
|
@@ -390,7 +402,7 @@ The final crawler options.
|
|
|
390
402
|
|
|
391
403
|
> `protected` **\_executePendingActions**(`context`): `Promise`\<`void`\>
|
|
392
404
|
|
|
393
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
405
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:625](https://github.com/isdk/web-fetcher.js/blob/67ac2abdb01356cc0cf363248f4ef8f77c28d78f/src/engine/base.ts#L625)
|
|
394
406
|
|
|
395
407
|
**`Internal`**
|
|
396
408
|
|
|
@@ -443,7 +455,7 @@ If called outside valid page context window (`!this.isPageActive`)
|
|
|
443
455
|
|
|
444
456
|
> `protected` **\_extract**(`schema`, `context`): `Promise`\<`any`\>
|
|
445
457
|
|
|
446
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
458
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:251](https://github.com/isdk/web-fetcher.js/blob/67ac2abdb01356cc0cf363248f4ef8f77c28d78f/src/engine/base.ts#L251)
|
|
447
459
|
|
|
448
460
|
#### Parameters
|
|
449
461
|
|
|
@@ -469,7 +481,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:247](https://github.com/isd
|
|
|
469
481
|
|
|
470
482
|
> `protected` **\_extractValue**(`schema`, `context`): `Promise`\<`any`\>
|
|
471
483
|
|
|
472
|
-
Defined in: [packages/web-fetcher/src/engine/playwright.ts:
|
|
484
|
+
Defined in: [packages/web-fetcher/src/engine/playwright.ts:63](https://github.com/isdk/web-fetcher.js/blob/67ac2abdb01356cc0cf363248f4ef8f77c28d78f/src/engine/playwright.ts#L63)
|
|
473
485
|
|
|
474
486
|
#### Parameters
|
|
475
487
|
|
|
@@ -495,7 +507,7 @@ Defined in: [packages/web-fetcher/src/engine/playwright.ts:59](https://github.co
|
|
|
495
507
|
|
|
496
508
|
> `protected` **\_getSpecificCrawlerOptions**(`ctx`): `Promise`\<`Partial`\<`PlaywrightCrawlerOptions`\>\>
|
|
497
509
|
|
|
498
|
-
Defined in: [packages/web-fetcher/src/engine/playwright.ts:
|
|
510
|
+
Defined in: [packages/web-fetcher/src/engine/playwright.ts:222](https://github.com/isdk/web-fetcher.js/blob/67ac2abdb01356cc0cf363248f4ef8f77c28d78f/src/engine/playwright.ts#L222)
|
|
499
511
|
|
|
500
512
|
**`Internal`**
|
|
501
513
|
|
|
@@ -523,7 +535,7 @@ The fetch engine context.
|
|
|
523
535
|
|
|
524
536
|
> `protected` **\_normalizeSchema**(`schema`): `ExtractSchema`
|
|
525
537
|
|
|
526
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
538
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:427](https://github.com/isdk/web-fetcher.js/blob/67ac2abdb01356cc0cf363248f4ef8f77c28d78f/src/engine/base.ts#L427)
|
|
527
539
|
|
|
528
540
|
#### Parameters
|
|
529
541
|
|
|
@@ -545,7 +557,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:423](https://github.com/isd
|
|
|
545
557
|
|
|
546
558
|
> `protected` **\_querySelectorAll**(`context`, `selector`): `Promise`\<`any`[]\>
|
|
547
559
|
|
|
548
|
-
Defined in: [packages/web-fetcher/src/engine/playwright.ts:
|
|
560
|
+
Defined in: [packages/web-fetcher/src/engine/playwright.ts:59](https://github.com/isdk/web-fetcher.js/blob/67ac2abdb01356cc0cf363248f4ef8f77c28d78f/src/engine/playwright.ts#L59)
|
|
549
561
|
|
|
550
562
|
#### Parameters
|
|
551
563
|
|
|
@@ -571,7 +583,7 @@ Defined in: [packages/web-fetcher/src/engine/playwright.ts:55](https://github.co
|
|
|
571
583
|
|
|
572
584
|
> `protected` **\_sharedFailedRequestHandler**(`context`, `error?`): `Promise`\<`void`\>
|
|
573
585
|
|
|
574
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
586
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:677](https://github.com/isdk/web-fetcher.js/blob/67ac2abdb01356cc0cf363248f4ef8f77c28d78f/src/engine/base.ts#L677)
|
|
575
587
|
|
|
576
588
|
#### Parameters
|
|
577
589
|
|
|
@@ -597,7 +609,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:642](https://github.com/isd
|
|
|
597
609
|
|
|
598
610
|
> `protected` **\_sharedRequestHandler**(`context`): `Promise`\<`void`\>
|
|
599
611
|
|
|
600
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
612
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:648](https://github.com/isdk/web-fetcher.js/blob/67ac2abdb01356cc0cf363248f4ef8f77c28d78f/src/engine/base.ts#L648)
|
|
601
613
|
|
|
602
614
|
#### Parameters
|
|
603
615
|
|
|
@@ -619,7 +631,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:614](https://github.com/isd
|
|
|
619
631
|
|
|
620
632
|
> **blockResources**(`types`, `overwrite?`): `Promise`\<`number`\>
|
|
621
633
|
|
|
622
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
634
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:754](https://github.com/isdk/web-fetcher.js/blob/67ac2abdb01356cc0cf363248f4ef8f77c28d78f/src/engine/base.ts#L754)
|
|
623
635
|
|
|
624
636
|
Blocks specified resource types from loading.
|
|
625
637
|
|
|
@@ -660,7 +672,7 @@ await engine.blockResources(['script'], true); // Replace existing
|
|
|
660
672
|
|
|
661
673
|
> `protected` **buildResponse**(`context`): `Promise`\<[`FetchResponse`](../interfaces/FetchResponse.md)\>
|
|
662
674
|
|
|
663
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
675
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:320](https://github.com/isdk/web-fetcher.js/blob/67ac2abdb01356cc0cf363248f4ef8f77c28d78f/src/engine/base.ts#L320)
|
|
664
676
|
|
|
665
677
|
#### Parameters
|
|
666
678
|
|
|
@@ -682,7 +694,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:316](https://github.com/isd
|
|
|
682
694
|
|
|
683
695
|
> **cleanup**(): `Promise`\<`void`\>
|
|
684
696
|
|
|
685
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
697
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:589](https://github.com/isdk/web-fetcher.js/blob/67ac2abdb01356cc0cf363248f4ef8f77c28d78f/src/engine/base.ts#L589)
|
|
686
698
|
|
|
687
699
|
#### Returns
|
|
688
700
|
|
|
@@ -698,7 +710,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:555](https://github.com/isd
|
|
|
698
710
|
|
|
699
711
|
> **click**(`selector`): `Promise`\<`void`\>
|
|
700
712
|
|
|
701
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
713
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:377](https://github.com/isdk/web-fetcher.js/blob/67ac2abdb01356cc0cf363248f4ef8f77c28d78f/src/engine/base.ts#L377)
|
|
702
714
|
|
|
703
715
|
Clicks on element matching selector.
|
|
704
716
|
|
|
@@ -732,7 +744,7 @@ When no active page context exists
|
|
|
732
744
|
|
|
733
745
|
> **cookies**(): `Promise`\<[`Cookie`](../interfaces/Cookie.md)[]\>
|
|
734
746
|
|
|
735
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
747
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:865](https://github.com/isdk/web-fetcher.js/blob/67ac2abdb01356cc0cf363248f4ef8f77c28d78f/src/engine/base.ts#L865)
|
|
736
748
|
|
|
737
749
|
Manages cookies for current session with multiple overloads.
|
|
738
750
|
|
|
@@ -761,7 +773,7 @@ await engine.cookies([{ name: 'session', value: '123' }]);
|
|
|
761
773
|
|
|
762
774
|
> **cookies**(`cookies`): `Promise`\<`boolean`\>
|
|
763
775
|
|
|
764
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
776
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:866](https://github.com/isdk/web-fetcher.js/blob/67ac2abdb01356cc0cf363248f4ef8f77c28d78f/src/engine/base.ts#L866)
|
|
765
777
|
|
|
766
778
|
Manages cookies for current session with multiple overloads.
|
|
767
779
|
|
|
@@ -800,7 +812,7 @@ await engine.cookies([{ name: 'session', value: '123' }]);
|
|
|
800
812
|
|
|
801
813
|
> `protected` **dispatchAction**\<`T`\>(`action`): `Promise`\<`T`\>
|
|
802
814
|
|
|
803
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
815
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:693](https://github.com/isdk/web-fetcher.js/blob/67ac2abdb01356cc0cf363248f4ef8f77c28d78f/src/engine/base.ts#L693)
|
|
804
816
|
|
|
805
817
|
#### Type Parameters
|
|
806
818
|
|
|
@@ -828,7 +840,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:658](https://github.com/isd
|
|
|
828
840
|
|
|
829
841
|
> **dispose**(): `Promise`\<`void`\>
|
|
830
842
|
|
|
831
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
843
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:901](https://github.com/isdk/web-fetcher.js/blob/67ac2abdb01356cc0cf363248f4ef8f77c28d78f/src/engine/base.ts#L901)
|
|
832
844
|
|
|
833
845
|
Disposes of engine, cleaning up all resources.
|
|
834
846
|
|
|
@@ -848,7 +860,7 @@ Promise resolving when disposal completes
|
|
|
848
860
|
|
|
849
861
|
> `protected` **executeAction**(`context`, `action`): `Promise`\<`any`\>
|
|
850
862
|
|
|
851
|
-
Defined in: [packages/web-fetcher/src/engine/playwright.ts:
|
|
863
|
+
Defined in: [packages/web-fetcher/src/engine/playwright.ts:91](https://github.com/isdk/web-fetcher.js/blob/67ac2abdb01356cc0cf363248f4ef8f77c28d78f/src/engine/playwright.ts#L91)
|
|
852
864
|
|
|
853
865
|
**`Internal`**
|
|
854
866
|
|
|
@@ -888,7 +900,7 @@ Handles specific user interactions using underlying technology (Playwright/Cheer
|
|
|
888
900
|
|
|
889
901
|
> **extract**\<`T`\>(`schema`): `Promise`\<`T`\>
|
|
890
902
|
|
|
891
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
903
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:422](https://github.com/isdk/web-fetcher.js/blob/67ac2abdb01356cc0cf363248f4ef8f77c28d78f/src/engine/base.ts#L422)
|
|
892
904
|
|
|
893
905
|
Extracts structured data from the current page content.
|
|
894
906
|
|
|
@@ -922,7 +934,7 @@ A promise that resolves to an object with the extracted data.
|
|
|
922
934
|
|
|
923
935
|
> **fill**(`selector`, `value`): `Promise`\<`void`\>
|
|
924
936
|
|
|
925
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
937
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:389](https://github.com/isdk/web-fetcher.js/blob/67ac2abdb01356cc0cf363248f4ef8f77c28d78f/src/engine/base.ts#L389)
|
|
926
938
|
|
|
927
939
|
Fills input element with specified value.
|
|
928
940
|
|
|
@@ -960,7 +972,7 @@ When no active page context exists
|
|
|
960
972
|
|
|
961
973
|
> **getContent**(): `Promise`\<[`FetchResponse`](../interfaces/FetchResponse.md)\>
|
|
962
974
|
|
|
963
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
975
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:768](https://github.com/isdk/web-fetcher.js/blob/67ac2abdb01356cc0cf363248f4ef8f77c28d78f/src/engine/base.ts#L768)
|
|
964
976
|
|
|
965
977
|
Gets content of current page.
|
|
966
978
|
|
|
@@ -982,16 +994,16 @@ When no content has been fetched yet
|
|
|
982
994
|
|
|
983
995
|
### getState()
|
|
984
996
|
|
|
985
|
-
> **getState**(): `Promise`\<\{ `cookies`: [`Cookie`](../interfaces/Cookie.md)[]; \}\>
|
|
997
|
+
> **getState**(): `Promise`\<\{ `cookies`: [`Cookie`](../interfaces/Cookie.md)[]; `sessionState?`: `any`; \}\>
|
|
986
998
|
|
|
987
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
999
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:479](https://github.com/isdk/web-fetcher.js/blob/67ac2abdb01356cc0cf363248f4ef8f77c28d78f/src/engine/base.ts#L479)
|
|
988
1000
|
|
|
989
1001
|
Returns the current state of the engine (cookies)
|
|
990
1002
|
that can be used to restore the session later.
|
|
991
1003
|
|
|
992
1004
|
#### Returns
|
|
993
1005
|
|
|
994
|
-
`Promise`\<\{ `cookies`: [`Cookie`](../interfaces/Cookie.md)[]; \}\>
|
|
1006
|
+
`Promise`\<\{ `cookies`: [`Cookie`](../interfaces/Cookie.md)[]; `sessionState?`: `any`; \}\>
|
|
995
1007
|
|
|
996
1008
|
#### Inherited from
|
|
997
1009
|
|
|
@@ -1003,7 +1015,7 @@ that can be used to restore the session later.
|
|
|
1003
1015
|
|
|
1004
1016
|
> **goto**(`url`, `opts?`): `Promise`\<[`FetchResponse`](../interfaces/FetchResponse.md)\>
|
|
1005
1017
|
|
|
1006
|
-
Defined in: [packages/web-fetcher/src/engine/playwright.ts:
|
|
1018
|
+
Defined in: [packages/web-fetcher/src/engine/playwright.ts:274](https://github.com/isdk/web-fetcher.js/blob/67ac2abdb01356cc0cf363248f4ef8f77c28d78f/src/engine/playwright.ts#L274)
|
|
1007
1019
|
|
|
1008
1020
|
Navigates to the specified URL.
|
|
1009
1021
|
|
|
@@ -1043,7 +1055,7 @@ await engine.goto('https://example.com');
|
|
|
1043
1055
|
|
|
1044
1056
|
> **headers**(): `Promise`\<`Record`\<`string`, `string`\>\>
|
|
1045
1057
|
|
|
1046
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1058
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:807](https://github.com/isdk/web-fetcher.js/blob/67ac2abdb01356cc0cf363248f4ef8f77c28d78f/src/engine/base.ts#L807)
|
|
1047
1059
|
|
|
1048
1060
|
Manages HTTP headers for requests with multiple overloads.
|
|
1049
1061
|
|
|
@@ -1074,7 +1086,7 @@ await engine.headers('auth', 'token');
|
|
|
1074
1086
|
|
|
1075
1087
|
> **headers**(`name`): `Promise`\<`string`\>
|
|
1076
1088
|
|
|
1077
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1089
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:808](https://github.com/isdk/web-fetcher.js/blob/67ac2abdb01356cc0cf363248f4ef8f77c28d78f/src/engine/base.ts#L808)
|
|
1078
1090
|
|
|
1079
1091
|
Manages HTTP headers for requests with multiple overloads.
|
|
1080
1092
|
|
|
@@ -1113,7 +1125,7 @@ await engine.headers('auth', 'token');
|
|
|
1113
1125
|
|
|
1114
1126
|
> **headers**(`headers`, `replaced?`): `Promise`\<`boolean`\>
|
|
1115
1127
|
|
|
1116
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1128
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:809](https://github.com/isdk/web-fetcher.js/blob/67ac2abdb01356cc0cf363248f4ef8f77c28d78f/src/engine/base.ts#L809)
|
|
1117
1129
|
|
|
1118
1130
|
Manages HTTP headers for requests with multiple overloads.
|
|
1119
1131
|
|
|
@@ -1158,7 +1170,7 @@ await engine.headers('auth', 'token');
|
|
|
1158
1170
|
|
|
1159
1171
|
> **headers**(`name`, `value`): `Promise`\<`boolean`\>
|
|
1160
1172
|
|
|
1161
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1173
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:810](https://github.com/isdk/web-fetcher.js/blob/67ac2abdb01356cc0cf363248f4ef8f77c28d78f/src/engine/base.ts#L810)
|
|
1162
1174
|
|
|
1163
1175
|
Manages HTTP headers for requests with multiple overloads.
|
|
1164
1176
|
|
|
@@ -1205,7 +1217,7 @@ await engine.headers('auth', 'token');
|
|
|
1205
1217
|
|
|
1206
1218
|
> **initialize**(`context`, `options?`): `Promise`\<`void`\>
|
|
1207
1219
|
|
|
1208
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1220
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:511](https://github.com/isdk/web-fetcher.js/blob/67ac2abdb01356cc0cf363248f4ef8f77c28d78f/src/engine/base.ts#L511)
|
|
1209
1221
|
|
|
1210
1222
|
Initializes the fetch engine with provided context and options.
|
|
1211
1223
|
|
|
@@ -1244,7 +1256,7 @@ Automatically called when creating engine via `FetchEngine.create()`.
|
|
|
1244
1256
|
|
|
1245
1257
|
> **pause**(`message?`): `Promise`\<`void`\>
|
|
1246
1258
|
|
|
1247
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1259
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:412](https://github.com/isdk/web-fetcher.js/blob/67ac2abdb01356cc0cf363248f4ef8f77c28d78f/src/engine/base.ts#L412)
|
|
1248
1260
|
|
|
1249
1261
|
Pauses execution, allowing for manual intervention or inspection.
|
|
1250
1262
|
|
|
@@ -1276,7 +1288,7 @@ When no active page context exists
|
|
|
1276
1288
|
|
|
1277
1289
|
> **submit**(`selector?`, `options?`): `Promise`\<`void`\>
|
|
1278
1290
|
|
|
1279
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1291
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:401](https://github.com/isdk/web-fetcher.js/blob/67ac2abdb01356cc0cf363248f4ef8f77c28d78f/src/engine/base.ts#L401)
|
|
1280
1292
|
|
|
1281
1293
|
Submits a form.
|
|
1282
1294
|
|
|
@@ -1314,7 +1326,7 @@ When no active page context exists
|
|
|
1314
1326
|
|
|
1315
1327
|
> **waitFor**(`params?`): `Promise`\<`void`\>
|
|
1316
1328
|
|
|
1317
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1329
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:366](https://github.com/isdk/web-fetcher.js/blob/67ac2abdb01356cc0cf363248f4ef8f77c28d78f/src/engine/base.ts#L366)
|
|
1318
1330
|
|
|
1319
1331
|
Waits for specified condition before continuing.
|
|
1320
1332
|
|
|
@@ -1349,7 +1361,7 @@ await engine.waitFor({ selector: '#content' }); // Wait for element
|
|
|
1349
1361
|
|
|
1350
1362
|
> `static` **create**(`ctx`, `options?`): `Promise`\<`undefined` \| `AnyFetchEngine`\>
|
|
1351
1363
|
|
|
1352
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1364
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:202](https://github.com/isdk/web-fetcher.js/blob/67ac2abdb01356cc0cf363248f4ef8f77c28d78f/src/engine/base.ts#L202)
|
|
1353
1365
|
|
|
1354
1366
|
Factory method to create and initialize a fetch engine instance.
|
|
1355
1367
|
|
|
@@ -1391,7 +1403,7 @@ Primary entry point for engine creation. Selects appropriate implementation base
|
|
|
1391
1403
|
|
|
1392
1404
|
> `static` **get**(`id`): `undefined` \| `AnyFetchEngineCtor`
|
|
1393
1405
|
|
|
1394
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1406
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:175](https://github.com/isdk/web-fetcher.js/blob/67ac2abdb01356cc0cf363248f4ef8f77c28d78f/src/engine/base.ts#L175)
|
|
1395
1407
|
|
|
1396
1408
|
Retrieves a fetch engine implementation by its unique ID.
|
|
1397
1409
|
|
|
@@ -1419,7 +1431,7 @@ Engine class if found, otherwise `undefined`
|
|
|
1419
1431
|
|
|
1420
1432
|
> `static` **getByMode**(`mode`): `undefined` \| `AnyFetchEngineCtor`
|
|
1421
1433
|
|
|
1422
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1434
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:185](https://github.com/isdk/web-fetcher.js/blob/67ac2abdb01356cc0cf363248f4ef8f77c28d78f/src/engine/base.ts#L185)
|
|
1423
1435
|
|
|
1424
1436
|
Retrieves a fetch engine implementation by execution mode.
|
|
1425
1437
|
|
|
@@ -1447,7 +1459,7 @@ Engine class if found, otherwise `undefined`
|
|
|
1447
1459
|
|
|
1448
1460
|
> `static` **register**(`engineClass`): `void`
|
|
1449
1461
|
|
|
1450
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1462
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:162](https://github.com/isdk/web-fetcher.js/blob/67ac2abdb01356cc0cf363248f4ef8f77c28d78f/src/engine/base.ts#L162)
|
|
1451
1463
|
|
|
1452
1464
|
Registers a fetch engine implementation with the global registry.
|
|
1453
1465
|
|