@isdk/web-fetcher 0.3.0 → 0.3.2
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 +77 -312
- package/README.action.extract.cn.md +263 -0
- package/README.action.extract.md +263 -0
- package/README.action.md +76 -311
- package/README.cn.md +12 -2
- package/README.engine.cn.md +22 -1
- package/README.engine.md +22 -1
- package/README.md +10 -1
- package/dist/index.d.mts +245 -1
- package/dist/index.d.ts +245 -1
- package/dist/index.js +1 -1
- package/dist/index.mjs +1 -1
- package/docs/README.md +10 -1
- package/docs/_media/README.action.md +76 -311
- package/docs/_media/README.cn.md +12 -2
- package/docs/_media/README.engine.md +22 -1
- package/docs/classes/CheerioFetchEngine.md +312 -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 +29 -23
- package/docs/classes/FetchEngine.md +286 -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/MouseWheelAction.md +533 -0
- package/docs/classes/PauseAction.md +23 -23
- package/docs/classes/PlaywrightFetchEngine.md +472 -88
- package/docs/classes/ScrollIntoViewAction.md +533 -0
- 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/functions/getRandomDelay.md +25 -0
- package/docs/globals.md +13 -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/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/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/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/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/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/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: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:410](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/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: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:414](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/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: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:421](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/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: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:418](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/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: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:423](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/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: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:403](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/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: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:400](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/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: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:402](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/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: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:398](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/engine/base.ts#L398)
|
|
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/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/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:411](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/engine/base.ts#L411)
|
|
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:408](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/engine/base.ts#L408)
|
|
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:401](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/engine/base.ts#L401)
|
|
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:416](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/engine/base.ts#L416)
|
|
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:419](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/engine/base.ts#L419)
|
|
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:415](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/engine/base.ts#L415)
|
|
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:422](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/engine/base.ts#L422)
|
|
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:405](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/engine/base.ts#L405)
|
|
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:420](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/engine/base.ts#L420)
|
|
252
268
|
|
|
253
269
|
#### Inherited from
|
|
254
270
|
|
|
@@ -256,11 +272,19 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:390](https://github.com/isd
|
|
|
256
272
|
|
|
257
273
|
***
|
|
258
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/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/engine/playwright.ts#L439)
|
|
280
|
+
|
|
281
|
+
***
|
|
282
|
+
|
|
259
283
|
### navigationLock
|
|
260
284
|
|
|
261
285
|
> `protected` **navigationLock**: `PromiseLock`
|
|
262
286
|
|
|
263
|
-
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/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/engine/base.ts#L417)
|
|
264
288
|
|
|
265
289
|
#### Inherited from
|
|
266
290
|
|
|
@@ -272,7 +296,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:387](https://github.com/isd
|
|
|
272
296
|
|
|
273
297
|
> `protected` `optional` **opts**: [`BaseFetcherProperties`](../interfaces/BaseFetcherProperties.md)
|
|
274
298
|
|
|
275
|
-
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/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/engine/base.ts#L399)
|
|
276
300
|
|
|
277
301
|
#### Inherited from
|
|
278
302
|
|
|
@@ -284,7 +308,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:369](https://github.com/isd
|
|
|
284
308
|
|
|
285
309
|
> `protected` **pendingRequests**: `Map`\<`string`, [`PendingEngineRequest`](../interfaces/PendingEngineRequest.md)\>
|
|
286
310
|
|
|
287
|
-
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/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/engine/base.ts#L412)
|
|
288
312
|
|
|
289
313
|
#### Inherited from
|
|
290
314
|
|
|
@@ -296,7 +320,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:382](https://github.com/isd
|
|
|
296
320
|
|
|
297
321
|
> `protected` `optional` **proxyConfiguration**: `ProxyConfiguration`
|
|
298
322
|
|
|
299
|
-
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/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/engine/base.ts#L406)
|
|
300
324
|
|
|
301
325
|
#### Inherited from
|
|
302
326
|
|
|
@@ -308,7 +332,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:376](https://github.com/isd
|
|
|
308
332
|
|
|
309
333
|
> `protected` **requestCounter**: `number` = `0`
|
|
310
334
|
|
|
311
|
-
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/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/engine/base.ts#L413)
|
|
312
336
|
|
|
313
337
|
#### Inherited from
|
|
314
338
|
|
|
@@ -320,7 +344,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:383](https://github.com/isd
|
|
|
320
344
|
|
|
321
345
|
> `protected` `optional` **requestQueue**: `RequestQueue`
|
|
322
346
|
|
|
323
|
-
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/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/engine/base.ts#L404)
|
|
324
348
|
|
|
325
349
|
#### Inherited from
|
|
326
350
|
|
|
@@ -332,7 +356,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:374](https://github.com/isd
|
|
|
332
356
|
|
|
333
357
|
> `readonly` `static` **id**: `"playwright"` = `'playwright'`
|
|
334
358
|
|
|
335
|
-
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/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/engine/playwright.ts#L24)
|
|
336
360
|
|
|
337
361
|
Unique identifier for the engine implementation.
|
|
338
362
|
|
|
@@ -350,7 +374,7 @@ Must be defined by concrete implementations. Used for registration and lookup in
|
|
|
350
374
|
|
|
351
375
|
> `readonly` `static` **mode**: `"browser"` = `'browser'`
|
|
352
376
|
|
|
353
|
-
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/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/engine/playwright.ts#L25)
|
|
354
378
|
|
|
355
379
|
Execution mode of the engine (`'http'` or `'browser'`).
|
|
356
380
|
|
|
@@ -370,7 +394,7 @@ Must be defined by concrete implementations. Indicates whether engine operates a
|
|
|
370
394
|
|
|
371
395
|
> **get** **context**(): [`FetchEngineContext`](../interfaces/FetchEngineContext.md) \| `undefined`
|
|
372
396
|
|
|
373
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
397
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:957](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/engine/base.ts#L957)
|
|
374
398
|
|
|
375
399
|
Gets the fetch engine context associated with this instance.
|
|
376
400
|
|
|
@@ -390,7 +414,7 @@ Gets the fetch engine context associated with this instance.
|
|
|
390
414
|
|
|
391
415
|
> **get** **id**(): `string`
|
|
392
416
|
|
|
393
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
417
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:932](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/engine/base.ts#L932)
|
|
394
418
|
|
|
395
419
|
Gets the unique identifier of this engine implementation.
|
|
396
420
|
|
|
@@ -410,7 +434,7 @@ Gets the unique identifier of this engine implementation.
|
|
|
410
434
|
|
|
411
435
|
> **get** **mode**(): [`FetchEngineType`](../type-aliases/FetchEngineType.md)
|
|
412
436
|
|
|
413
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
437
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:950](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/engine/base.ts#L950)
|
|
414
438
|
|
|
415
439
|
Gets the execution mode of this engine (`'http'` or `'browser'`).
|
|
416
440
|
|
|
@@ -428,7 +452,7 @@ Gets the execution mode of this engine (`'http'` or `'browser'`).
|
|
|
428
452
|
|
|
429
453
|
> `protected` **\_buildResponse**(`context`): `Promise`\<[`FetchResponse`](../interfaces/FetchResponse.md)\>
|
|
430
454
|
|
|
431
|
-
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/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/engine/playwright.ts#L27)
|
|
432
456
|
|
|
433
457
|
**`Internal`**
|
|
434
458
|
|
|
@@ -462,7 +486,7 @@ Converts implementation-specific context (Playwright `page` or Cheerio `$`) to s
|
|
|
462
486
|
|
|
463
487
|
> `protected` `optional` **\_cleanup**(): `Promise`\<`void`\>
|
|
464
488
|
|
|
465
|
-
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/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/engine/base.ts#L433)
|
|
466
490
|
|
|
467
491
|
#### Returns
|
|
468
492
|
|
|
@@ -478,7 +502,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:399](https://github.com/isd
|
|
|
478
502
|
|
|
479
503
|
> `protected` **\_commonCleanup**(): `Promise`\<`void`\>
|
|
480
504
|
|
|
481
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
505
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:1363](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/engine/base.ts#L1363)
|
|
482
506
|
|
|
483
507
|
#### Returns
|
|
484
508
|
|
|
@@ -494,7 +518,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:1237](https://github.com/is
|
|
|
494
518
|
|
|
495
519
|
> **\_contains**(`container`, `element`): `Promise`\<`boolean`\>
|
|
496
520
|
|
|
497
|
-
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/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/engine/playwright.ts#L199)
|
|
498
522
|
|
|
499
523
|
**`Internal`**
|
|
500
524
|
|
|
@@ -534,7 +558,7 @@ IExtractEngine.\_contains for implementation details.
|
|
|
534
558
|
|
|
535
559
|
> `protected` **\_createCrawler**(`options`, `config?`): `PlaywrightCrawler`
|
|
536
560
|
|
|
537
|
-
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/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/engine/playwright.ts#L879)
|
|
538
562
|
|
|
539
563
|
**`Internal`**
|
|
540
564
|
|
|
@@ -562,11 +586,33 @@ The final crawler options.
|
|
|
562
586
|
|
|
563
587
|
***
|
|
564
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/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/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
|
+
|
|
565
611
|
### \_executePendingActions()
|
|
566
612
|
|
|
567
613
|
> `protected` **\_executePendingActions**(`context`): `Promise`\<`void`\>
|
|
568
614
|
|
|
569
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
615
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:1200](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/engine/base.ts#L1200)
|
|
570
616
|
|
|
571
617
|
**`Internal`**
|
|
572
618
|
|
|
@@ -619,7 +665,7 @@ If called outside valid page context window (`!this.isPageActive`)
|
|
|
619
665
|
|
|
620
666
|
> `protected` **\_extract**(`schema`, `scope`, `parentStrict?`): `Promise`\<`any`\>
|
|
621
667
|
|
|
622
|
-
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/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/engine/base.ts#L576)
|
|
623
669
|
|
|
624
670
|
#### Parameters
|
|
625
671
|
|
|
@@ -649,7 +695,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:542](https://github.com/isd
|
|
|
649
695
|
|
|
650
696
|
> `protected` **\_extractColumnar**(`schema`, `container`, `opts?`): `Promise`\<`any`[] \| `null`\>
|
|
651
697
|
|
|
652
|
-
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/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/engine/base.ts#L618)
|
|
653
699
|
|
|
654
700
|
**`Internal`**
|
|
655
701
|
|
|
@@ -691,7 +737,7 @@ An array of extracted items, or null if requirements aren't met.
|
|
|
691
737
|
|
|
692
738
|
> `protected` **\_extractNested**(`items`, `elements`, `opts?`): `Promise`\<`any`[]\>
|
|
693
739
|
|
|
694
|
-
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/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/engine/base.ts#L601)
|
|
695
741
|
|
|
696
742
|
**`Internal`**
|
|
697
743
|
|
|
@@ -731,7 +777,7 @@ The list of item elements.
|
|
|
731
777
|
|
|
732
778
|
> `protected` **\_extractSegmented**(`schema`, `container`, `opts?`): `Promise`\<`any`[] \| `null`\>
|
|
733
779
|
|
|
734
|
-
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/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/engine/base.ts#L635)
|
|
735
781
|
|
|
736
782
|
**`Internal`**
|
|
737
783
|
|
|
@@ -773,7 +819,7 @@ An array of extracted items.
|
|
|
773
819
|
|
|
774
820
|
> **\_extractValue**(`schema`, `scope`): `Promise`\<`any`\>
|
|
775
821
|
|
|
776
|
-
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/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/engine/playwright.ts#L352)
|
|
777
823
|
|
|
778
824
|
**`Internal`**
|
|
779
825
|
|
|
@@ -813,7 +859,7 @@ IExtractEngine.\_extractValue for behavior contract.
|
|
|
813
859
|
|
|
814
860
|
> **\_findClosestAncestor**(`scope`, `candidates`): `Promise`\<`any`\>
|
|
815
861
|
|
|
816
|
-
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/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/engine/playwright.ts#L163)
|
|
817
863
|
|
|
818
864
|
**`Internal`**
|
|
819
865
|
|
|
@@ -853,7 +899,7 @@ IExtractEngine.\_findClosestAncestor for implementation details.
|
|
|
853
899
|
|
|
854
900
|
> **\_findCommonAncestor**(`scope1`, `scope2`): `Promise`\<`any`\>
|
|
855
901
|
|
|
856
|
-
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/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/engine/playwright.ts#L211)
|
|
857
903
|
|
|
858
904
|
**`Internal`**
|
|
859
905
|
|
|
@@ -889,7 +935,7 @@ A promise resolving to the LCA element scope, or `null` if none found.
|
|
|
889
935
|
|
|
890
936
|
> **\_findContainerChild**(`element`, `container`): `Promise`\<`any`\>
|
|
891
937
|
|
|
892
|
-
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/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/engine/playwright.ts#L284)
|
|
893
939
|
|
|
894
940
|
**`Internal`**
|
|
895
941
|
|
|
@@ -925,7 +971,7 @@ The child element of container, or null.
|
|
|
925
971
|
|
|
926
972
|
> `protected` **\_getInitialElementScope**(`context`): `any`
|
|
927
973
|
|
|
928
|
-
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/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/engine/playwright.ts#L396)
|
|
929
975
|
|
|
930
976
|
**`Internal`**
|
|
931
977
|
|
|
@@ -953,7 +999,7 @@ Crawlee crawling context
|
|
|
953
999
|
|
|
954
1000
|
> `protected` **\_getSpecificCrawlerOptions**(`ctx`): `Promise`\<`Partial`\<`PlaywrightCrawlerOptions`\>\>
|
|
955
1001
|
|
|
956
|
-
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/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/engine/playwright.ts#L886)
|
|
957
1003
|
|
|
958
1004
|
**`Internal`**
|
|
959
1005
|
|
|
@@ -977,11 +1023,49 @@ The fetch engine context.
|
|
|
977
1023
|
|
|
978
1024
|
***
|
|
979
1025
|
|
|
1026
|
+
### \_getTrajectory()
|
|
1027
|
+
|
|
1028
|
+
> `protected` **\_getTrajectory**(`start`, `end`, `steps`): `object`[]
|
|
1029
|
+
|
|
1030
|
+
Defined in: [packages/web-fetcher/src/engine/playwright.ts:468](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/engine/playwright.ts#L468)
|
|
1031
|
+
|
|
1032
|
+
#### Parameters
|
|
1033
|
+
|
|
1034
|
+
##### start
|
|
1035
|
+
|
|
1036
|
+
###### x
|
|
1037
|
+
|
|
1038
|
+
`number`
|
|
1039
|
+
|
|
1040
|
+
###### y
|
|
1041
|
+
|
|
1042
|
+
`number`
|
|
1043
|
+
|
|
1044
|
+
##### end
|
|
1045
|
+
|
|
1046
|
+
###### x
|
|
1047
|
+
|
|
1048
|
+
`number`
|
|
1049
|
+
|
|
1050
|
+
###### y
|
|
1051
|
+
|
|
1052
|
+
`number`
|
|
1053
|
+
|
|
1054
|
+
##### steps
|
|
1055
|
+
|
|
1056
|
+
`number` = `-1`
|
|
1057
|
+
|
|
1058
|
+
#### Returns
|
|
1059
|
+
|
|
1060
|
+
`object`[]
|
|
1061
|
+
|
|
1062
|
+
***
|
|
1063
|
+
|
|
980
1064
|
### \_getTrimInfo()
|
|
981
1065
|
|
|
982
1066
|
> `protected` **\_getTrimInfo**(`options`): `object`
|
|
983
1067
|
|
|
984
|
-
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/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/engine/base.ts#L435)
|
|
985
1069
|
|
|
986
1070
|
#### Parameters
|
|
987
1071
|
|
|
@@ -1015,7 +1099,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:401](https://github.com/isd
|
|
|
1015
1099
|
|
|
1016
1100
|
> `protected` **\_handlePause**(`action`): `Promise`\<`void`\>
|
|
1017
1101
|
|
|
1018
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1102
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:1160](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/engine/base.ts#L1160)
|
|
1019
1103
|
|
|
1020
1104
|
#### Parameters
|
|
1021
1105
|
|
|
@@ -1035,11 +1119,29 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:1049](https://github.com/is
|
|
|
1035
1119
|
|
|
1036
1120
|
***
|
|
1037
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/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/engine/playwright.ts#L441)
|
|
1127
|
+
|
|
1128
|
+
#### Parameters
|
|
1129
|
+
|
|
1130
|
+
##### page
|
|
1131
|
+
|
|
1132
|
+
`Page`
|
|
1133
|
+
|
|
1134
|
+
#### Returns
|
|
1135
|
+
|
|
1136
|
+
`Promise`\<`void`\>
|
|
1137
|
+
|
|
1138
|
+
***
|
|
1139
|
+
|
|
1038
1140
|
### \_isSameElement()
|
|
1039
1141
|
|
|
1040
1142
|
> **\_isSameElement**(`scope1`, `scope2`): `Promise`\<`boolean`\>
|
|
1041
1143
|
|
|
1042
|
-
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/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/engine/playwright.ts#L150)
|
|
1043
1145
|
|
|
1044
1146
|
**`Internal`**
|
|
1045
1147
|
|
|
@@ -1075,7 +1177,7 @@ True if they are the same DOM node.
|
|
|
1075
1177
|
|
|
1076
1178
|
> **\_logDebug**(`category`, ...`args`): `void`
|
|
1077
1179
|
|
|
1078
|
-
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/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/engine/base.ts#L425)
|
|
1079
1181
|
|
|
1080
1182
|
Logs debug information if debug mode is enabled.
|
|
1081
1183
|
|
|
@@ -1103,11 +1205,69 @@ Arguments to log.
|
|
|
1103
1205
|
|
|
1104
1206
|
***
|
|
1105
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/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/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
|
+
|
|
1240
|
+
### \_moveToSelector()
|
|
1241
|
+
|
|
1242
|
+
> `protected` **\_moveToSelector**(`context`, `selector`, `steps`): `Promise`\<\{ `x`: `number`; `y`: `number`; \}\>
|
|
1243
|
+
|
|
1244
|
+
Defined in: [packages/web-fetcher/src/engine/playwright.ts:577](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/engine/playwright.ts#L577)
|
|
1245
|
+
|
|
1246
|
+
#### Parameters
|
|
1247
|
+
|
|
1248
|
+
##### context
|
|
1249
|
+
|
|
1250
|
+
`PlaywrightCrawlingContext`
|
|
1251
|
+
|
|
1252
|
+
##### selector
|
|
1253
|
+
|
|
1254
|
+
`string`
|
|
1255
|
+
|
|
1256
|
+
##### steps
|
|
1257
|
+
|
|
1258
|
+
`number` = `-1`
|
|
1259
|
+
|
|
1260
|
+
#### Returns
|
|
1261
|
+
|
|
1262
|
+
`Promise`\<\{ `x`: `number`; `y`: `number`; \}\>
|
|
1263
|
+
|
|
1264
|
+
***
|
|
1265
|
+
|
|
1106
1266
|
### \_nextSiblingsUntil()
|
|
1107
1267
|
|
|
1108
1268
|
> **\_nextSiblingsUntil**(`scope`, `untilSelector?`): `Promise`\<`any`[]\>
|
|
1109
1269
|
|
|
1110
|
-
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/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/engine/playwright.ts#L127)
|
|
1111
1271
|
|
|
1112
1272
|
**`Internal`**
|
|
1113
1273
|
|
|
@@ -1144,7 +1304,7 @@ List of sibling elements between anchor and untilSelector.
|
|
|
1144
1304
|
|
|
1145
1305
|
> `protected` **\_normalizeArrayMode**(`mode?`): `any`
|
|
1146
1306
|
|
|
1147
|
-
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/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/engine/base.ts#L589)
|
|
1148
1308
|
|
|
1149
1309
|
**`Internal`**
|
|
1150
1310
|
|
|
@@ -1172,7 +1332,7 @@ The mode string or options object.
|
|
|
1172
1332
|
|
|
1173
1333
|
> **\_parentElement**(`scope`): `Promise`\<`any`\>
|
|
1174
1334
|
|
|
1175
|
-
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/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/engine/playwright.ts#L144)
|
|
1176
1336
|
|
|
1177
1337
|
**`Internal`**
|
|
1178
1338
|
|
|
@@ -1202,7 +1362,7 @@ Parent element or null.
|
|
|
1202
1362
|
|
|
1203
1363
|
> `protected` **\_processAction**(`context`, `action`): `Promise`\<`any`\>
|
|
1204
1364
|
|
|
1205
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1365
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:1131](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/engine/base.ts#L1131)
|
|
1206
1366
|
|
|
1207
1367
|
**`Internal`**
|
|
1208
1368
|
|
|
@@ -1236,7 +1396,7 @@ Action to execute
|
|
|
1236
1396
|
|
|
1237
1397
|
> **\_querySelectorAll**(`scope`, `selector`): `Promise`\<`any`[]\>
|
|
1238
1398
|
|
|
1239
|
-
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/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/engine/playwright.ts#L87)
|
|
1240
1400
|
|
|
1241
1401
|
**`Internal`**
|
|
1242
1402
|
|
|
@@ -1276,7 +1436,7 @@ IExtractEngine.\_querySelectorAll for behavior contract.
|
|
|
1276
1436
|
|
|
1277
1437
|
> `protected` **\_sharedFailedRequestHandler**(`context`, `error?`): `Promise`\<`void`\>
|
|
1278
1438
|
|
|
1279
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1439
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:1307](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/engine/base.ts#L1307)
|
|
1280
1440
|
|
|
1281
1441
|
#### Parameters
|
|
1282
1442
|
|
|
@@ -1302,7 +1462,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:1185](https://github.com/is
|
|
|
1302
1462
|
|
|
1303
1463
|
> `protected` **\_sharedRequestHandler**(`context`): `Promise`\<`void`\>
|
|
1304
1464
|
|
|
1305
|
-
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/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/engine/playwright.ts#L429)
|
|
1306
1466
|
|
|
1307
1467
|
#### Parameters
|
|
1308
1468
|
|
|
@@ -1314,7 +1474,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:1144](https://github.com/is
|
|
|
1314
1474
|
|
|
1315
1475
|
`Promise`\<`void`\>
|
|
1316
1476
|
|
|
1317
|
-
####
|
|
1477
|
+
#### Overrides
|
|
1318
1478
|
|
|
1319
1479
|
[`FetchEngine`](FetchEngine.md).[`_sharedRequestHandler`](FetchEngine.md#_sharedrequesthandler)
|
|
1320
1480
|
|
|
@@ -1324,7 +1484,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:1144](https://github.com/is
|
|
|
1324
1484
|
|
|
1325
1485
|
> `protected` **\_waitForNavigation**(`context`, `oldUrl`, `actionType`): `Promise`\<`void`\>
|
|
1326
1486
|
|
|
1327
|
-
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/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/engine/playwright.ts#L404)
|
|
1328
1488
|
|
|
1329
1489
|
#### Parameters
|
|
1330
1490
|
|
|
@@ -1350,7 +1510,7 @@ Defined in: [packages/web-fetcher/src/engine/playwright.ts:404](https://github.c
|
|
|
1350
1510
|
|
|
1351
1511
|
> **blockResources**(`types`, `overwrite?`): `Promise`\<`number`\>
|
|
1352
1512
|
|
|
1353
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1513
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:1427](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/engine/base.ts#L1427)
|
|
1354
1514
|
|
|
1355
1515
|
Blocks specified resource types from loading.
|
|
1356
1516
|
|
|
@@ -1391,7 +1551,7 @@ await engine.blockResources(['script'], true); // Replace existing
|
|
|
1391
1551
|
|
|
1392
1552
|
> `protected` **buildResponse**(`context`): `Promise`\<[`FetchResponse`](../interfaces/FetchResponse.md)\>
|
|
1393
1553
|
|
|
1394
|
-
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/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/engine/base.ts#L672)
|
|
1395
1555
|
|
|
1396
1556
|
#### Parameters
|
|
1397
1557
|
|
|
@@ -1413,7 +1573,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:638](https://github.com/isd
|
|
|
1413
1573
|
|
|
1414
1574
|
> **cleanup**(): `Promise`\<`void`\>
|
|
1415
1575
|
|
|
1416
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1576
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:1103](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/engine/base.ts#L1103)
|
|
1417
1577
|
|
|
1418
1578
|
#### Returns
|
|
1419
1579
|
|
|
@@ -1429,7 +1589,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:992](https://github.com/isd
|
|
|
1429
1589
|
|
|
1430
1590
|
> **click**(`selector`): `Promise`\<`void`\>
|
|
1431
1591
|
|
|
1432
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1592
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:766](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/engine/base.ts#L766)
|
|
1433
1593
|
|
|
1434
1594
|
Clicks on element matching selector.
|
|
1435
1595
|
|
|
@@ -1463,7 +1623,7 @@ When no active page context exists
|
|
|
1463
1623
|
|
|
1464
1624
|
> **cookies**(): `Promise`\<[`Cookie`](../interfaces/Cookie.md)[]\>
|
|
1465
1625
|
|
|
1466
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1626
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:1543](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/engine/base.ts#L1543)
|
|
1467
1627
|
|
|
1468
1628
|
Manages cookies for current session with multiple overloads.
|
|
1469
1629
|
|
|
@@ -1492,7 +1652,7 @@ await engine.cookies([{ name: 'session', value: '123' }]);
|
|
|
1492
1652
|
|
|
1493
1653
|
> **cookies**(`cookies`): `Promise`\<`boolean`\>
|
|
1494
1654
|
|
|
1495
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1655
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:1544](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/engine/base.ts#L1544)
|
|
1496
1656
|
|
|
1497
1657
|
Manages cookies for current session with multiple overloads.
|
|
1498
1658
|
|
|
@@ -1531,7 +1691,7 @@ await engine.cookies([{ name: 'session', value: '123' }]);
|
|
|
1531
1691
|
|
|
1532
1692
|
> `protected` **dispatchAction**\<`T`\>(`action`): `Promise`\<`T`\>
|
|
1533
1693
|
|
|
1534
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1694
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:1334](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/engine/base.ts#L1334)
|
|
1535
1695
|
|
|
1536
1696
|
#### Type Parameters
|
|
1537
1697
|
|
|
@@ -1559,7 +1719,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:1208](https://github.com/is
|
|
|
1559
1719
|
|
|
1560
1720
|
> **dispose**(): `Promise`\<`void`\>
|
|
1561
1721
|
|
|
1562
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1722
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:1579](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/engine/base.ts#L1579)
|
|
1563
1723
|
|
|
1564
1724
|
Disposes of engine, cleaning up all resources.
|
|
1565
1725
|
|
|
@@ -1579,7 +1739,7 @@ Promise resolving when disposal completes
|
|
|
1579
1739
|
|
|
1580
1740
|
> **evaluate**(`params`): `Promise`\<`any`\>
|
|
1581
1741
|
|
|
1582
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1742
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:911](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/engine/base.ts#L911)
|
|
1583
1743
|
|
|
1584
1744
|
Executes a custom function or expression within the current page context.
|
|
1585
1745
|
|
|
@@ -1625,7 +1785,7 @@ If no active page context exists or if execution fails.
|
|
|
1625
1785
|
|
|
1626
1786
|
> `protected` **executeAction**(`context`, `action`): `Promise`\<`any`\>
|
|
1627
1787
|
|
|
1628
|
-
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/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/engine/playwright.ts#L586)
|
|
1629
1789
|
|
|
1630
1790
|
**`Internal`**
|
|
1631
1791
|
|
|
@@ -1665,7 +1825,7 @@ Handles specific user interactions using underlying technology (Playwright/Cheer
|
|
|
1665
1825
|
|
|
1666
1826
|
> **extract**\<`T`\>(`schema`): `Promise`\<`T`\>
|
|
1667
1827
|
|
|
1668
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1828
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:921](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/engine/base.ts#L921)
|
|
1669
1829
|
|
|
1670
1830
|
Extracts structured data from the current page content.
|
|
1671
1831
|
|
|
@@ -1699,7 +1859,7 @@ A promise that resolves to an object with the extracted data.
|
|
|
1699
1859
|
|
|
1700
1860
|
> **fill**(`selector`, `value`): `Promise`\<`void`\>
|
|
1701
1861
|
|
|
1702
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1862
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:855](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/engine/base.ts#L855)
|
|
1703
1863
|
|
|
1704
1864
|
Fills input element with specified value.
|
|
1705
1865
|
|
|
@@ -1737,7 +1897,7 @@ When no active page context exists
|
|
|
1737
1897
|
|
|
1738
1898
|
> **getContent**(): `Promise`\<[`FetchResponse`](../interfaces/FetchResponse.md)\>
|
|
1739
1899
|
|
|
1740
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1900
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:1441](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/engine/base.ts#L1441)
|
|
1741
1901
|
|
|
1742
1902
|
Gets content of current page.
|
|
1743
1903
|
|
|
@@ -1761,7 +1921,7 @@ When no content has been fetched yet
|
|
|
1761
1921
|
|
|
1762
1922
|
> **getState**(): `Promise`\<\{ `cookies`: [`Cookie`](../interfaces/Cookie.md)[]; `sessionState?`: `any`; \}\>
|
|
1763
1923
|
|
|
1764
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1924
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:940](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/engine/base.ts#L940)
|
|
1765
1925
|
|
|
1766
1926
|
Returns the current state of the engine (cookies)
|
|
1767
1927
|
that can be used to restore the session later.
|
|
@@ -1780,7 +1940,7 @@ that can be used to restore the session later.
|
|
|
1780
1940
|
|
|
1781
1941
|
> **goto**(`url`, `opts?`): `Promise`\<[`FetchResponse`](../interfaces/FetchResponse.md)\>
|
|
1782
1942
|
|
|
1783
|
-
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/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/engine/playwright.ts#L948)
|
|
1784
1944
|
|
|
1785
1945
|
Navigates to the specified URL.
|
|
1786
1946
|
|
|
@@ -1820,7 +1980,7 @@ await engine.goto('https://example.com');
|
|
|
1820
1980
|
|
|
1821
1981
|
> **headers**(): `Promise`\<`Record`\<`string`, `string`\>\>
|
|
1822
1982
|
|
|
1823
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1983
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:1482](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/engine/base.ts#L1482)
|
|
1824
1984
|
|
|
1825
1985
|
Manages HTTP headers for requests with multiple overloads.
|
|
1826
1986
|
|
|
@@ -1851,7 +2011,7 @@ await engine.headers('auth', 'token');
|
|
|
1851
2011
|
|
|
1852
2012
|
> **headers**(`name`): `Promise`\<`string`\>
|
|
1853
2013
|
|
|
1854
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
2014
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:1483](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/engine/base.ts#L1483)
|
|
1855
2015
|
|
|
1856
2016
|
Manages HTTP headers for requests with multiple overloads.
|
|
1857
2017
|
|
|
@@ -1890,7 +2050,7 @@ await engine.headers('auth', 'token');
|
|
|
1890
2050
|
|
|
1891
2051
|
> **headers**(`headers`, `replaced?`): `Promise`\<`boolean`\>
|
|
1892
2052
|
|
|
1893
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
2053
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:1484](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/engine/base.ts#L1484)
|
|
1894
2054
|
|
|
1895
2055
|
Manages HTTP headers for requests with multiple overloads.
|
|
1896
2056
|
|
|
@@ -1935,7 +2095,7 @@ await engine.headers('auth', 'token');
|
|
|
1935
2095
|
|
|
1936
2096
|
> **headers**(`name`, `value`): `Promise`\<`boolean`\>
|
|
1937
2097
|
|
|
1938
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
2098
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:1488](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/engine/base.ts#L1488)
|
|
1939
2099
|
|
|
1940
2100
|
Manages HTTP headers for requests with multiple overloads.
|
|
1941
2101
|
|
|
@@ -1982,7 +2142,7 @@ await engine.headers('auth', 'token');
|
|
|
1982
2142
|
|
|
1983
2143
|
> **initialize**(`context`, `options?`): `Promise`\<`void`\>
|
|
1984
2144
|
|
|
1985
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
2145
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:972](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/engine/base.ts#L972)
|
|
1986
2146
|
|
|
1987
2147
|
Initializes the fetch engine with provided context and options.
|
|
1988
2148
|
|
|
@@ -2017,11 +2177,207 @@ Automatically called when creating engine via `FetchEngine.create()`.
|
|
|
2017
2177
|
|
|
2018
2178
|
***
|
|
2019
2179
|
|
|
2180
|
+
### keyboardPress()
|
|
2181
|
+
|
|
2182
|
+
> **keyboardPress**(`key`, `delay?`): `Promise`\<`void`\>
|
|
2183
|
+
|
|
2184
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:840](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/engine/base.ts#L840)
|
|
2185
|
+
|
|
2186
|
+
Presses specified key.
|
|
2187
|
+
|
|
2188
|
+
#### Parameters
|
|
2189
|
+
|
|
2190
|
+
##### key
|
|
2191
|
+
|
|
2192
|
+
`string`
|
|
2193
|
+
|
|
2194
|
+
Key to press
|
|
2195
|
+
|
|
2196
|
+
##### delay?
|
|
2197
|
+
|
|
2198
|
+
`number`
|
|
2199
|
+
|
|
2200
|
+
Delay after key press
|
|
2201
|
+
|
|
2202
|
+
#### Returns
|
|
2203
|
+
|
|
2204
|
+
`Promise`\<`void`\>
|
|
2205
|
+
|
|
2206
|
+
#### Inherited from
|
|
2207
|
+
|
|
2208
|
+
[`FetchEngine`](FetchEngine.md).[`keyboardPress`](FetchEngine.md#keyboardpress)
|
|
2209
|
+
|
|
2210
|
+
***
|
|
2211
|
+
|
|
2212
|
+
### keyboardType()
|
|
2213
|
+
|
|
2214
|
+
> **keyboardType**(`text`, `delay?`): `Promise`\<`void`\>
|
|
2215
|
+
|
|
2216
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:830](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/engine/base.ts#L830)
|
|
2217
|
+
|
|
2218
|
+
Types text into current focused element.
|
|
2219
|
+
|
|
2220
|
+
#### Parameters
|
|
2221
|
+
|
|
2222
|
+
##### text
|
|
2223
|
+
|
|
2224
|
+
`string`
|
|
2225
|
+
|
|
2226
|
+
Text to type
|
|
2227
|
+
|
|
2228
|
+
##### delay?
|
|
2229
|
+
|
|
2230
|
+
`number`
|
|
2231
|
+
|
|
2232
|
+
Delay between key presses
|
|
2233
|
+
|
|
2234
|
+
#### Returns
|
|
2235
|
+
|
|
2236
|
+
`Promise`\<`void`\>
|
|
2237
|
+
|
|
2238
|
+
#### Inherited from
|
|
2239
|
+
|
|
2240
|
+
[`FetchEngine`](FetchEngine.md).[`keyboardType`](FetchEngine.md#keyboardtype)
|
|
2241
|
+
|
|
2242
|
+
***
|
|
2243
|
+
|
|
2244
|
+
### mouseClick()
|
|
2245
|
+
|
|
2246
|
+
> **mouseClick**(`params`): `Promise`\<`void`\>
|
|
2247
|
+
|
|
2248
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:789](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/engine/base.ts#L789)
|
|
2249
|
+
|
|
2250
|
+
Clicks at current position or specified position.
|
|
2251
|
+
|
|
2252
|
+
#### Parameters
|
|
2253
|
+
|
|
2254
|
+
##### params
|
|
2255
|
+
|
|
2256
|
+
Click parameters (x, y, button, clickCount, delay)
|
|
2257
|
+
|
|
2258
|
+
###### button?
|
|
2259
|
+
|
|
2260
|
+
`"left"` \| `"right"` \| `"middle"`
|
|
2261
|
+
|
|
2262
|
+
###### clickCount?
|
|
2263
|
+
|
|
2264
|
+
`number`
|
|
2265
|
+
|
|
2266
|
+
###### delay?
|
|
2267
|
+
|
|
2268
|
+
`number`
|
|
2269
|
+
|
|
2270
|
+
###### x?
|
|
2271
|
+
|
|
2272
|
+
`number`
|
|
2273
|
+
|
|
2274
|
+
###### y?
|
|
2275
|
+
|
|
2276
|
+
`number`
|
|
2277
|
+
|
|
2278
|
+
#### Returns
|
|
2279
|
+
|
|
2280
|
+
`Promise`\<`void`\>
|
|
2281
|
+
|
|
2282
|
+
#### Inherited from
|
|
2283
|
+
|
|
2284
|
+
[`FetchEngine`](FetchEngine.md).[`mouseClick`](FetchEngine.md#mouseclick)
|
|
2285
|
+
|
|
2286
|
+
***
|
|
2287
|
+
|
|
2288
|
+
### mouseMove()
|
|
2289
|
+
|
|
2290
|
+
> **mouseMove**(`params`): `Promise`\<`void`\>
|
|
2291
|
+
|
|
2292
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:775](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/engine/base.ts#L775)
|
|
2293
|
+
|
|
2294
|
+
Moves mouse to specified position or element.
|
|
2295
|
+
|
|
2296
|
+
#### Parameters
|
|
2297
|
+
|
|
2298
|
+
##### params
|
|
2299
|
+
|
|
2300
|
+
Move parameters (x, y, selector, steps)
|
|
2301
|
+
|
|
2302
|
+
###### selector?
|
|
2303
|
+
|
|
2304
|
+
`string`
|
|
2305
|
+
|
|
2306
|
+
###### steps?
|
|
2307
|
+
|
|
2308
|
+
`number`
|
|
2309
|
+
|
|
2310
|
+
###### x?
|
|
2311
|
+
|
|
2312
|
+
`number`
|
|
2313
|
+
|
|
2314
|
+
###### y?
|
|
2315
|
+
|
|
2316
|
+
`number`
|
|
2317
|
+
|
|
2318
|
+
#### Returns
|
|
2319
|
+
|
|
2320
|
+
`Promise`\<`void`\>
|
|
2321
|
+
|
|
2322
|
+
#### Inherited from
|
|
2323
|
+
|
|
2324
|
+
[`FetchEngine`](FetchEngine.md).[`mouseMove`](FetchEngine.md#mousemove)
|
|
2325
|
+
|
|
2326
|
+
***
|
|
2327
|
+
|
|
2328
|
+
### mouseWheel()
|
|
2329
|
+
|
|
2330
|
+
> **mouseWheel**(`params`): `Promise`\<`void`\>
|
|
2331
|
+
|
|
2332
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:804](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/engine/base.ts#L804)
|
|
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
|
+
|
|
2020
2376
|
### pause()
|
|
2021
2377
|
|
|
2022
2378
|
> **pause**(`message?`): `Promise`\<`void`\>
|
|
2023
2379
|
|
|
2024
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
2380
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:889](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/engine/base.ts#L889)
|
|
2025
2381
|
|
|
2026
2382
|
Pauses execution, allowing for manual intervention or inspection.
|
|
2027
2383
|
|
|
@@ -2049,11 +2405,39 @@ When no active page context exists
|
|
|
2049
2405
|
|
|
2050
2406
|
***
|
|
2051
2407
|
|
|
2408
|
+
### scrollIntoView()
|
|
2409
|
+
|
|
2410
|
+
> **scrollIntoView**(`params`): `Promise`\<`void`\>
|
|
2411
|
+
|
|
2412
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:820](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/engine/base.ts#L820)
|
|
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
|
+
|
|
2052
2436
|
### submit()
|
|
2053
2437
|
|
|
2054
2438
|
> **submit**(`selector?`, `options?`): `Promise`\<`void`\>
|
|
2055
2439
|
|
|
2056
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
2440
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:867](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/engine/base.ts#L867)
|
|
2057
2441
|
|
|
2058
2442
|
Submits a form.
|
|
2059
2443
|
|
|
@@ -2091,7 +2475,7 @@ When no active page context exists
|
|
|
2091
2475
|
|
|
2092
2476
|
> **trim**(`options`): `Promise`\<`void`\>
|
|
2093
2477
|
|
|
2094
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
2478
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:878](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/engine/base.ts#L878)
|
|
2095
2479
|
|
|
2096
2480
|
Removes elements from the DOM based on selectors and presets.
|
|
2097
2481
|
|
|
@@ -2123,7 +2507,7 @@ When no active page context exists
|
|
|
2123
2507
|
|
|
2124
2508
|
> **waitFor**(`params?`): `Promise`\<`void`\>
|
|
2125
2509
|
|
|
2126
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
2510
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:755](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/engine/base.ts#L755)
|
|
2127
2511
|
|
|
2128
2512
|
Waits for specified condition before continuing.
|
|
2129
2513
|
|
|
@@ -2158,7 +2542,7 @@ await engine.waitFor({ selector: '#content' }); // Wait for element
|
|
|
2158
2542
|
|
|
2159
2543
|
> `static` **create**(`ctx`, `options?`): `Promise`\<`AnyFetchEngine` \| `undefined`\>
|
|
2160
2544
|
|
|
2161
|
-
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/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/engine/base.ts#L362)
|
|
2162
2546
|
|
|
2163
2547
|
Factory method to create and initialize a fetch engine instance.
|
|
2164
2548
|
|
|
@@ -2200,7 +2584,7 @@ Primary entry point for engine creation. Selects appropriate implementation base
|
|
|
2200
2584
|
|
|
2201
2585
|
> `static` **get**(`id`): `AnyFetchEngineCtor` \| `undefined`
|
|
2202
2586
|
|
|
2203
|
-
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/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/engine/base.ts#L335)
|
|
2204
2588
|
|
|
2205
2589
|
Retrieves a fetch engine implementation by its unique ID.
|
|
2206
2590
|
|
|
@@ -2228,7 +2612,7 @@ Engine class if found, otherwise `undefined`
|
|
|
2228
2612
|
|
|
2229
2613
|
> `static` **getByMode**(`mode`): `AnyFetchEngineCtor` \| `undefined`
|
|
2230
2614
|
|
|
2231
|
-
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/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/engine/base.ts#L345)
|
|
2232
2616
|
|
|
2233
2617
|
Retrieves a fetch engine implementation by execution mode.
|
|
2234
2618
|
|
|
@@ -2256,7 +2640,7 @@ Engine class if found, otherwise `undefined`
|
|
|
2256
2640
|
|
|
2257
2641
|
> `static` **register**(`engineClass`): `void`
|
|
2258
2642
|
|
|
2259
|
-
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/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/engine/base.ts#L322)
|
|
2260
2644
|
|
|
2261
2645
|
Registers a fetch engine implementation with the global registry.
|
|
2262
2646
|
|