@isdk/web-fetcher 0.3.0 → 0.3.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.action.cn.md +53 -312
- package/README.action.extract.cn.md +263 -0
- package/README.action.extract.md +263 -0
- package/README.action.md +53 -311
- package/README.cn.md +10 -2
- package/README.engine.cn.md +22 -1
- package/README.engine.md +22 -1
- package/README.md +8 -1
- package/dist/index.d.mts +147 -1
- package/dist/index.d.ts +147 -1
- package/dist/index.js +1 -1
- package/dist/index.mjs +1 -1
- package/docs/README.md +8 -1
- package/docs/_media/README.action.md +53 -311
- package/docs/_media/README.cn.md +10 -2
- package/docs/_media/README.engine.md +22 -1
- package/docs/classes/CheerioFetchEngine.md +236 -88
- package/docs/classes/ClickAction.md +23 -23
- package/docs/classes/EvaluateAction.md +23 -23
- package/docs/classes/ExtractAction.md +23 -23
- package/docs/classes/FetchAction.md +27 -23
- package/docs/classes/FetchEngine.md +218 -86
- package/docs/classes/FetchSession.md +13 -13
- package/docs/classes/FillAction.md +23 -23
- package/docs/classes/GetContentAction.md +23 -23
- package/docs/classes/GotoAction.md +23 -23
- package/docs/classes/KeyboardPressAction.md +533 -0
- package/docs/classes/KeyboardTypeAction.md +533 -0
- package/docs/classes/MouseClickAction.md +533 -0
- package/docs/classes/MouseMoveAction.md +533 -0
- package/docs/classes/PauseAction.md +23 -23
- package/docs/classes/PlaywrightFetchEngine.md +337 -87
- package/docs/classes/SubmitAction.md +23 -23
- package/docs/classes/TrimAction.md +23 -23
- package/docs/classes/WaitForAction.md +23 -23
- package/docs/classes/WebFetcher.md +5 -5
- package/docs/enumerations/FetchActionResultStatus.md +4 -4
- package/docs/functions/fetchWeb.md +2 -2
- package/docs/globals.md +8 -0
- package/docs/interfaces/BaseFetchActionProperties.md +12 -12
- package/docs/interfaces/BaseFetchCollectorActionProperties.md +16 -16
- package/docs/interfaces/BaseFetcherProperties.md +31 -27
- package/docs/interfaces/Cookie.md +14 -14
- package/docs/interfaces/DispatchedEngineAction.md +4 -4
- package/docs/interfaces/EvaluateActionOptions.md +3 -3
- package/docs/interfaces/ExtractActionProperties.md +12 -12
- package/docs/interfaces/FetchActionInContext.md +15 -15
- package/docs/interfaces/FetchActionProperties.md +13 -13
- package/docs/interfaces/FetchActionResult.md +6 -6
- package/docs/interfaces/FetchContext.md +41 -37
- package/docs/interfaces/FetchEngineContext.md +36 -32
- package/docs/interfaces/FetchMetadata.md +5 -5
- package/docs/interfaces/FetchResponse.md +14 -14
- package/docs/interfaces/FetchReturnTypeRegistry.md +7 -7
- package/docs/interfaces/FetchSite.md +34 -30
- package/docs/interfaces/FetcherOptions.md +33 -29
- package/docs/interfaces/GotoActionOptions.md +14 -6
- package/docs/interfaces/KeyboardPressParams.md +25 -0
- package/docs/interfaces/KeyboardTypeParams.md +25 -0
- package/docs/interfaces/MouseClickParams.md +49 -0
- package/docs/interfaces/MouseMoveParams.md +41 -0
- package/docs/interfaces/PendingEngineRequest.md +3 -3
- package/docs/interfaces/StorageOptions.md +5 -5
- package/docs/interfaces/SubmitActionOptions.md +2 -2
- package/docs/interfaces/TrimActionOptions.md +3 -3
- package/docs/interfaces/WaitForActionOptions.md +5 -5
- package/docs/type-aliases/BaseFetchActionOptions.md +1 -1
- package/docs/type-aliases/BaseFetchCollectorOptions.md +1 -1
- package/docs/type-aliases/BrowserEngine.md +1 -1
- package/docs/type-aliases/FetchActionCapabilities.md +1 -1
- package/docs/type-aliases/FetchActionCapabilityMode.md +1 -1
- package/docs/type-aliases/FetchActionOptions.md +1 -1
- package/docs/type-aliases/FetchEngineAction.md +2 -2
- package/docs/type-aliases/FetchEngineType.md +1 -1
- package/docs/type-aliases/FetchReturnType.md +1 -1
- package/docs/type-aliases/FetchReturnTypeFor.md +1 -1
- package/docs/type-aliases/OnFetchPauseCallback.md +1 -1
- package/docs/type-aliases/ResourceType.md +1 -1
- package/docs/type-aliases/TrimPreset.md +1 -1
- package/docs/variables/DefaultFetcherProperties.md +1 -1
- package/docs/variables/FetcherOptionKeys.md +1 -1
- package/docs/variables/TRIM_PRESETS.md +1 -1
- package/package.json +10 -10
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Class: PlaywrightFetchEngine
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/web-fetcher/src/engine/playwright.ts:19](https://github.com/isdk/web-fetcher.js/blob/
|
|
9
|
+
Defined in: [packages/web-fetcher/src/engine/playwright.ts:19](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/playwright.ts#L19)
|
|
10
10
|
|
|
11
11
|
## Extends
|
|
12
12
|
|
|
@@ -32,7 +32,7 @@ Defined in: [packages/web-fetcher/src/engine/playwright.ts:19](https://github.co
|
|
|
32
32
|
|
|
33
33
|
> `protected` `optional` **\_initialCookies**: [`Cookie`](../interfaces/Cookie.md)[]
|
|
34
34
|
|
|
35
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
35
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:396](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L396)
|
|
36
36
|
|
|
37
37
|
#### Inherited from
|
|
38
38
|
|
|
@@ -44,7 +44,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:379](https://github.com/isd
|
|
|
44
44
|
|
|
45
45
|
> `protected` **\_initializedSessions**: `Set`\<`string`\>
|
|
46
46
|
|
|
47
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
47
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:397](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L397)
|
|
48
48
|
|
|
49
49
|
#### Inherited from
|
|
50
50
|
|
|
@@ -56,7 +56,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:380](https://github.com/isd
|
|
|
56
56
|
|
|
57
57
|
> `protected` **actionEmitter**: `EventEmitter`
|
|
58
58
|
|
|
59
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
59
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:401](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L401)
|
|
60
60
|
|
|
61
61
|
#### Inherited from
|
|
62
62
|
|
|
@@ -68,7 +68,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:384](https://github.com/isd
|
|
|
68
68
|
|
|
69
69
|
> `protected` **actionQueue**: [`DispatchedEngineAction`](../interfaces/DispatchedEngineAction.md)[] = `[]`
|
|
70
70
|
|
|
71
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
71
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:408](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L408)
|
|
72
72
|
|
|
73
73
|
#### Inherited from
|
|
74
74
|
|
|
@@ -80,7 +80,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:391](https://github.com/isd
|
|
|
80
80
|
|
|
81
81
|
> `protected` `optional` **activeContext**: `PlaywrightCrawlingContext`\<`Dictionary`\>
|
|
82
82
|
|
|
83
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
83
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:405](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L405)
|
|
84
84
|
|
|
85
85
|
#### Inherited from
|
|
86
86
|
|
|
@@ -92,7 +92,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:388](https://github.com/isd
|
|
|
92
92
|
|
|
93
93
|
> `protected` **blockedTypes**: `Set`\<`string`\>
|
|
94
94
|
|
|
95
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
95
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:410](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L410)
|
|
96
96
|
|
|
97
97
|
#### Inherited from
|
|
98
98
|
|
|
@@ -104,7 +104,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:393](https://github.com/isd
|
|
|
104
104
|
|
|
105
105
|
> `protected` `optional` **config**: `Configuration`
|
|
106
106
|
|
|
107
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
107
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:390](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L390)
|
|
108
108
|
|
|
109
109
|
#### Inherited from
|
|
110
110
|
|
|
@@ -116,7 +116,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:373](https://github.com/isd
|
|
|
116
116
|
|
|
117
117
|
> `protected` `optional` **crawler**: `PlaywrightCrawler`
|
|
118
118
|
|
|
119
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
119
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:387](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L387)
|
|
120
120
|
|
|
121
121
|
#### Inherited from
|
|
122
122
|
|
|
@@ -128,7 +128,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:370](https://github.com/isd
|
|
|
128
128
|
|
|
129
129
|
> `protected` `optional` **crawlerRunPromise**: `Promise`\<`FinalStatistics`\>
|
|
130
130
|
|
|
131
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
131
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:389](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L389)
|
|
132
132
|
|
|
133
133
|
#### Inherited from
|
|
134
134
|
|
|
@@ -140,7 +140,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:372](https://github.com/isd
|
|
|
140
140
|
|
|
141
141
|
> `protected` `optional` **ctx**: [`FetchEngineContext`](../interfaces/FetchEngineContext.md)
|
|
142
142
|
|
|
143
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
143
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:385](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L385)
|
|
144
144
|
|
|
145
145
|
#### Inherited from
|
|
146
146
|
|
|
@@ -148,11 +148,27 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:368](https://github.com/isd
|
|
|
148
148
|
|
|
149
149
|
***
|
|
150
150
|
|
|
151
|
+
### currentMousePos
|
|
152
|
+
|
|
153
|
+
> `protected` **currentMousePos**: `object`
|
|
154
|
+
|
|
155
|
+
Defined in: [packages/web-fetcher/src/engine/playwright.ts:427](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/playwright.ts#L427)
|
|
156
|
+
|
|
157
|
+
#### x
|
|
158
|
+
|
|
159
|
+
> **x**: `number` = `0`
|
|
160
|
+
|
|
161
|
+
#### y
|
|
162
|
+
|
|
163
|
+
> **y**: `number` = `0`
|
|
164
|
+
|
|
165
|
+
***
|
|
166
|
+
|
|
151
167
|
### currentSession?
|
|
152
168
|
|
|
153
169
|
> `protected` `optional` **currentSession**: `Session`
|
|
154
170
|
|
|
155
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
171
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:398](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L398)
|
|
156
172
|
|
|
157
173
|
#### Inherited from
|
|
158
174
|
|
|
@@ -164,7 +180,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:381](https://github.com/isd
|
|
|
164
180
|
|
|
165
181
|
> `protected` **hdrs**: `Record`\<`string`, `string`\> = `{}`
|
|
166
182
|
|
|
167
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
183
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:395](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L395)
|
|
168
184
|
|
|
169
185
|
#### Inherited from
|
|
170
186
|
|
|
@@ -176,7 +192,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:378](https://github.com/isd
|
|
|
176
192
|
|
|
177
193
|
> `protected` `optional` **isCrawlerReady**: `boolean`
|
|
178
194
|
|
|
179
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
195
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:388](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L388)
|
|
180
196
|
|
|
181
197
|
#### Inherited from
|
|
182
198
|
|
|
@@ -188,7 +204,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:371](https://github.com/isd
|
|
|
188
204
|
|
|
189
205
|
> `protected` **isEngineDisposed**: `boolean` = `false`
|
|
190
206
|
|
|
191
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
207
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:403](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L403)
|
|
192
208
|
|
|
193
209
|
#### Inherited from
|
|
194
210
|
|
|
@@ -200,7 +216,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:386](https://github.com/isd
|
|
|
200
216
|
|
|
201
217
|
> `protected` **isExecutingAction**: `boolean` = `false`
|
|
202
218
|
|
|
203
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
219
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:406](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L406)
|
|
204
220
|
|
|
205
221
|
#### Inherited from
|
|
206
222
|
|
|
@@ -212,7 +228,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:389](https://github.com/isd
|
|
|
212
228
|
|
|
213
229
|
> `protected` **isPageActive**: `boolean` = `false`
|
|
214
230
|
|
|
215
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
231
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:402](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L402)
|
|
216
232
|
|
|
217
233
|
#### Inherited from
|
|
218
234
|
|
|
@@ -224,7 +240,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:385](https://github.com/isd
|
|
|
224
240
|
|
|
225
241
|
> `protected` **isProcessingActionLoop**: `boolean` = `false`
|
|
226
242
|
|
|
227
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
243
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:409](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L409)
|
|
228
244
|
|
|
229
245
|
#### Inherited from
|
|
230
246
|
|
|
@@ -236,7 +252,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:392](https://github.com/isd
|
|
|
236
252
|
|
|
237
253
|
> `protected` `optional` **kvStore**: `KeyValueStore`
|
|
238
254
|
|
|
239
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
255
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:392](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L392)
|
|
240
256
|
|
|
241
257
|
#### Inherited from
|
|
242
258
|
|
|
@@ -248,7 +264,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:375](https://github.com/isd
|
|
|
248
264
|
|
|
249
265
|
> `protected` `optional` **lastResponse**: [`FetchResponse`](../interfaces/FetchResponse.md)
|
|
250
266
|
|
|
251
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
267
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:407](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L407)
|
|
252
268
|
|
|
253
269
|
#### Inherited from
|
|
254
270
|
|
|
@@ -260,7 +276,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:390](https://github.com/isd
|
|
|
260
276
|
|
|
261
277
|
> `protected` **navigationLock**: `PromiseLock`
|
|
262
278
|
|
|
263
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
279
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:404](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L404)
|
|
264
280
|
|
|
265
281
|
#### Inherited from
|
|
266
282
|
|
|
@@ -272,7 +288,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:387](https://github.com/isd
|
|
|
272
288
|
|
|
273
289
|
> `protected` `optional` **opts**: [`BaseFetcherProperties`](../interfaces/BaseFetcherProperties.md)
|
|
274
290
|
|
|
275
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
291
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:386](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L386)
|
|
276
292
|
|
|
277
293
|
#### Inherited from
|
|
278
294
|
|
|
@@ -284,7 +300,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:369](https://github.com/isd
|
|
|
284
300
|
|
|
285
301
|
> `protected` **pendingRequests**: `Map`\<`string`, [`PendingEngineRequest`](../interfaces/PendingEngineRequest.md)\>
|
|
286
302
|
|
|
287
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
303
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:399](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L399)
|
|
288
304
|
|
|
289
305
|
#### Inherited from
|
|
290
306
|
|
|
@@ -296,7 +312,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:382](https://github.com/isd
|
|
|
296
312
|
|
|
297
313
|
> `protected` `optional` **proxyConfiguration**: `ProxyConfiguration`
|
|
298
314
|
|
|
299
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
315
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:393](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L393)
|
|
300
316
|
|
|
301
317
|
#### Inherited from
|
|
302
318
|
|
|
@@ -308,7 +324,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:376](https://github.com/isd
|
|
|
308
324
|
|
|
309
325
|
> `protected` **requestCounter**: `number` = `0`
|
|
310
326
|
|
|
311
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
327
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:400](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L400)
|
|
312
328
|
|
|
313
329
|
#### Inherited from
|
|
314
330
|
|
|
@@ -320,7 +336,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:383](https://github.com/isd
|
|
|
320
336
|
|
|
321
337
|
> `protected` `optional` **requestQueue**: `RequestQueue`
|
|
322
338
|
|
|
323
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
339
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:391](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L391)
|
|
324
340
|
|
|
325
341
|
#### Inherited from
|
|
326
342
|
|
|
@@ -332,7 +348,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:374](https://github.com/isd
|
|
|
332
348
|
|
|
333
349
|
> `readonly` `static` **id**: `"playwright"` = `'playwright'`
|
|
334
350
|
|
|
335
|
-
Defined in: [packages/web-fetcher/src/engine/playwright.ts:24](https://github.com/isdk/web-fetcher.js/blob/
|
|
351
|
+
Defined in: [packages/web-fetcher/src/engine/playwright.ts:24](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/playwright.ts#L24)
|
|
336
352
|
|
|
337
353
|
Unique identifier for the engine implementation.
|
|
338
354
|
|
|
@@ -350,7 +366,7 @@ Must be defined by concrete implementations. Used for registration and lookup in
|
|
|
350
366
|
|
|
351
367
|
> `readonly` `static` **mode**: `"browser"` = `'browser'`
|
|
352
368
|
|
|
353
|
-
Defined in: [packages/web-fetcher/src/engine/playwright.ts:25](https://github.com/isdk/web-fetcher.js/blob/
|
|
369
|
+
Defined in: [packages/web-fetcher/src/engine/playwright.ts:25](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/playwright.ts#L25)
|
|
354
370
|
|
|
355
371
|
Execution mode of the engine (`'http'` or `'browser'`).
|
|
356
372
|
|
|
@@ -370,7 +386,7 @@ Must be defined by concrete implementations. Indicates whether engine operates a
|
|
|
370
386
|
|
|
371
387
|
> **get** **context**(): [`FetchEngineContext`](../interfaces/FetchEngineContext.md) \| `undefined`
|
|
372
388
|
|
|
373
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
389
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:919](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L919)
|
|
374
390
|
|
|
375
391
|
Gets the fetch engine context associated with this instance.
|
|
376
392
|
|
|
@@ -390,7 +406,7 @@ Gets the fetch engine context associated with this instance.
|
|
|
390
406
|
|
|
391
407
|
> **get** **id**(): `string`
|
|
392
408
|
|
|
393
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
409
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:894](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L894)
|
|
394
410
|
|
|
395
411
|
Gets the unique identifier of this engine implementation.
|
|
396
412
|
|
|
@@ -410,7 +426,7 @@ Gets the unique identifier of this engine implementation.
|
|
|
410
426
|
|
|
411
427
|
> **get** **mode**(): [`FetchEngineType`](../type-aliases/FetchEngineType.md)
|
|
412
428
|
|
|
413
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
429
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:912](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L912)
|
|
414
430
|
|
|
415
431
|
Gets the execution mode of this engine (`'http'` or `'browser'`).
|
|
416
432
|
|
|
@@ -428,7 +444,7 @@ Gets the execution mode of this engine (`'http'` or `'browser'`).
|
|
|
428
444
|
|
|
429
445
|
> `protected` **\_buildResponse**(`context`): `Promise`\<[`FetchResponse`](../interfaces/FetchResponse.md)\>
|
|
430
446
|
|
|
431
|
-
Defined in: [packages/web-fetcher/src/engine/playwright.ts:27](https://github.com/isdk/web-fetcher.js/blob/
|
|
447
|
+
Defined in: [packages/web-fetcher/src/engine/playwright.ts:27](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/playwright.ts#L27)
|
|
432
448
|
|
|
433
449
|
**`Internal`**
|
|
434
450
|
|
|
@@ -462,7 +478,7 @@ Converts implementation-specific context (Playwright `page` or Cheerio `$`) to s
|
|
|
462
478
|
|
|
463
479
|
> `protected` `optional` **\_cleanup**(): `Promise`\<`void`\>
|
|
464
480
|
|
|
465
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
481
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:420](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L420)
|
|
466
482
|
|
|
467
483
|
#### Returns
|
|
468
484
|
|
|
@@ -478,7 +494,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:399](https://github.com/isd
|
|
|
478
494
|
|
|
479
495
|
> `protected` **\_commonCleanup**(): `Promise`\<`void`\>
|
|
480
496
|
|
|
481
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
497
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:1321](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L1321)
|
|
482
498
|
|
|
483
499
|
#### Returns
|
|
484
500
|
|
|
@@ -494,7 +510,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:1237](https://github.com/is
|
|
|
494
510
|
|
|
495
511
|
> **\_contains**(`container`, `element`): `Promise`\<`boolean`\>
|
|
496
512
|
|
|
497
|
-
Defined in: [packages/web-fetcher/src/engine/playwright.ts:199](https://github.com/isdk/web-fetcher.js/blob/
|
|
513
|
+
Defined in: [packages/web-fetcher/src/engine/playwright.ts:199](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/playwright.ts#L199)
|
|
498
514
|
|
|
499
515
|
**`Internal`**
|
|
500
516
|
|
|
@@ -534,7 +550,7 @@ IExtractEngine.\_contains for implementation details.
|
|
|
534
550
|
|
|
535
551
|
> `protected` **\_createCrawler**(`options`, `config?`): `PlaywrightCrawler`
|
|
536
552
|
|
|
537
|
-
Defined in: [packages/web-fetcher/src/engine/playwright.ts:
|
|
553
|
+
Defined in: [packages/web-fetcher/src/engine/playwright.ts:796](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/playwright.ts#L796)
|
|
538
554
|
|
|
539
555
|
**`Internal`**
|
|
540
556
|
|
|
@@ -566,7 +582,7 @@ The final crawler options.
|
|
|
566
582
|
|
|
567
583
|
> `protected` **\_executePendingActions**(`context`): `Promise`\<`void`\>
|
|
568
584
|
|
|
569
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
585
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:1162](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L1162)
|
|
570
586
|
|
|
571
587
|
**`Internal`**
|
|
572
588
|
|
|
@@ -619,7 +635,7 @@ If called outside valid page context window (`!this.isPageActive`)
|
|
|
619
635
|
|
|
620
636
|
> `protected` **\_extract**(`schema`, `scope`, `parentStrict?`): `Promise`\<`any`\>
|
|
621
637
|
|
|
622
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
638
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:563](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L563)
|
|
623
639
|
|
|
624
640
|
#### Parameters
|
|
625
641
|
|
|
@@ -649,7 +665,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:542](https://github.com/isd
|
|
|
649
665
|
|
|
650
666
|
> `protected` **\_extractColumnar**(`schema`, `container`, `opts?`): `Promise`\<`any`[] \| `null`\>
|
|
651
667
|
|
|
652
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
668
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:605](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L605)
|
|
653
669
|
|
|
654
670
|
**`Internal`**
|
|
655
671
|
|
|
@@ -691,7 +707,7 @@ An array of extracted items, or null if requirements aren't met.
|
|
|
691
707
|
|
|
692
708
|
> `protected` **\_extractNested**(`items`, `elements`, `opts?`): `Promise`\<`any`[]\>
|
|
693
709
|
|
|
694
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
710
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:588](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L588)
|
|
695
711
|
|
|
696
712
|
**`Internal`**
|
|
697
713
|
|
|
@@ -731,7 +747,7 @@ The list of item elements.
|
|
|
731
747
|
|
|
732
748
|
> `protected` **\_extractSegmented**(`schema`, `container`, `opts?`): `Promise`\<`any`[] \| `null`\>
|
|
733
749
|
|
|
734
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
750
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:622](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L622)
|
|
735
751
|
|
|
736
752
|
**`Internal`**
|
|
737
753
|
|
|
@@ -773,7 +789,7 @@ An array of extracted items.
|
|
|
773
789
|
|
|
774
790
|
> **\_extractValue**(`schema`, `scope`): `Promise`\<`any`\>
|
|
775
791
|
|
|
776
|
-
Defined in: [packages/web-fetcher/src/engine/playwright.ts:352](https://github.com/isdk/web-fetcher.js/blob/
|
|
792
|
+
Defined in: [packages/web-fetcher/src/engine/playwright.ts:352](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/playwright.ts#L352)
|
|
777
793
|
|
|
778
794
|
**`Internal`**
|
|
779
795
|
|
|
@@ -813,7 +829,7 @@ IExtractEngine.\_extractValue for behavior contract.
|
|
|
813
829
|
|
|
814
830
|
> **\_findClosestAncestor**(`scope`, `candidates`): `Promise`\<`any`\>
|
|
815
831
|
|
|
816
|
-
Defined in: [packages/web-fetcher/src/engine/playwright.ts:163](https://github.com/isdk/web-fetcher.js/blob/
|
|
832
|
+
Defined in: [packages/web-fetcher/src/engine/playwright.ts:163](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/playwright.ts#L163)
|
|
817
833
|
|
|
818
834
|
**`Internal`**
|
|
819
835
|
|
|
@@ -853,7 +869,7 @@ IExtractEngine.\_findClosestAncestor for implementation details.
|
|
|
853
869
|
|
|
854
870
|
> **\_findCommonAncestor**(`scope1`, `scope2`): `Promise`\<`any`\>
|
|
855
871
|
|
|
856
|
-
Defined in: [packages/web-fetcher/src/engine/playwright.ts:211](https://github.com/isdk/web-fetcher.js/blob/
|
|
872
|
+
Defined in: [packages/web-fetcher/src/engine/playwright.ts:211](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/playwright.ts#L211)
|
|
857
873
|
|
|
858
874
|
**`Internal`**
|
|
859
875
|
|
|
@@ -889,7 +905,7 @@ A promise resolving to the LCA element scope, or `null` if none found.
|
|
|
889
905
|
|
|
890
906
|
> **\_findContainerChild**(`element`, `container`): `Promise`\<`any`\>
|
|
891
907
|
|
|
892
|
-
Defined in: [packages/web-fetcher/src/engine/playwright.ts:284](https://github.com/isdk/web-fetcher.js/blob/
|
|
908
|
+
Defined in: [packages/web-fetcher/src/engine/playwright.ts:284](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/playwright.ts#L284)
|
|
893
909
|
|
|
894
910
|
**`Internal`**
|
|
895
911
|
|
|
@@ -925,7 +941,7 @@ The child element of container, or null.
|
|
|
925
941
|
|
|
926
942
|
> `protected` **\_getInitialElementScope**(`context`): `any`
|
|
927
943
|
|
|
928
|
-
Defined in: [packages/web-fetcher/src/engine/playwright.ts:396](https://github.com/isdk/web-fetcher.js/blob/
|
|
944
|
+
Defined in: [packages/web-fetcher/src/engine/playwright.ts:396](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/playwright.ts#L396)
|
|
929
945
|
|
|
930
946
|
**`Internal`**
|
|
931
947
|
|
|
@@ -949,11 +965,33 @@ Crawlee crawling context
|
|
|
949
965
|
|
|
950
966
|
***
|
|
951
967
|
|
|
968
|
+
### \_getRandomDelay()
|
|
969
|
+
|
|
970
|
+
> `protected` **\_getRandomDelay**(`base`, `variance`): `number`
|
|
971
|
+
|
|
972
|
+
Defined in: [packages/web-fetcher/src/engine/playwright.ts:429](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/playwright.ts#L429)
|
|
973
|
+
|
|
974
|
+
#### Parameters
|
|
975
|
+
|
|
976
|
+
##### base
|
|
977
|
+
|
|
978
|
+
`number`
|
|
979
|
+
|
|
980
|
+
##### variance
|
|
981
|
+
|
|
982
|
+
`number` = `0.3`
|
|
983
|
+
|
|
984
|
+
#### Returns
|
|
985
|
+
|
|
986
|
+
`number`
|
|
987
|
+
|
|
988
|
+
***
|
|
989
|
+
|
|
952
990
|
### \_getSpecificCrawlerOptions()
|
|
953
991
|
|
|
954
992
|
> `protected` **\_getSpecificCrawlerOptions**(`ctx`): `Promise`\<`Partial`\<`PlaywrightCrawlerOptions`\>\>
|
|
955
993
|
|
|
956
|
-
Defined in: [packages/web-fetcher/src/engine/playwright.ts:
|
|
994
|
+
Defined in: [packages/web-fetcher/src/engine/playwright.ts:803](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/playwright.ts#L803)
|
|
957
995
|
|
|
958
996
|
**`Internal`**
|
|
959
997
|
|
|
@@ -977,11 +1015,49 @@ The fetch engine context.
|
|
|
977
1015
|
|
|
978
1016
|
***
|
|
979
1017
|
|
|
1018
|
+
### \_getTrajectory()
|
|
1019
|
+
|
|
1020
|
+
> `protected` **\_getTrajectory**(`start`, `end`, `steps`): `object`[]
|
|
1021
|
+
|
|
1022
|
+
Defined in: [packages/web-fetcher/src/engine/playwright.ts:435](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/playwright.ts#L435)
|
|
1023
|
+
|
|
1024
|
+
#### Parameters
|
|
1025
|
+
|
|
1026
|
+
##### start
|
|
1027
|
+
|
|
1028
|
+
###### x
|
|
1029
|
+
|
|
1030
|
+
`number`
|
|
1031
|
+
|
|
1032
|
+
###### y
|
|
1033
|
+
|
|
1034
|
+
`number`
|
|
1035
|
+
|
|
1036
|
+
##### end
|
|
1037
|
+
|
|
1038
|
+
###### x
|
|
1039
|
+
|
|
1040
|
+
`number`
|
|
1041
|
+
|
|
1042
|
+
###### y
|
|
1043
|
+
|
|
1044
|
+
`number`
|
|
1045
|
+
|
|
1046
|
+
##### steps
|
|
1047
|
+
|
|
1048
|
+
`number` = `-1`
|
|
1049
|
+
|
|
1050
|
+
#### Returns
|
|
1051
|
+
|
|
1052
|
+
`object`[]
|
|
1053
|
+
|
|
1054
|
+
***
|
|
1055
|
+
|
|
980
1056
|
### \_getTrimInfo()
|
|
981
1057
|
|
|
982
1058
|
> `protected` **\_getTrimInfo**(`options`): `object`
|
|
983
1059
|
|
|
984
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1060
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:422](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L422)
|
|
985
1061
|
|
|
986
1062
|
#### Parameters
|
|
987
1063
|
|
|
@@ -1015,7 +1091,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:401](https://github.com/isd
|
|
|
1015
1091
|
|
|
1016
1092
|
> `protected` **\_handlePause**(`action`): `Promise`\<`void`\>
|
|
1017
1093
|
|
|
1018
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1094
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:1122](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L1122)
|
|
1019
1095
|
|
|
1020
1096
|
#### Parameters
|
|
1021
1097
|
|
|
@@ -1039,7 +1115,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:1049](https://github.com/is
|
|
|
1039
1115
|
|
|
1040
1116
|
> **\_isSameElement**(`scope1`, `scope2`): `Promise`\<`boolean`\>
|
|
1041
1117
|
|
|
1042
|
-
Defined in: [packages/web-fetcher/src/engine/playwright.ts:150](https://github.com/isdk/web-fetcher.js/blob/
|
|
1118
|
+
Defined in: [packages/web-fetcher/src/engine/playwright.ts:150](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/playwright.ts#L150)
|
|
1043
1119
|
|
|
1044
1120
|
**`Internal`**
|
|
1045
1121
|
|
|
@@ -1075,7 +1151,7 @@ True if they are the same DOM node.
|
|
|
1075
1151
|
|
|
1076
1152
|
> **\_logDebug**(`category`, ...`args`): `void`
|
|
1077
1153
|
|
|
1078
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1154
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:412](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L412)
|
|
1079
1155
|
|
|
1080
1156
|
Logs debug information if debug mode is enabled.
|
|
1081
1157
|
|
|
@@ -1103,11 +1179,37 @@ Arguments to log.
|
|
|
1103
1179
|
|
|
1104
1180
|
***
|
|
1105
1181
|
|
|
1182
|
+
### \_moveToSelector()
|
|
1183
|
+
|
|
1184
|
+
> `protected` **\_moveToSelector**(`context`, `selector`, `steps`): `Promise`\<\{ `x`: `number`; `y`: `number`; \}\>
|
|
1185
|
+
|
|
1186
|
+
Defined in: [packages/web-fetcher/src/engine/playwright.ts:484](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/playwright.ts#L484)
|
|
1187
|
+
|
|
1188
|
+
#### Parameters
|
|
1189
|
+
|
|
1190
|
+
##### context
|
|
1191
|
+
|
|
1192
|
+
`PlaywrightCrawlingContext`
|
|
1193
|
+
|
|
1194
|
+
##### selector
|
|
1195
|
+
|
|
1196
|
+
`string`
|
|
1197
|
+
|
|
1198
|
+
##### steps
|
|
1199
|
+
|
|
1200
|
+
`number` = `-1`
|
|
1201
|
+
|
|
1202
|
+
#### Returns
|
|
1203
|
+
|
|
1204
|
+
`Promise`\<\{ `x`: `number`; `y`: `number`; \}\>
|
|
1205
|
+
|
|
1206
|
+
***
|
|
1207
|
+
|
|
1106
1208
|
### \_nextSiblingsUntil()
|
|
1107
1209
|
|
|
1108
1210
|
> **\_nextSiblingsUntil**(`scope`, `untilSelector?`): `Promise`\<`any`[]\>
|
|
1109
1211
|
|
|
1110
|
-
Defined in: [packages/web-fetcher/src/engine/playwright.ts:127](https://github.com/isdk/web-fetcher.js/blob/
|
|
1212
|
+
Defined in: [packages/web-fetcher/src/engine/playwright.ts:127](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/playwright.ts#L127)
|
|
1111
1213
|
|
|
1112
1214
|
**`Internal`**
|
|
1113
1215
|
|
|
@@ -1144,7 +1246,7 @@ List of sibling elements between anchor and untilSelector.
|
|
|
1144
1246
|
|
|
1145
1247
|
> `protected` **\_normalizeArrayMode**(`mode?`): `any`
|
|
1146
1248
|
|
|
1147
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1249
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:576](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L576)
|
|
1148
1250
|
|
|
1149
1251
|
**`Internal`**
|
|
1150
1252
|
|
|
@@ -1172,7 +1274,7 @@ The mode string or options object.
|
|
|
1172
1274
|
|
|
1173
1275
|
> **\_parentElement**(`scope`): `Promise`\<`any`\>
|
|
1174
1276
|
|
|
1175
|
-
Defined in: [packages/web-fetcher/src/engine/playwright.ts:144](https://github.com/isdk/web-fetcher.js/blob/
|
|
1277
|
+
Defined in: [packages/web-fetcher/src/engine/playwright.ts:144](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/playwright.ts#L144)
|
|
1176
1278
|
|
|
1177
1279
|
**`Internal`**
|
|
1178
1280
|
|
|
@@ -1202,7 +1304,7 @@ Parent element or null.
|
|
|
1202
1304
|
|
|
1203
1305
|
> `protected` **\_processAction**(`context`, `action`): `Promise`\<`any`\>
|
|
1204
1306
|
|
|
1205
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1307
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:1093](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L1093)
|
|
1206
1308
|
|
|
1207
1309
|
**`Internal`**
|
|
1208
1310
|
|
|
@@ -1236,7 +1338,7 @@ Action to execute
|
|
|
1236
1338
|
|
|
1237
1339
|
> **\_querySelectorAll**(`scope`, `selector`): `Promise`\<`any`[]\>
|
|
1238
1340
|
|
|
1239
|
-
Defined in: [packages/web-fetcher/src/engine/playwright.ts:87](https://github.com/isdk/web-fetcher.js/blob/
|
|
1341
|
+
Defined in: [packages/web-fetcher/src/engine/playwright.ts:87](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/playwright.ts#L87)
|
|
1240
1342
|
|
|
1241
1343
|
**`Internal`**
|
|
1242
1344
|
|
|
@@ -1276,7 +1378,7 @@ IExtractEngine.\_querySelectorAll for behavior contract.
|
|
|
1276
1378
|
|
|
1277
1379
|
> `protected` **\_sharedFailedRequestHandler**(`context`, `error?`): `Promise`\<`void`\>
|
|
1278
1380
|
|
|
1279
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1381
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:1269](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L1269)
|
|
1280
1382
|
|
|
1281
1383
|
#### Parameters
|
|
1282
1384
|
|
|
@@ -1302,7 +1404,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:1185](https://github.com/is
|
|
|
1302
1404
|
|
|
1303
1405
|
> `protected` **\_sharedRequestHandler**(`context`): `Promise`\<`void`\>
|
|
1304
1406
|
|
|
1305
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1407
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:1228](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L1228)
|
|
1306
1408
|
|
|
1307
1409
|
#### Parameters
|
|
1308
1410
|
|
|
@@ -1324,7 +1426,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:1144](https://github.com/is
|
|
|
1324
1426
|
|
|
1325
1427
|
> `protected` **\_waitForNavigation**(`context`, `oldUrl`, `actionType`): `Promise`\<`void`\>
|
|
1326
1428
|
|
|
1327
|
-
Defined in: [packages/web-fetcher/src/engine/playwright.ts:404](https://github.com/isdk/web-fetcher.js/blob/
|
|
1429
|
+
Defined in: [packages/web-fetcher/src/engine/playwright.ts:404](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/playwright.ts#L404)
|
|
1328
1430
|
|
|
1329
1431
|
#### Parameters
|
|
1330
1432
|
|
|
@@ -1350,7 +1452,7 @@ Defined in: [packages/web-fetcher/src/engine/playwright.ts:404](https://github.c
|
|
|
1350
1452
|
|
|
1351
1453
|
> **blockResources**(`types`, `overwrite?`): `Promise`\<`number`\>
|
|
1352
1454
|
|
|
1353
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1455
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:1385](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L1385)
|
|
1354
1456
|
|
|
1355
1457
|
Blocks specified resource types from loading.
|
|
1356
1458
|
|
|
@@ -1391,7 +1493,7 @@ await engine.blockResources(['script'], true); // Replace existing
|
|
|
1391
1493
|
|
|
1392
1494
|
> `protected` **buildResponse**(`context`): `Promise`\<[`FetchResponse`](../interfaces/FetchResponse.md)\>
|
|
1393
1495
|
|
|
1394
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1496
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:659](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L659)
|
|
1395
1497
|
|
|
1396
1498
|
#### Parameters
|
|
1397
1499
|
|
|
@@ -1413,7 +1515,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:638](https://github.com/isd
|
|
|
1413
1515
|
|
|
1414
1516
|
> **cleanup**(): `Promise`\<`void`\>
|
|
1415
1517
|
|
|
1416
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1518
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:1065](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L1065)
|
|
1417
1519
|
|
|
1418
1520
|
#### Returns
|
|
1419
1521
|
|
|
@@ -1429,7 +1531,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:992](https://github.com/isd
|
|
|
1429
1531
|
|
|
1430
1532
|
> **click**(`selector`): `Promise`\<`void`\>
|
|
1431
1533
|
|
|
1432
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1534
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:753](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L753)
|
|
1433
1535
|
|
|
1434
1536
|
Clicks on element matching selector.
|
|
1435
1537
|
|
|
@@ -1463,7 +1565,7 @@ When no active page context exists
|
|
|
1463
1565
|
|
|
1464
1566
|
> **cookies**(): `Promise`\<[`Cookie`](../interfaces/Cookie.md)[]\>
|
|
1465
1567
|
|
|
1466
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1568
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:1501](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L1501)
|
|
1467
1569
|
|
|
1468
1570
|
Manages cookies for current session with multiple overloads.
|
|
1469
1571
|
|
|
@@ -1492,7 +1594,7 @@ await engine.cookies([{ name: 'session', value: '123' }]);
|
|
|
1492
1594
|
|
|
1493
1595
|
> **cookies**(`cookies`): `Promise`\<`boolean`\>
|
|
1494
1596
|
|
|
1495
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1597
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:1502](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L1502)
|
|
1496
1598
|
|
|
1497
1599
|
Manages cookies for current session with multiple overloads.
|
|
1498
1600
|
|
|
@@ -1531,7 +1633,7 @@ await engine.cookies([{ name: 'session', value: '123' }]);
|
|
|
1531
1633
|
|
|
1532
1634
|
> `protected` **dispatchAction**\<`T`\>(`action`): `Promise`\<`T`\>
|
|
1533
1635
|
|
|
1534
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1636
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:1292](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L1292)
|
|
1535
1637
|
|
|
1536
1638
|
#### Type Parameters
|
|
1537
1639
|
|
|
@@ -1559,7 +1661,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:1208](https://github.com/is
|
|
|
1559
1661
|
|
|
1560
1662
|
> **dispose**(): `Promise`\<`void`\>
|
|
1561
1663
|
|
|
1562
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1664
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:1537](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L1537)
|
|
1563
1665
|
|
|
1564
1666
|
Disposes of engine, cleaning up all resources.
|
|
1565
1667
|
|
|
@@ -1579,7 +1681,7 @@ Promise resolving when disposal completes
|
|
|
1579
1681
|
|
|
1580
1682
|
> **evaluate**(`params`): `Promise`\<`any`\>
|
|
1581
1683
|
|
|
1582
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1684
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:873](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L873)
|
|
1583
1685
|
|
|
1584
1686
|
Executes a custom function or expression within the current page context.
|
|
1585
1687
|
|
|
@@ -1625,7 +1727,7 @@ If no active page context exists or if execution fails.
|
|
|
1625
1727
|
|
|
1626
1728
|
> `protected` **executeAction**(`context`, `action`): `Promise`\<`any`\>
|
|
1627
1729
|
|
|
1628
|
-
Defined in: [packages/web-fetcher/src/engine/playwright.ts:
|
|
1730
|
+
Defined in: [packages/web-fetcher/src/engine/playwright.ts:520](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/playwright.ts#L520)
|
|
1629
1731
|
|
|
1630
1732
|
**`Internal`**
|
|
1631
1733
|
|
|
@@ -1665,7 +1767,7 @@ Handles specific user interactions using underlying technology (Playwright/Cheer
|
|
|
1665
1767
|
|
|
1666
1768
|
> **extract**\<`T`\>(`schema`): `Promise`\<`T`\>
|
|
1667
1769
|
|
|
1668
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1770
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:883](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L883)
|
|
1669
1771
|
|
|
1670
1772
|
Extracts structured data from the current page content.
|
|
1671
1773
|
|
|
@@ -1699,7 +1801,7 @@ A promise that resolves to an object with the extracted data.
|
|
|
1699
1801
|
|
|
1700
1802
|
> **fill**(`selector`, `value`): `Promise`\<`void`\>
|
|
1701
1803
|
|
|
1702
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1804
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:817](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L817)
|
|
1703
1805
|
|
|
1704
1806
|
Fills input element with specified value.
|
|
1705
1807
|
|
|
@@ -1737,7 +1839,7 @@ When no active page context exists
|
|
|
1737
1839
|
|
|
1738
1840
|
> **getContent**(): `Promise`\<[`FetchResponse`](../interfaces/FetchResponse.md)\>
|
|
1739
1841
|
|
|
1740
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1842
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:1399](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L1399)
|
|
1741
1843
|
|
|
1742
1844
|
Gets content of current page.
|
|
1743
1845
|
|
|
@@ -1761,7 +1863,7 @@ When no content has been fetched yet
|
|
|
1761
1863
|
|
|
1762
1864
|
> **getState**(): `Promise`\<\{ `cookies`: [`Cookie`](../interfaces/Cookie.md)[]; `sessionState?`: `any`; \}\>
|
|
1763
1865
|
|
|
1764
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1866
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:902](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L902)
|
|
1765
1867
|
|
|
1766
1868
|
Returns the current state of the engine (cookies)
|
|
1767
1869
|
that can be used to restore the session later.
|
|
@@ -1780,7 +1882,7 @@ that can be used to restore the session later.
|
|
|
1780
1882
|
|
|
1781
1883
|
> **goto**(`url`, `opts?`): `Promise`\<[`FetchResponse`](../interfaces/FetchResponse.md)\>
|
|
1782
1884
|
|
|
1783
|
-
Defined in: [packages/web-fetcher/src/engine/playwright.ts:
|
|
1885
|
+
Defined in: [packages/web-fetcher/src/engine/playwright.ts:865](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/playwright.ts#L865)
|
|
1784
1886
|
|
|
1785
1887
|
Navigates to the specified URL.
|
|
1786
1888
|
|
|
@@ -1820,7 +1922,7 @@ await engine.goto('https://example.com');
|
|
|
1820
1922
|
|
|
1821
1923
|
> **headers**(): `Promise`\<`Record`\<`string`, `string`\>\>
|
|
1822
1924
|
|
|
1823
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1925
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:1440](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L1440)
|
|
1824
1926
|
|
|
1825
1927
|
Manages HTTP headers for requests with multiple overloads.
|
|
1826
1928
|
|
|
@@ -1851,7 +1953,7 @@ await engine.headers('auth', 'token');
|
|
|
1851
1953
|
|
|
1852
1954
|
> **headers**(`name`): `Promise`\<`string`\>
|
|
1853
1955
|
|
|
1854
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1956
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:1441](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L1441)
|
|
1855
1957
|
|
|
1856
1958
|
Manages HTTP headers for requests with multiple overloads.
|
|
1857
1959
|
|
|
@@ -1890,7 +1992,7 @@ await engine.headers('auth', 'token');
|
|
|
1890
1992
|
|
|
1891
1993
|
> **headers**(`headers`, `replaced?`): `Promise`\<`boolean`\>
|
|
1892
1994
|
|
|
1893
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1995
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:1442](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L1442)
|
|
1894
1996
|
|
|
1895
1997
|
Manages HTTP headers for requests with multiple overloads.
|
|
1896
1998
|
|
|
@@ -1935,7 +2037,7 @@ await engine.headers('auth', 'token');
|
|
|
1935
2037
|
|
|
1936
2038
|
> **headers**(`name`, `value`): `Promise`\<`boolean`\>
|
|
1937
2039
|
|
|
1938
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
2040
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:1446](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L1446)
|
|
1939
2041
|
|
|
1940
2042
|
Manages HTTP headers for requests with multiple overloads.
|
|
1941
2043
|
|
|
@@ -1982,7 +2084,7 @@ await engine.headers('auth', 'token');
|
|
|
1982
2084
|
|
|
1983
2085
|
> **initialize**(`context`, `options?`): `Promise`\<`void`\>
|
|
1984
2086
|
|
|
1985
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
2087
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:934](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L934)
|
|
1986
2088
|
|
|
1987
2089
|
Initializes the fetch engine with provided context and options.
|
|
1988
2090
|
|
|
@@ -2017,11 +2119,159 @@ Automatically called when creating engine via `FetchEngine.create()`.
|
|
|
2017
2119
|
|
|
2018
2120
|
***
|
|
2019
2121
|
|
|
2122
|
+
### keyboardPress()
|
|
2123
|
+
|
|
2124
|
+
> **keyboardPress**(`key`, `delay?`): `Promise`\<`void`\>
|
|
2125
|
+
|
|
2126
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:802](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L802)
|
|
2127
|
+
|
|
2128
|
+
Presses specified key.
|
|
2129
|
+
|
|
2130
|
+
#### Parameters
|
|
2131
|
+
|
|
2132
|
+
##### key
|
|
2133
|
+
|
|
2134
|
+
`string`
|
|
2135
|
+
|
|
2136
|
+
Key to press
|
|
2137
|
+
|
|
2138
|
+
##### delay?
|
|
2139
|
+
|
|
2140
|
+
`number`
|
|
2141
|
+
|
|
2142
|
+
Delay after key press
|
|
2143
|
+
|
|
2144
|
+
#### Returns
|
|
2145
|
+
|
|
2146
|
+
`Promise`\<`void`\>
|
|
2147
|
+
|
|
2148
|
+
#### Inherited from
|
|
2149
|
+
|
|
2150
|
+
[`FetchEngine`](FetchEngine.md).[`keyboardPress`](FetchEngine.md#keyboardpress)
|
|
2151
|
+
|
|
2152
|
+
***
|
|
2153
|
+
|
|
2154
|
+
### keyboardType()
|
|
2155
|
+
|
|
2156
|
+
> **keyboardType**(`text`, `delay?`): `Promise`\<`void`\>
|
|
2157
|
+
|
|
2158
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:792](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L792)
|
|
2159
|
+
|
|
2160
|
+
Types text into current focused element.
|
|
2161
|
+
|
|
2162
|
+
#### Parameters
|
|
2163
|
+
|
|
2164
|
+
##### text
|
|
2165
|
+
|
|
2166
|
+
`string`
|
|
2167
|
+
|
|
2168
|
+
Text to type
|
|
2169
|
+
|
|
2170
|
+
##### delay?
|
|
2171
|
+
|
|
2172
|
+
`number`
|
|
2173
|
+
|
|
2174
|
+
Delay between key presses
|
|
2175
|
+
|
|
2176
|
+
#### Returns
|
|
2177
|
+
|
|
2178
|
+
`Promise`\<`void`\>
|
|
2179
|
+
|
|
2180
|
+
#### Inherited from
|
|
2181
|
+
|
|
2182
|
+
[`FetchEngine`](FetchEngine.md).[`keyboardType`](FetchEngine.md#keyboardtype)
|
|
2183
|
+
|
|
2184
|
+
***
|
|
2185
|
+
|
|
2186
|
+
### mouseClick()
|
|
2187
|
+
|
|
2188
|
+
> **mouseClick**(`params`): `Promise`\<`void`\>
|
|
2189
|
+
|
|
2190
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:776](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L776)
|
|
2191
|
+
|
|
2192
|
+
Clicks at current position or specified position.
|
|
2193
|
+
|
|
2194
|
+
#### Parameters
|
|
2195
|
+
|
|
2196
|
+
##### params
|
|
2197
|
+
|
|
2198
|
+
Click parameters (x, y, button, clickCount, delay)
|
|
2199
|
+
|
|
2200
|
+
###### button?
|
|
2201
|
+
|
|
2202
|
+
`"left"` \| `"right"` \| `"middle"`
|
|
2203
|
+
|
|
2204
|
+
###### clickCount?
|
|
2205
|
+
|
|
2206
|
+
`number`
|
|
2207
|
+
|
|
2208
|
+
###### delay?
|
|
2209
|
+
|
|
2210
|
+
`number`
|
|
2211
|
+
|
|
2212
|
+
###### x?
|
|
2213
|
+
|
|
2214
|
+
`number`
|
|
2215
|
+
|
|
2216
|
+
###### y?
|
|
2217
|
+
|
|
2218
|
+
`number`
|
|
2219
|
+
|
|
2220
|
+
#### Returns
|
|
2221
|
+
|
|
2222
|
+
`Promise`\<`void`\>
|
|
2223
|
+
|
|
2224
|
+
#### Inherited from
|
|
2225
|
+
|
|
2226
|
+
[`FetchEngine`](FetchEngine.md).[`mouseClick`](FetchEngine.md#mouseclick)
|
|
2227
|
+
|
|
2228
|
+
***
|
|
2229
|
+
|
|
2230
|
+
### mouseMove()
|
|
2231
|
+
|
|
2232
|
+
> **mouseMove**(`params`): `Promise`\<`void`\>
|
|
2233
|
+
|
|
2234
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:762](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L762)
|
|
2235
|
+
|
|
2236
|
+
Moves mouse to specified position or element.
|
|
2237
|
+
|
|
2238
|
+
#### Parameters
|
|
2239
|
+
|
|
2240
|
+
##### params
|
|
2241
|
+
|
|
2242
|
+
Move parameters (x, y, selector, steps)
|
|
2243
|
+
|
|
2244
|
+
###### selector?
|
|
2245
|
+
|
|
2246
|
+
`string`
|
|
2247
|
+
|
|
2248
|
+
###### steps?
|
|
2249
|
+
|
|
2250
|
+
`number`
|
|
2251
|
+
|
|
2252
|
+
###### x?
|
|
2253
|
+
|
|
2254
|
+
`number`
|
|
2255
|
+
|
|
2256
|
+
###### y?
|
|
2257
|
+
|
|
2258
|
+
`number`
|
|
2259
|
+
|
|
2260
|
+
#### Returns
|
|
2261
|
+
|
|
2262
|
+
`Promise`\<`void`\>
|
|
2263
|
+
|
|
2264
|
+
#### Inherited from
|
|
2265
|
+
|
|
2266
|
+
[`FetchEngine`](FetchEngine.md).[`mouseMove`](FetchEngine.md#mousemove)
|
|
2267
|
+
|
|
2268
|
+
***
|
|
2269
|
+
|
|
2020
2270
|
### pause()
|
|
2021
2271
|
|
|
2022
2272
|
> **pause**(`message?`): `Promise`\<`void`\>
|
|
2023
2273
|
|
|
2024
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
2274
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:851](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L851)
|
|
2025
2275
|
|
|
2026
2276
|
Pauses execution, allowing for manual intervention or inspection.
|
|
2027
2277
|
|
|
@@ -2053,7 +2303,7 @@ When no active page context exists
|
|
|
2053
2303
|
|
|
2054
2304
|
> **submit**(`selector?`, `options?`): `Promise`\<`void`\>
|
|
2055
2305
|
|
|
2056
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
2306
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:829](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L829)
|
|
2057
2307
|
|
|
2058
2308
|
Submits a form.
|
|
2059
2309
|
|
|
@@ -2091,7 +2341,7 @@ When no active page context exists
|
|
|
2091
2341
|
|
|
2092
2342
|
> **trim**(`options`): `Promise`\<`void`\>
|
|
2093
2343
|
|
|
2094
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
2344
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:840](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L840)
|
|
2095
2345
|
|
|
2096
2346
|
Removes elements from the DOM based on selectors and presets.
|
|
2097
2347
|
|
|
@@ -2123,7 +2373,7 @@ When no active page context exists
|
|
|
2123
2373
|
|
|
2124
2374
|
> **waitFor**(`params?`): `Promise`\<`void`\>
|
|
2125
2375
|
|
|
2126
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
2376
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:742](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L742)
|
|
2127
2377
|
|
|
2128
2378
|
Waits for specified condition before continuing.
|
|
2129
2379
|
|
|
@@ -2158,7 +2408,7 @@ await engine.waitFor({ selector: '#content' }); // Wait for element
|
|
|
2158
2408
|
|
|
2159
2409
|
> `static` **create**(`ctx`, `options?`): `Promise`\<`AnyFetchEngine` \| `undefined`\>
|
|
2160
2410
|
|
|
2161
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
2411
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:349](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L349)
|
|
2162
2412
|
|
|
2163
2413
|
Factory method to create and initialize a fetch engine instance.
|
|
2164
2414
|
|
|
@@ -2200,7 +2450,7 @@ Primary entry point for engine creation. Selects appropriate implementation base
|
|
|
2200
2450
|
|
|
2201
2451
|
> `static` **get**(`id`): `AnyFetchEngineCtor` \| `undefined`
|
|
2202
2452
|
|
|
2203
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
2453
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:322](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L322)
|
|
2204
2454
|
|
|
2205
2455
|
Retrieves a fetch engine implementation by its unique ID.
|
|
2206
2456
|
|
|
@@ -2228,7 +2478,7 @@ Engine class if found, otherwise `undefined`
|
|
|
2228
2478
|
|
|
2229
2479
|
> `static` **getByMode**(`mode`): `AnyFetchEngineCtor` \| `undefined`
|
|
2230
2480
|
|
|
2231
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
2481
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:332](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L332)
|
|
2232
2482
|
|
|
2233
2483
|
Retrieves a fetch engine implementation by execution mode.
|
|
2234
2484
|
|
|
@@ -2256,7 +2506,7 @@ Engine class if found, otherwise `undefined`
|
|
|
2256
2506
|
|
|
2257
2507
|
> `static` **register**(`engineClass`): `void`
|
|
2258
2508
|
|
|
2259
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
2509
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:309](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L309)
|
|
2260
2510
|
|
|
2261
2511
|
Registers a fetch engine implementation with the global registry.
|
|
2262
2512
|
|