@isdk/web-fetcher 0.3.1 → 0.3.3
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 +28 -4
- package/README.action.md +27 -4
- package/README.cn.md +21 -0
- package/README.engine.cn.md +35 -7
- package/README.engine.md +30 -2
- package/README.md +23 -1
- package/dist/index.d.mts +1571 -1448
- package/dist/index.d.ts +1571 -1448
- package/dist/index.js +1 -1
- package/dist/index.mjs +1 -1
- package/docs/README.md +23 -1
- package/docs/_media/README.action.md +27 -4
- package/docs/_media/README.cn.md +21 -0
- package/docs/_media/README.engine.md +30 -2
- package/docs/classes/CheerioFetchEngine.md +169 -93
- package/docs/classes/ClickAction.md +29 -29
- package/docs/classes/EngineUpgradeError.md +335 -0
- package/docs/classes/EvaluateAction.md +29 -29
- package/docs/classes/ExtractAction.md +29 -29
- package/docs/classes/FetchAction.md +31 -29
- package/docs/classes/FetchEngine.md +159 -91
- package/docs/classes/FetchSession.md +14 -14
- package/docs/classes/FillAction.md +29 -29
- package/docs/classes/GetContentAction.md +29 -29
- package/docs/classes/GotoAction.md +29 -29
- package/docs/classes/KeyboardPressAction.md +29 -29
- package/docs/classes/KeyboardTypeAction.md +29 -29
- package/docs/classes/MouseClickAction.md +29 -29
- package/docs/classes/MouseMoveAction.md +29 -29
- package/docs/classes/MouseWheelAction.md +533 -0
- package/docs/classes/PauseAction.md +29 -29
- package/docs/classes/PlaywrightFetchEngine.md +252 -118
- package/docs/classes/ScrollIntoViewAction.md +533 -0
- package/docs/classes/SubmitAction.md +29 -29
- package/docs/classes/TrimAction.md +29 -29
- package/docs/classes/WaitForAction.md +29 -29
- package/docs/classes/WebFetcher.md +5 -5
- package/docs/enumerations/FetchActionResultStatus.md +4 -4
- package/docs/functions/fetchWeb.md +2 -2
- package/docs/functions/getRandomDelay.md +25 -0
- package/docs/globals.md +8 -1
- package/docs/interfaces/BaseFetchActionProperties.md +13 -13
- package/docs/interfaces/BaseFetchCollectorActionProperties.md +17 -17
- package/docs/interfaces/BaseFetcherProperties.md +44 -28
- package/docs/interfaces/DispatchedEngineAction.md +4 -4
- package/docs/interfaces/EvaluateActionOptions.md +3 -3
- package/docs/interfaces/ExtractActionProperties.md +13 -13
- package/docs/interfaces/FetchActionMeta.md +73 -0
- package/docs/interfaces/FetchActionProperties.md +15 -19
- package/docs/interfaces/FetchActionResult.md +7 -7
- package/docs/interfaces/FetchContext.md +65 -41
- package/docs/interfaces/FetchEngineContext.md +57 -33
- 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 +55 -31
- package/docs/interfaces/FetcherOptions.md +55 -31
- package/docs/interfaces/GotoActionOptions.md +8 -8
- package/docs/interfaces/KeyboardPressParams.md +3 -3
- package/docs/interfaces/KeyboardTypeParams.md +3 -3
- package/docs/interfaces/MouseClickParams.md +6 -6
- package/docs/interfaces/MouseMoveParams.md +5 -5
- package/docs/interfaces/MouseWheelParams.md +69 -0
- package/docs/interfaces/PendingEngineRequest.md +3 -3
- package/docs/interfaces/ScrollIntoViewParams.md +17 -0
- 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/FetchActionInContext.md +38 -0
- 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 +7 -7
- package/docs/interfaces/FetchActionInContext.md +0 -190
|
@@ -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/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/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:409](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/engine/base.ts#L409)
|
|
36
36
|
|
|
37
37
|
#### Inherited from
|
|
38
38
|
|
|
@@ -44,7 +44,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:396](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:410](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/engine/base.ts#L410)
|
|
48
48
|
|
|
49
49
|
#### Inherited from
|
|
50
50
|
|
|
@@ -56,7 +56,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:397](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:414](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/engine/base.ts#L414)
|
|
60
60
|
|
|
61
61
|
#### Inherited from
|
|
62
62
|
|
|
@@ -68,7 +68,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:401](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:421](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/engine/base.ts#L421)
|
|
72
72
|
|
|
73
73
|
#### Inherited from
|
|
74
74
|
|
|
@@ -80,7 +80,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:408](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:418](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/engine/base.ts#L418)
|
|
84
84
|
|
|
85
85
|
#### Inherited from
|
|
86
86
|
|
|
@@ -92,7 +92,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:405](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:423](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/engine/base.ts#L423)
|
|
96
96
|
|
|
97
97
|
#### Inherited from
|
|
98
98
|
|
|
@@ -104,7 +104,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:410](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:403](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/engine/base.ts#L403)
|
|
108
108
|
|
|
109
109
|
#### Inherited from
|
|
110
110
|
|
|
@@ -116,7 +116,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:390](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:400](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/engine/base.ts#L400)
|
|
120
120
|
|
|
121
121
|
#### Inherited from
|
|
122
122
|
|
|
@@ -128,7 +128,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:387](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:402](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/engine/base.ts#L402)
|
|
132
132
|
|
|
133
133
|
#### Inherited from
|
|
134
134
|
|
|
@@ -140,7 +140,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:389](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:398](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/engine/base.ts#L398)
|
|
144
144
|
|
|
145
145
|
#### Inherited from
|
|
146
146
|
|
|
@@ -152,7 +152,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:385](https://github.com/isd
|
|
|
152
152
|
|
|
153
153
|
> `protected` **currentMousePos**: `object`
|
|
154
154
|
|
|
155
|
-
Defined in: [packages/web-fetcher/src/engine/playwright.ts:427](https://github.com/isdk/web-fetcher.js/blob/
|
|
155
|
+
Defined in: [packages/web-fetcher/src/engine/playwright.ts:427](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/engine/playwright.ts#L427)
|
|
156
156
|
|
|
157
157
|
#### x
|
|
158
158
|
|
|
@@ -168,7 +168,7 @@ Defined in: [packages/web-fetcher/src/engine/playwright.ts:427](https://github.c
|
|
|
168
168
|
|
|
169
169
|
> `protected` `optional` **currentSession**: `Session`
|
|
170
170
|
|
|
171
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
171
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:411](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/engine/base.ts#L411)
|
|
172
172
|
|
|
173
173
|
#### Inherited from
|
|
174
174
|
|
|
@@ -180,7 +180,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:398](https://github.com/isd
|
|
|
180
180
|
|
|
181
181
|
> `protected` **hdrs**: `Record`\<`string`, `string`\> = `{}`
|
|
182
182
|
|
|
183
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
183
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:408](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/engine/base.ts#L408)
|
|
184
184
|
|
|
185
185
|
#### Inherited from
|
|
186
186
|
|
|
@@ -192,7 +192,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:395](https://github.com/isd
|
|
|
192
192
|
|
|
193
193
|
> `protected` `optional` **isCrawlerReady**: `boolean`
|
|
194
194
|
|
|
195
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
195
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:401](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/engine/base.ts#L401)
|
|
196
196
|
|
|
197
197
|
#### Inherited from
|
|
198
198
|
|
|
@@ -204,7 +204,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:388](https://github.com/isd
|
|
|
204
204
|
|
|
205
205
|
> `protected` **isEngineDisposed**: `boolean` = `false`
|
|
206
206
|
|
|
207
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
207
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:416](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/engine/base.ts#L416)
|
|
208
208
|
|
|
209
209
|
#### Inherited from
|
|
210
210
|
|
|
@@ -216,7 +216,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:403](https://github.com/isd
|
|
|
216
216
|
|
|
217
217
|
> `protected` **isExecutingAction**: `boolean` = `false`
|
|
218
218
|
|
|
219
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
219
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:419](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/engine/base.ts#L419)
|
|
220
220
|
|
|
221
221
|
#### Inherited from
|
|
222
222
|
|
|
@@ -228,7 +228,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:406](https://github.com/isd
|
|
|
228
228
|
|
|
229
229
|
> `protected` **isPageActive**: `boolean` = `false`
|
|
230
230
|
|
|
231
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
231
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:415](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/engine/base.ts#L415)
|
|
232
232
|
|
|
233
233
|
#### Inherited from
|
|
234
234
|
|
|
@@ -240,7 +240,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:402](https://github.com/isd
|
|
|
240
240
|
|
|
241
241
|
> `protected` **isProcessingActionLoop**: `boolean` = `false`
|
|
242
242
|
|
|
243
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
243
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:422](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/engine/base.ts#L422)
|
|
244
244
|
|
|
245
245
|
#### Inherited from
|
|
246
246
|
|
|
@@ -252,7 +252,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:409](https://github.com/isd
|
|
|
252
252
|
|
|
253
253
|
> `protected` `optional` **kvStore**: `KeyValueStore`
|
|
254
254
|
|
|
255
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
255
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:405](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/engine/base.ts#L405)
|
|
256
256
|
|
|
257
257
|
#### Inherited from
|
|
258
258
|
|
|
@@ -264,7 +264,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:392](https://github.com/isd
|
|
|
264
264
|
|
|
265
265
|
> `protected` `optional` **lastResponse**: [`FetchResponse`](../interfaces/FetchResponse.md)
|
|
266
266
|
|
|
267
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
267
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:420](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/engine/base.ts#L420)
|
|
268
268
|
|
|
269
269
|
#### Inherited from
|
|
270
270
|
|
|
@@ -272,11 +272,19 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:407](https://github.com/isd
|
|
|
272
272
|
|
|
273
273
|
***
|
|
274
274
|
|
|
275
|
+
### mouseInitialized
|
|
276
|
+
|
|
277
|
+
> `protected` **mouseInitialized**: `boolean` = `false`
|
|
278
|
+
|
|
279
|
+
Defined in: [packages/web-fetcher/src/engine/playwright.ts:439](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/engine/playwright.ts#L439)
|
|
280
|
+
|
|
281
|
+
***
|
|
282
|
+
|
|
275
283
|
### navigationLock
|
|
276
284
|
|
|
277
285
|
> `protected` **navigationLock**: `PromiseLock`
|
|
278
286
|
|
|
279
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
287
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:417](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/engine/base.ts#L417)
|
|
280
288
|
|
|
281
289
|
#### Inherited from
|
|
282
290
|
|
|
@@ -288,7 +296,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:404](https://github.com/isd
|
|
|
288
296
|
|
|
289
297
|
> `protected` `optional` **opts**: [`BaseFetcherProperties`](../interfaces/BaseFetcherProperties.md)
|
|
290
298
|
|
|
291
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
299
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:399](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/engine/base.ts#L399)
|
|
292
300
|
|
|
293
301
|
#### Inherited from
|
|
294
302
|
|
|
@@ -300,7 +308,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:386](https://github.com/isd
|
|
|
300
308
|
|
|
301
309
|
> `protected` **pendingRequests**: `Map`\<`string`, [`PendingEngineRequest`](../interfaces/PendingEngineRequest.md)\>
|
|
302
310
|
|
|
303
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
311
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:412](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/engine/base.ts#L412)
|
|
304
312
|
|
|
305
313
|
#### Inherited from
|
|
306
314
|
|
|
@@ -312,7 +320,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:399](https://github.com/isd
|
|
|
312
320
|
|
|
313
321
|
> `protected` `optional` **proxyConfiguration**: `ProxyConfiguration`
|
|
314
322
|
|
|
315
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
323
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:406](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/engine/base.ts#L406)
|
|
316
324
|
|
|
317
325
|
#### Inherited from
|
|
318
326
|
|
|
@@ -324,7 +332,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:393](https://github.com/isd
|
|
|
324
332
|
|
|
325
333
|
> `protected` **requestCounter**: `number` = `0`
|
|
326
334
|
|
|
327
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
335
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:413](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/engine/base.ts#L413)
|
|
328
336
|
|
|
329
337
|
#### Inherited from
|
|
330
338
|
|
|
@@ -336,7 +344,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:400](https://github.com/isd
|
|
|
336
344
|
|
|
337
345
|
> `protected` `optional` **requestQueue**: `RequestQueue`
|
|
338
346
|
|
|
339
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
347
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:404](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/engine/base.ts#L404)
|
|
340
348
|
|
|
341
349
|
#### Inherited from
|
|
342
350
|
|
|
@@ -348,7 +356,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:391](https://github.com/isd
|
|
|
348
356
|
|
|
349
357
|
> `readonly` `static` **id**: `"playwright"` = `'playwright'`
|
|
350
358
|
|
|
351
|
-
Defined in: [packages/web-fetcher/src/engine/playwright.ts:24](https://github.com/isdk/web-fetcher.js/blob/
|
|
359
|
+
Defined in: [packages/web-fetcher/src/engine/playwright.ts:24](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/engine/playwright.ts#L24)
|
|
352
360
|
|
|
353
361
|
Unique identifier for the engine implementation.
|
|
354
362
|
|
|
@@ -366,7 +374,7 @@ Must be defined by concrete implementations. Used for registration and lookup in
|
|
|
366
374
|
|
|
367
375
|
> `readonly` `static` **mode**: `"browser"` = `'browser'`
|
|
368
376
|
|
|
369
|
-
Defined in: [packages/web-fetcher/src/engine/playwright.ts:25](https://github.com/isdk/web-fetcher.js/blob/
|
|
377
|
+
Defined in: [packages/web-fetcher/src/engine/playwright.ts:25](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/engine/playwright.ts#L25)
|
|
370
378
|
|
|
371
379
|
Execution mode of the engine (`'http'` or `'browser'`).
|
|
372
380
|
|
|
@@ -386,7 +394,7 @@ Must be defined by concrete implementations. Indicates whether engine operates a
|
|
|
386
394
|
|
|
387
395
|
> **get** **context**(): [`FetchEngineContext`](../interfaces/FetchEngineContext.md) \| `undefined`
|
|
388
396
|
|
|
389
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
397
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:963](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/engine/base.ts#L963)
|
|
390
398
|
|
|
391
399
|
Gets the fetch engine context associated with this instance.
|
|
392
400
|
|
|
@@ -406,7 +414,7 @@ Gets the fetch engine context associated with this instance.
|
|
|
406
414
|
|
|
407
415
|
> **get** **id**(): `string`
|
|
408
416
|
|
|
409
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
417
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:938](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/engine/base.ts#L938)
|
|
410
418
|
|
|
411
419
|
Gets the unique identifier of this engine implementation.
|
|
412
420
|
|
|
@@ -426,7 +434,7 @@ Gets the unique identifier of this engine implementation.
|
|
|
426
434
|
|
|
427
435
|
> **get** **mode**(): [`FetchEngineType`](../type-aliases/FetchEngineType.md)
|
|
428
436
|
|
|
429
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
437
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:956](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/engine/base.ts#L956)
|
|
430
438
|
|
|
431
439
|
Gets the execution mode of this engine (`'http'` or `'browser'`).
|
|
432
440
|
|
|
@@ -444,7 +452,7 @@ Gets the execution mode of this engine (`'http'` or `'browser'`).
|
|
|
444
452
|
|
|
445
453
|
> `protected` **\_buildResponse**(`context`): `Promise`\<[`FetchResponse`](../interfaces/FetchResponse.md)\>
|
|
446
454
|
|
|
447
|
-
Defined in: [packages/web-fetcher/src/engine/playwright.ts:27](https://github.com/isdk/web-fetcher.js/blob/
|
|
455
|
+
Defined in: [packages/web-fetcher/src/engine/playwright.ts:27](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/engine/playwright.ts#L27)
|
|
448
456
|
|
|
449
457
|
**`Internal`**
|
|
450
458
|
|
|
@@ -478,7 +486,7 @@ Converts implementation-specific context (Playwright `page` or Cheerio `$`) to s
|
|
|
478
486
|
|
|
479
487
|
> `protected` `optional` **\_cleanup**(): `Promise`\<`void`\>
|
|
480
488
|
|
|
481
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
489
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:433](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/engine/base.ts#L433)
|
|
482
490
|
|
|
483
491
|
#### Returns
|
|
484
492
|
|
|
@@ -494,7 +502,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:420](https://github.com/isd
|
|
|
494
502
|
|
|
495
503
|
> `protected` **\_commonCleanup**(): `Promise`\<`void`\>
|
|
496
504
|
|
|
497
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
505
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:1395](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/engine/base.ts#L1395)
|
|
498
506
|
|
|
499
507
|
#### Returns
|
|
500
508
|
|
|
@@ -510,7 +518,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:1321](https://github.com/is
|
|
|
510
518
|
|
|
511
519
|
> **\_contains**(`container`, `element`): `Promise`\<`boolean`\>
|
|
512
520
|
|
|
513
|
-
Defined in: [packages/web-fetcher/src/engine/playwright.ts:199](https://github.com/isdk/web-fetcher.js/blob/
|
|
521
|
+
Defined in: [packages/web-fetcher/src/engine/playwright.ts:199](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/engine/playwright.ts#L199)
|
|
514
522
|
|
|
515
523
|
**`Internal`**
|
|
516
524
|
|
|
@@ -550,7 +558,7 @@ IExtractEngine.\_contains for implementation details.
|
|
|
550
558
|
|
|
551
559
|
> `protected` **\_createCrawler**(`options`, `config?`): `PlaywrightCrawler`
|
|
552
560
|
|
|
553
|
-
Defined in: [packages/web-fetcher/src/engine/playwright.ts:
|
|
561
|
+
Defined in: [packages/web-fetcher/src/engine/playwright.ts:879](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/engine/playwright.ts#L879)
|
|
554
562
|
|
|
555
563
|
**`Internal`**
|
|
556
564
|
|
|
@@ -578,11 +586,33 @@ The final crawler options.
|
|
|
578
586
|
|
|
579
587
|
***
|
|
580
588
|
|
|
589
|
+
### \_ensureVisible()
|
|
590
|
+
|
|
591
|
+
> `protected` **\_ensureVisible**(`context`, `selector`): `Promise`\<\{ `x`: `number`; `y`: `number`; \}\>
|
|
592
|
+
|
|
593
|
+
Defined in: [packages/web-fetcher/src/engine/playwright.ts:556](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/engine/playwright.ts#L556)
|
|
594
|
+
|
|
595
|
+
#### Parameters
|
|
596
|
+
|
|
597
|
+
##### context
|
|
598
|
+
|
|
599
|
+
`PlaywrightCrawlingContext`
|
|
600
|
+
|
|
601
|
+
##### selector
|
|
602
|
+
|
|
603
|
+
`string`
|
|
604
|
+
|
|
605
|
+
#### Returns
|
|
606
|
+
|
|
607
|
+
`Promise`\<\{ `x`: `number`; `y`: `number`; \}\>
|
|
608
|
+
|
|
609
|
+
***
|
|
610
|
+
|
|
581
611
|
### \_executePendingActions()
|
|
582
612
|
|
|
583
613
|
> `protected` **\_executePendingActions**(`context`): `Promise`\<`void`\>
|
|
584
614
|
|
|
585
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
615
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:1206](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/engine/base.ts#L1206)
|
|
586
616
|
|
|
587
617
|
**`Internal`**
|
|
588
618
|
|
|
@@ -635,7 +665,7 @@ If called outside valid page context window (`!this.isPageActive`)
|
|
|
635
665
|
|
|
636
666
|
> `protected` **\_extract**(`schema`, `scope`, `parentStrict?`): `Promise`\<`any`\>
|
|
637
667
|
|
|
638
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
668
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:576](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/engine/base.ts#L576)
|
|
639
669
|
|
|
640
670
|
#### Parameters
|
|
641
671
|
|
|
@@ -665,7 +695,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:563](https://github.com/isd
|
|
|
665
695
|
|
|
666
696
|
> `protected` **\_extractColumnar**(`schema`, `container`, `opts?`): `Promise`\<`any`[] \| `null`\>
|
|
667
697
|
|
|
668
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
698
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:618](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/engine/base.ts#L618)
|
|
669
699
|
|
|
670
700
|
**`Internal`**
|
|
671
701
|
|
|
@@ -707,7 +737,7 @@ An array of extracted items, or null if requirements aren't met.
|
|
|
707
737
|
|
|
708
738
|
> `protected` **\_extractNested**(`items`, `elements`, `opts?`): `Promise`\<`any`[]\>
|
|
709
739
|
|
|
710
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
740
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:601](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/engine/base.ts#L601)
|
|
711
741
|
|
|
712
742
|
**`Internal`**
|
|
713
743
|
|
|
@@ -747,7 +777,7 @@ The list of item elements.
|
|
|
747
777
|
|
|
748
778
|
> `protected` **\_extractSegmented**(`schema`, `container`, `opts?`): `Promise`\<`any`[] \| `null`\>
|
|
749
779
|
|
|
750
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
780
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:635](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/engine/base.ts#L635)
|
|
751
781
|
|
|
752
782
|
**`Internal`**
|
|
753
783
|
|
|
@@ -789,7 +819,7 @@ An array of extracted items.
|
|
|
789
819
|
|
|
790
820
|
> **\_extractValue**(`schema`, `scope`): `Promise`\<`any`\>
|
|
791
821
|
|
|
792
|
-
Defined in: [packages/web-fetcher/src/engine/playwright.ts:352](https://github.com/isdk/web-fetcher.js/blob/
|
|
822
|
+
Defined in: [packages/web-fetcher/src/engine/playwright.ts:352](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/engine/playwright.ts#L352)
|
|
793
823
|
|
|
794
824
|
**`Internal`**
|
|
795
825
|
|
|
@@ -829,7 +859,7 @@ IExtractEngine.\_extractValue for behavior contract.
|
|
|
829
859
|
|
|
830
860
|
> **\_findClosestAncestor**(`scope`, `candidates`): `Promise`\<`any`\>
|
|
831
861
|
|
|
832
|
-
Defined in: [packages/web-fetcher/src/engine/playwright.ts:163](https://github.com/isdk/web-fetcher.js/blob/
|
|
862
|
+
Defined in: [packages/web-fetcher/src/engine/playwright.ts:163](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/engine/playwright.ts#L163)
|
|
833
863
|
|
|
834
864
|
**`Internal`**
|
|
835
865
|
|
|
@@ -869,7 +899,7 @@ IExtractEngine.\_findClosestAncestor for implementation details.
|
|
|
869
899
|
|
|
870
900
|
> **\_findCommonAncestor**(`scope1`, `scope2`): `Promise`\<`any`\>
|
|
871
901
|
|
|
872
|
-
Defined in: [packages/web-fetcher/src/engine/playwright.ts:211](https://github.com/isdk/web-fetcher.js/blob/
|
|
902
|
+
Defined in: [packages/web-fetcher/src/engine/playwright.ts:211](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/engine/playwright.ts#L211)
|
|
873
903
|
|
|
874
904
|
**`Internal`**
|
|
875
905
|
|
|
@@ -905,7 +935,7 @@ A promise resolving to the LCA element scope, or `null` if none found.
|
|
|
905
935
|
|
|
906
936
|
> **\_findContainerChild**(`element`, `container`): `Promise`\<`any`\>
|
|
907
937
|
|
|
908
|
-
Defined in: [packages/web-fetcher/src/engine/playwright.ts:284](https://github.com/isdk/web-fetcher.js/blob/
|
|
938
|
+
Defined in: [packages/web-fetcher/src/engine/playwright.ts:284](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/engine/playwright.ts#L284)
|
|
909
939
|
|
|
910
940
|
**`Internal`**
|
|
911
941
|
|
|
@@ -941,7 +971,7 @@ The child element of container, or null.
|
|
|
941
971
|
|
|
942
972
|
> `protected` **\_getInitialElementScope**(`context`): `any`
|
|
943
973
|
|
|
944
|
-
Defined in: [packages/web-fetcher/src/engine/playwright.ts:396](https://github.com/isdk/web-fetcher.js/blob/
|
|
974
|
+
Defined in: [packages/web-fetcher/src/engine/playwright.ts:396](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/engine/playwright.ts#L396)
|
|
945
975
|
|
|
946
976
|
**`Internal`**
|
|
947
977
|
|
|
@@ -965,33 +995,11 @@ Crawlee crawling context
|
|
|
965
995
|
|
|
966
996
|
***
|
|
967
997
|
|
|
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
|
-
|
|
990
998
|
### \_getSpecificCrawlerOptions()
|
|
991
999
|
|
|
992
1000
|
> `protected` **\_getSpecificCrawlerOptions**(`ctx`): `Promise`\<`Partial`\<`PlaywrightCrawlerOptions`\>\>
|
|
993
1001
|
|
|
994
|
-
Defined in: [packages/web-fetcher/src/engine/playwright.ts:
|
|
1002
|
+
Defined in: [packages/web-fetcher/src/engine/playwright.ts:886](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/engine/playwright.ts#L886)
|
|
995
1003
|
|
|
996
1004
|
**`Internal`**
|
|
997
1005
|
|
|
@@ -1019,7 +1027,7 @@ The fetch engine context.
|
|
|
1019
1027
|
|
|
1020
1028
|
> `protected` **\_getTrajectory**(`start`, `end`, `steps`): `object`[]
|
|
1021
1029
|
|
|
1022
|
-
Defined in: [packages/web-fetcher/src/engine/playwright.ts:
|
|
1030
|
+
Defined in: [packages/web-fetcher/src/engine/playwright.ts:468](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/engine/playwright.ts#L468)
|
|
1023
1031
|
|
|
1024
1032
|
#### Parameters
|
|
1025
1033
|
|
|
@@ -1057,7 +1065,7 @@ Defined in: [packages/web-fetcher/src/engine/playwright.ts:435](https://github.c
|
|
|
1057
1065
|
|
|
1058
1066
|
> `protected` **\_getTrimInfo**(`options`): `object`
|
|
1059
1067
|
|
|
1060
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1068
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:435](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/engine/base.ts#L435)
|
|
1061
1069
|
|
|
1062
1070
|
#### Parameters
|
|
1063
1071
|
|
|
@@ -1091,7 +1099,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:422](https://github.com/isd
|
|
|
1091
1099
|
|
|
1092
1100
|
> `protected` **\_handlePause**(`action`): `Promise`\<`void`\>
|
|
1093
1101
|
|
|
1094
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1102
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:1166](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/engine/base.ts#L1166)
|
|
1095
1103
|
|
|
1096
1104
|
#### Parameters
|
|
1097
1105
|
|
|
@@ -1111,11 +1119,29 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:1122](https://github.com/is
|
|
|
1111
1119
|
|
|
1112
1120
|
***
|
|
1113
1121
|
|
|
1122
|
+
### \_initializeMousePos()
|
|
1123
|
+
|
|
1124
|
+
> `protected` **\_initializeMousePos**(`page`): `Promise`\<`void`\>
|
|
1125
|
+
|
|
1126
|
+
Defined in: [packages/web-fetcher/src/engine/playwright.ts:441](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/engine/playwright.ts#L441)
|
|
1127
|
+
|
|
1128
|
+
#### Parameters
|
|
1129
|
+
|
|
1130
|
+
##### page
|
|
1131
|
+
|
|
1132
|
+
`Page`
|
|
1133
|
+
|
|
1134
|
+
#### Returns
|
|
1135
|
+
|
|
1136
|
+
`Promise`\<`void`\>
|
|
1137
|
+
|
|
1138
|
+
***
|
|
1139
|
+
|
|
1114
1140
|
### \_isSameElement()
|
|
1115
1141
|
|
|
1116
1142
|
> **\_isSameElement**(`scope1`, `scope2`): `Promise`\<`boolean`\>
|
|
1117
1143
|
|
|
1118
|
-
Defined in: [packages/web-fetcher/src/engine/playwright.ts:150](https://github.com/isdk/web-fetcher.js/blob/
|
|
1144
|
+
Defined in: [packages/web-fetcher/src/engine/playwright.ts:150](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/engine/playwright.ts#L150)
|
|
1119
1145
|
|
|
1120
1146
|
**`Internal`**
|
|
1121
1147
|
|
|
@@ -1151,7 +1177,7 @@ True if they are the same DOM node.
|
|
|
1151
1177
|
|
|
1152
1178
|
> **\_logDebug**(`category`, ...`args`): `void`
|
|
1153
1179
|
|
|
1154
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1180
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:425](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/engine/base.ts#L425)
|
|
1155
1181
|
|
|
1156
1182
|
Logs debug information if debug mode is enabled.
|
|
1157
1183
|
|
|
@@ -1179,11 +1205,43 @@ Arguments to log.
|
|
|
1179
1205
|
|
|
1180
1206
|
***
|
|
1181
1207
|
|
|
1208
|
+
### \_moveToPos()
|
|
1209
|
+
|
|
1210
|
+
> `protected` **\_moveToPos**(`context`, `target`, `steps`): `Promise`\<\{ `x`: `number`; `y`: `number`; \}\>
|
|
1211
|
+
|
|
1212
|
+
Defined in: [packages/web-fetcher/src/engine/playwright.ts:505](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/engine/playwright.ts#L505)
|
|
1213
|
+
|
|
1214
|
+
#### Parameters
|
|
1215
|
+
|
|
1216
|
+
##### context
|
|
1217
|
+
|
|
1218
|
+
`PlaywrightCrawlingContext`
|
|
1219
|
+
|
|
1220
|
+
##### target
|
|
1221
|
+
|
|
1222
|
+
###### x
|
|
1223
|
+
|
|
1224
|
+
`number`
|
|
1225
|
+
|
|
1226
|
+
###### y
|
|
1227
|
+
|
|
1228
|
+
`number`
|
|
1229
|
+
|
|
1230
|
+
##### steps
|
|
1231
|
+
|
|
1232
|
+
`number` = `-1`
|
|
1233
|
+
|
|
1234
|
+
#### Returns
|
|
1235
|
+
|
|
1236
|
+
`Promise`\<\{ `x`: `number`; `y`: `number`; \}\>
|
|
1237
|
+
|
|
1238
|
+
***
|
|
1239
|
+
|
|
1182
1240
|
### \_moveToSelector()
|
|
1183
1241
|
|
|
1184
1242
|
> `protected` **\_moveToSelector**(`context`, `selector`, `steps`): `Promise`\<\{ `x`: `number`; `y`: `number`; \}\>
|
|
1185
1243
|
|
|
1186
|
-
Defined in: [packages/web-fetcher/src/engine/playwright.ts:
|
|
1244
|
+
Defined in: [packages/web-fetcher/src/engine/playwright.ts:577](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/engine/playwright.ts#L577)
|
|
1187
1245
|
|
|
1188
1246
|
#### Parameters
|
|
1189
1247
|
|
|
@@ -1209,7 +1267,7 @@ Defined in: [packages/web-fetcher/src/engine/playwright.ts:484](https://github.c
|
|
|
1209
1267
|
|
|
1210
1268
|
> **\_nextSiblingsUntil**(`scope`, `untilSelector?`): `Promise`\<`any`[]\>
|
|
1211
1269
|
|
|
1212
|
-
Defined in: [packages/web-fetcher/src/engine/playwright.ts:127](https://github.com/isdk/web-fetcher.js/blob/
|
|
1270
|
+
Defined in: [packages/web-fetcher/src/engine/playwright.ts:127](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/engine/playwright.ts#L127)
|
|
1213
1271
|
|
|
1214
1272
|
**`Internal`**
|
|
1215
1273
|
|
|
@@ -1246,7 +1304,7 @@ List of sibling elements between anchor and untilSelector.
|
|
|
1246
1304
|
|
|
1247
1305
|
> `protected` **\_normalizeArrayMode**(`mode?`): `any`
|
|
1248
1306
|
|
|
1249
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1307
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:589](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/engine/base.ts#L589)
|
|
1250
1308
|
|
|
1251
1309
|
**`Internal`**
|
|
1252
1310
|
|
|
@@ -1274,7 +1332,7 @@ The mode string or options object.
|
|
|
1274
1332
|
|
|
1275
1333
|
> **\_parentElement**(`scope`): `Promise`\<`any`\>
|
|
1276
1334
|
|
|
1277
|
-
Defined in: [packages/web-fetcher/src/engine/playwright.ts:144](https://github.com/isdk/web-fetcher.js/blob/
|
|
1335
|
+
Defined in: [packages/web-fetcher/src/engine/playwright.ts:144](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/engine/playwright.ts#L144)
|
|
1278
1336
|
|
|
1279
1337
|
**`Internal`**
|
|
1280
1338
|
|
|
@@ -1304,7 +1362,7 @@ Parent element or null.
|
|
|
1304
1362
|
|
|
1305
1363
|
> `protected` **\_processAction**(`context`, `action`): `Promise`\<`any`\>
|
|
1306
1364
|
|
|
1307
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1365
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:1137](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/engine/base.ts#L1137)
|
|
1308
1366
|
|
|
1309
1367
|
**`Internal`**
|
|
1310
1368
|
|
|
@@ -1338,7 +1396,7 @@ Action to execute
|
|
|
1338
1396
|
|
|
1339
1397
|
> **\_querySelectorAll**(`scope`, `selector`): `Promise`\<`any`[]\>
|
|
1340
1398
|
|
|
1341
|
-
Defined in: [packages/web-fetcher/src/engine/playwright.ts:87](https://github.com/isdk/web-fetcher.js/blob/
|
|
1399
|
+
Defined in: [packages/web-fetcher/src/engine/playwright.ts:87](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/engine/playwright.ts#L87)
|
|
1342
1400
|
|
|
1343
1401
|
**`Internal`**
|
|
1344
1402
|
|
|
@@ -1378,13 +1436,13 @@ IExtractEngine.\_querySelectorAll for behavior contract.
|
|
|
1378
1436
|
|
|
1379
1437
|
> `protected` **\_sharedFailedRequestHandler**(`context`, `error?`): `Promise`\<`void`\>
|
|
1380
1438
|
|
|
1381
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1439
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:1319](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/engine/base.ts#L1319)
|
|
1382
1440
|
|
|
1383
1441
|
#### Parameters
|
|
1384
1442
|
|
|
1385
1443
|
##### context
|
|
1386
1444
|
|
|
1387
|
-
`PlaywrightCrawlingContext`
|
|
1445
|
+
`PlaywrightCrawlingContext`\<`Dictionary`\> & `object`
|
|
1388
1446
|
|
|
1389
1447
|
##### error?
|
|
1390
1448
|
|
|
@@ -1404,7 +1462,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:1269](https://github.com/is
|
|
|
1404
1462
|
|
|
1405
1463
|
> `protected` **\_sharedRequestHandler**(`context`): `Promise`\<`void`\>
|
|
1406
1464
|
|
|
1407
|
-
Defined in: [packages/web-fetcher/src/engine/
|
|
1465
|
+
Defined in: [packages/web-fetcher/src/engine/playwright.ts:429](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/engine/playwright.ts#L429)
|
|
1408
1466
|
|
|
1409
1467
|
#### Parameters
|
|
1410
1468
|
|
|
@@ -1416,7 +1474,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:1228](https://github.com/is
|
|
|
1416
1474
|
|
|
1417
1475
|
`Promise`\<`void`\>
|
|
1418
1476
|
|
|
1419
|
-
####
|
|
1477
|
+
#### Overrides
|
|
1420
1478
|
|
|
1421
1479
|
[`FetchEngine`](FetchEngine.md).[`_sharedRequestHandler`](FetchEngine.md#_sharedrequesthandler)
|
|
1422
1480
|
|
|
@@ -1426,7 +1484,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:1228](https://github.com/is
|
|
|
1426
1484
|
|
|
1427
1485
|
> `protected` **\_waitForNavigation**(`context`, `oldUrl`, `actionType`): `Promise`\<`void`\>
|
|
1428
1486
|
|
|
1429
|
-
Defined in: [packages/web-fetcher/src/engine/playwright.ts:404](https://github.com/isdk/web-fetcher.js/blob/
|
|
1487
|
+
Defined in: [packages/web-fetcher/src/engine/playwright.ts:404](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/engine/playwright.ts#L404)
|
|
1430
1488
|
|
|
1431
1489
|
#### Parameters
|
|
1432
1490
|
|
|
@@ -1452,7 +1510,7 @@ Defined in: [packages/web-fetcher/src/engine/playwright.ts:404](https://github.c
|
|
|
1452
1510
|
|
|
1453
1511
|
> **blockResources**(`types`, `overwrite?`): `Promise`\<`number`\>
|
|
1454
1512
|
|
|
1455
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1513
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:1459](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/engine/base.ts#L1459)
|
|
1456
1514
|
|
|
1457
1515
|
Blocks specified resource types from loading.
|
|
1458
1516
|
|
|
@@ -1493,7 +1551,7 @@ await engine.blockResources(['script'], true); // Replace existing
|
|
|
1493
1551
|
|
|
1494
1552
|
> `protected` **buildResponse**(`context`): `Promise`\<[`FetchResponse`](../interfaces/FetchResponse.md)\>
|
|
1495
1553
|
|
|
1496
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1554
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:672](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/engine/base.ts#L672)
|
|
1497
1555
|
|
|
1498
1556
|
#### Parameters
|
|
1499
1557
|
|
|
@@ -1515,7 +1573,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:659](https://github.com/isd
|
|
|
1515
1573
|
|
|
1516
1574
|
> **cleanup**(): `Promise`\<`void`\>
|
|
1517
1575
|
|
|
1518
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1576
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:1109](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/engine/base.ts#L1109)
|
|
1519
1577
|
|
|
1520
1578
|
#### Returns
|
|
1521
1579
|
|
|
@@ -1531,7 +1589,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:1065](https://github.com/is
|
|
|
1531
1589
|
|
|
1532
1590
|
> **click**(`selector`): `Promise`\<`void`\>
|
|
1533
1591
|
|
|
1534
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1592
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:772](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/engine/base.ts#L772)
|
|
1535
1593
|
|
|
1536
1594
|
Clicks on element matching selector.
|
|
1537
1595
|
|
|
@@ -1565,7 +1623,7 @@ When no active page context exists
|
|
|
1565
1623
|
|
|
1566
1624
|
> **cookies**(): `Promise`\<[`Cookie`](../interfaces/Cookie.md)[]\>
|
|
1567
1625
|
|
|
1568
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1626
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:1575](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/engine/base.ts#L1575)
|
|
1569
1627
|
|
|
1570
1628
|
Manages cookies for current session with multiple overloads.
|
|
1571
1629
|
|
|
@@ -1594,7 +1652,7 @@ await engine.cookies([{ name: 'session', value: '123' }]);
|
|
|
1594
1652
|
|
|
1595
1653
|
> **cookies**(`cookies`): `Promise`\<`boolean`\>
|
|
1596
1654
|
|
|
1597
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1655
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:1576](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/engine/base.ts#L1576)
|
|
1598
1656
|
|
|
1599
1657
|
Manages cookies for current session with multiple overloads.
|
|
1600
1658
|
|
|
@@ -1633,7 +1691,7 @@ await engine.cookies([{ name: 'session', value: '123' }]);
|
|
|
1633
1691
|
|
|
1634
1692
|
> `protected` **dispatchAction**\<`T`\>(`action`): `Promise`\<`T`\>
|
|
1635
1693
|
|
|
1636
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1694
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:1366](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/engine/base.ts#L1366)
|
|
1637
1695
|
|
|
1638
1696
|
#### Type Parameters
|
|
1639
1697
|
|
|
@@ -1661,7 +1719,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:1292](https://github.com/is
|
|
|
1661
1719
|
|
|
1662
1720
|
> **dispose**(): `Promise`\<`void`\>
|
|
1663
1721
|
|
|
1664
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1722
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:1611](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/engine/base.ts#L1611)
|
|
1665
1723
|
|
|
1666
1724
|
Disposes of engine, cleaning up all resources.
|
|
1667
1725
|
|
|
@@ -1681,7 +1739,7 @@ Promise resolving when disposal completes
|
|
|
1681
1739
|
|
|
1682
1740
|
> **evaluate**(`params`): `Promise`\<`any`\>
|
|
1683
1741
|
|
|
1684
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1742
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:917](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/engine/base.ts#L917)
|
|
1685
1743
|
|
|
1686
1744
|
Executes a custom function or expression within the current page context.
|
|
1687
1745
|
|
|
@@ -1727,7 +1785,7 @@ If no active page context exists or if execution fails.
|
|
|
1727
1785
|
|
|
1728
1786
|
> `protected` **executeAction**(`context`, `action`): `Promise`\<`any`\>
|
|
1729
1787
|
|
|
1730
|
-
Defined in: [packages/web-fetcher/src/engine/playwright.ts:
|
|
1788
|
+
Defined in: [packages/web-fetcher/src/engine/playwright.ts:586](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/engine/playwright.ts#L586)
|
|
1731
1789
|
|
|
1732
1790
|
**`Internal`**
|
|
1733
1791
|
|
|
@@ -1767,7 +1825,7 @@ Handles specific user interactions using underlying technology (Playwright/Cheer
|
|
|
1767
1825
|
|
|
1768
1826
|
> **extract**\<`T`\>(`schema`): `Promise`\<`T`\>
|
|
1769
1827
|
|
|
1770
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1828
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:927](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/engine/base.ts#L927)
|
|
1771
1829
|
|
|
1772
1830
|
Extracts structured data from the current page content.
|
|
1773
1831
|
|
|
@@ -1801,7 +1859,7 @@ A promise that resolves to an object with the extracted data.
|
|
|
1801
1859
|
|
|
1802
1860
|
> **fill**(`selector`, `value`): `Promise`\<`void`\>
|
|
1803
1861
|
|
|
1804
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1862
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:861](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/engine/base.ts#L861)
|
|
1805
1863
|
|
|
1806
1864
|
Fills input element with specified value.
|
|
1807
1865
|
|
|
@@ -1839,7 +1897,7 @@ When no active page context exists
|
|
|
1839
1897
|
|
|
1840
1898
|
> **getContent**(): `Promise`\<[`FetchResponse`](../interfaces/FetchResponse.md)\>
|
|
1841
1899
|
|
|
1842
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1900
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:1473](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/engine/base.ts#L1473)
|
|
1843
1901
|
|
|
1844
1902
|
Gets content of current page.
|
|
1845
1903
|
|
|
@@ -1863,7 +1921,7 @@ When no content has been fetched yet
|
|
|
1863
1921
|
|
|
1864
1922
|
> **getState**(): `Promise`\<\{ `cookies`: [`Cookie`](../interfaces/Cookie.md)[]; `sessionState?`: `any`; \}\>
|
|
1865
1923
|
|
|
1866
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1924
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:946](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/engine/base.ts#L946)
|
|
1867
1925
|
|
|
1868
1926
|
Returns the current state of the engine (cookies)
|
|
1869
1927
|
that can be used to restore the session later.
|
|
@@ -1882,7 +1940,7 @@ that can be used to restore the session later.
|
|
|
1882
1940
|
|
|
1883
1941
|
> **goto**(`url`, `opts?`): `Promise`\<[`FetchResponse`](../interfaces/FetchResponse.md)\>
|
|
1884
1942
|
|
|
1885
|
-
Defined in: [packages/web-fetcher/src/engine/playwright.ts:
|
|
1943
|
+
Defined in: [packages/web-fetcher/src/engine/playwright.ts:948](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/engine/playwright.ts#L948)
|
|
1886
1944
|
|
|
1887
1945
|
Navigates to the specified URL.
|
|
1888
1946
|
|
|
@@ -1922,7 +1980,7 @@ await engine.goto('https://example.com');
|
|
|
1922
1980
|
|
|
1923
1981
|
> **headers**(): `Promise`\<`Record`\<`string`, `string`\>\>
|
|
1924
1982
|
|
|
1925
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1983
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:1514](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/engine/base.ts#L1514)
|
|
1926
1984
|
|
|
1927
1985
|
Manages HTTP headers for requests with multiple overloads.
|
|
1928
1986
|
|
|
@@ -1953,7 +2011,7 @@ await engine.headers('auth', 'token');
|
|
|
1953
2011
|
|
|
1954
2012
|
> **headers**(`name`): `Promise`\<`string`\>
|
|
1955
2013
|
|
|
1956
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
2014
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:1515](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/engine/base.ts#L1515)
|
|
1957
2015
|
|
|
1958
2016
|
Manages HTTP headers for requests with multiple overloads.
|
|
1959
2017
|
|
|
@@ -1992,7 +2050,7 @@ await engine.headers('auth', 'token');
|
|
|
1992
2050
|
|
|
1993
2051
|
> **headers**(`headers`, `replaced?`): `Promise`\<`boolean`\>
|
|
1994
2052
|
|
|
1995
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
2053
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:1516](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/engine/base.ts#L1516)
|
|
1996
2054
|
|
|
1997
2055
|
Manages HTTP headers for requests with multiple overloads.
|
|
1998
2056
|
|
|
@@ -2037,7 +2095,7 @@ await engine.headers('auth', 'token');
|
|
|
2037
2095
|
|
|
2038
2096
|
> **headers**(`name`, `value`): `Promise`\<`boolean`\>
|
|
2039
2097
|
|
|
2040
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
2098
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:1520](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/engine/base.ts#L1520)
|
|
2041
2099
|
|
|
2042
2100
|
Manages HTTP headers for requests with multiple overloads.
|
|
2043
2101
|
|
|
@@ -2084,7 +2142,7 @@ await engine.headers('auth', 'token');
|
|
|
2084
2142
|
|
|
2085
2143
|
> **initialize**(`context`, `options?`): `Promise`\<`void`\>
|
|
2086
2144
|
|
|
2087
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
2145
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:978](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/engine/base.ts#L978)
|
|
2088
2146
|
|
|
2089
2147
|
Initializes the fetch engine with provided context and options.
|
|
2090
2148
|
|
|
@@ -2123,7 +2181,7 @@ Automatically called when creating engine via `FetchEngine.create()`.
|
|
|
2123
2181
|
|
|
2124
2182
|
> **keyboardPress**(`key`, `delay?`): `Promise`\<`void`\>
|
|
2125
2183
|
|
|
2126
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
2184
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:846](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/engine/base.ts#L846)
|
|
2127
2185
|
|
|
2128
2186
|
Presses specified key.
|
|
2129
2187
|
|
|
@@ -2155,7 +2213,7 @@ Delay after key press
|
|
|
2155
2213
|
|
|
2156
2214
|
> **keyboardType**(`text`, `delay?`): `Promise`\<`void`\>
|
|
2157
2215
|
|
|
2158
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
2216
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:836](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/engine/base.ts#L836)
|
|
2159
2217
|
|
|
2160
2218
|
Types text into current focused element.
|
|
2161
2219
|
|
|
@@ -2187,7 +2245,7 @@ Delay between key presses
|
|
|
2187
2245
|
|
|
2188
2246
|
> **mouseClick**(`params`): `Promise`\<`void`\>
|
|
2189
2247
|
|
|
2190
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
2248
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:795](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/engine/base.ts#L795)
|
|
2191
2249
|
|
|
2192
2250
|
Clicks at current position or specified position.
|
|
2193
2251
|
|
|
@@ -2231,7 +2289,7 @@ Click parameters (x, y, button, clickCount, delay)
|
|
|
2231
2289
|
|
|
2232
2290
|
> **mouseMove**(`params`): `Promise`\<`void`\>
|
|
2233
2291
|
|
|
2234
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
2292
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:781](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/engine/base.ts#L781)
|
|
2235
2293
|
|
|
2236
2294
|
Moves mouse to specified position or element.
|
|
2237
2295
|
|
|
@@ -2267,11 +2325,59 @@ Move parameters (x, y, selector, steps)
|
|
|
2267
2325
|
|
|
2268
2326
|
***
|
|
2269
2327
|
|
|
2328
|
+
### mouseWheel()
|
|
2329
|
+
|
|
2330
|
+
> **mouseWheel**(`params`): `Promise`\<`void`\>
|
|
2331
|
+
|
|
2332
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:810](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/engine/base.ts#L810)
|
|
2333
|
+
|
|
2334
|
+
Scrolls the mouse wheel.
|
|
2335
|
+
|
|
2336
|
+
#### Parameters
|
|
2337
|
+
|
|
2338
|
+
##### params
|
|
2339
|
+
|
|
2340
|
+
Wheel parameters (x, y, selector, deltaX, deltaY, steps)
|
|
2341
|
+
|
|
2342
|
+
###### deltaX?
|
|
2343
|
+
|
|
2344
|
+
`number`
|
|
2345
|
+
|
|
2346
|
+
###### deltaY?
|
|
2347
|
+
|
|
2348
|
+
`number`
|
|
2349
|
+
|
|
2350
|
+
###### selector?
|
|
2351
|
+
|
|
2352
|
+
`string`
|
|
2353
|
+
|
|
2354
|
+
###### steps?
|
|
2355
|
+
|
|
2356
|
+
`number`
|
|
2357
|
+
|
|
2358
|
+
###### x?
|
|
2359
|
+
|
|
2360
|
+
`number`
|
|
2361
|
+
|
|
2362
|
+
###### y?
|
|
2363
|
+
|
|
2364
|
+
`number`
|
|
2365
|
+
|
|
2366
|
+
#### Returns
|
|
2367
|
+
|
|
2368
|
+
`Promise`\<`void`\>
|
|
2369
|
+
|
|
2370
|
+
#### Inherited from
|
|
2371
|
+
|
|
2372
|
+
[`FetchEngine`](FetchEngine.md).[`mouseWheel`](FetchEngine.md#mousewheel)
|
|
2373
|
+
|
|
2374
|
+
***
|
|
2375
|
+
|
|
2270
2376
|
### pause()
|
|
2271
2377
|
|
|
2272
2378
|
> **pause**(`message?`): `Promise`\<`void`\>
|
|
2273
2379
|
|
|
2274
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
2380
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:895](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/engine/base.ts#L895)
|
|
2275
2381
|
|
|
2276
2382
|
Pauses execution, allowing for manual intervention or inspection.
|
|
2277
2383
|
|
|
@@ -2299,11 +2405,39 @@ When no active page context exists
|
|
|
2299
2405
|
|
|
2300
2406
|
***
|
|
2301
2407
|
|
|
2408
|
+
### scrollIntoView()
|
|
2409
|
+
|
|
2410
|
+
> **scrollIntoView**(`params`): `Promise`\<`void`\>
|
|
2411
|
+
|
|
2412
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:826](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/engine/base.ts#L826)
|
|
2413
|
+
|
|
2414
|
+
Scrolls the element into view.
|
|
2415
|
+
|
|
2416
|
+
#### Parameters
|
|
2417
|
+
|
|
2418
|
+
##### params
|
|
2419
|
+
|
|
2420
|
+
Scroll parameters (selector)
|
|
2421
|
+
|
|
2422
|
+
###### selector
|
|
2423
|
+
|
|
2424
|
+
`string`
|
|
2425
|
+
|
|
2426
|
+
#### Returns
|
|
2427
|
+
|
|
2428
|
+
`Promise`\<`void`\>
|
|
2429
|
+
|
|
2430
|
+
#### Inherited from
|
|
2431
|
+
|
|
2432
|
+
[`FetchEngine`](FetchEngine.md).[`scrollIntoView`](FetchEngine.md#scrollintoview)
|
|
2433
|
+
|
|
2434
|
+
***
|
|
2435
|
+
|
|
2302
2436
|
### submit()
|
|
2303
2437
|
|
|
2304
2438
|
> **submit**(`selector?`, `options?`): `Promise`\<`void`\>
|
|
2305
2439
|
|
|
2306
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
2440
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:873](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/engine/base.ts#L873)
|
|
2307
2441
|
|
|
2308
2442
|
Submits a form.
|
|
2309
2443
|
|
|
@@ -2341,7 +2475,7 @@ When no active page context exists
|
|
|
2341
2475
|
|
|
2342
2476
|
> **trim**(`options`): `Promise`\<`void`\>
|
|
2343
2477
|
|
|
2344
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
2478
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:884](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/engine/base.ts#L884)
|
|
2345
2479
|
|
|
2346
2480
|
Removes elements from the DOM based on selectors and presets.
|
|
2347
2481
|
|
|
@@ -2373,7 +2507,7 @@ When no active page context exists
|
|
|
2373
2507
|
|
|
2374
2508
|
> **waitFor**(`params?`): `Promise`\<`void`\>
|
|
2375
2509
|
|
|
2376
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
2510
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:761](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/engine/base.ts#L761)
|
|
2377
2511
|
|
|
2378
2512
|
Waits for specified condition before continuing.
|
|
2379
2513
|
|
|
@@ -2408,7 +2542,7 @@ await engine.waitFor({ selector: '#content' }); // Wait for element
|
|
|
2408
2542
|
|
|
2409
2543
|
> `static` **create**(`ctx`, `options?`): `Promise`\<`AnyFetchEngine` \| `undefined`\>
|
|
2410
2544
|
|
|
2411
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
2545
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:362](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/engine/base.ts#L362)
|
|
2412
2546
|
|
|
2413
2547
|
Factory method to create and initialize a fetch engine instance.
|
|
2414
2548
|
|
|
@@ -2450,7 +2584,7 @@ Primary entry point for engine creation. Selects appropriate implementation base
|
|
|
2450
2584
|
|
|
2451
2585
|
> `static` **get**(`id`): `AnyFetchEngineCtor` \| `undefined`
|
|
2452
2586
|
|
|
2453
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
2587
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:335](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/engine/base.ts#L335)
|
|
2454
2588
|
|
|
2455
2589
|
Retrieves a fetch engine implementation by its unique ID.
|
|
2456
2590
|
|
|
@@ -2478,7 +2612,7 @@ Engine class if found, otherwise `undefined`
|
|
|
2478
2612
|
|
|
2479
2613
|
> `static` **getByMode**(`mode`): `AnyFetchEngineCtor` \| `undefined`
|
|
2480
2614
|
|
|
2481
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
2615
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:345](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/engine/base.ts#L345)
|
|
2482
2616
|
|
|
2483
2617
|
Retrieves a fetch engine implementation by execution mode.
|
|
2484
2618
|
|
|
@@ -2506,7 +2640,7 @@ Engine class if found, otherwise `undefined`
|
|
|
2506
2640
|
|
|
2507
2641
|
> `static` **register**(`engineClass`): `void`
|
|
2508
2642
|
|
|
2509
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
2643
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:322](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/engine/base.ts#L322)
|
|
2510
2644
|
|
|
2511
2645
|
Registers a fetch engine implementation with the global registry.
|
|
2512
2646
|
|