@isdk/web-fetcher 0.3.0 → 0.3.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.action.cn.md +53 -312
- package/README.action.extract.cn.md +263 -0
- package/README.action.extract.md +263 -0
- package/README.action.md +53 -311
- package/README.cn.md +10 -2
- package/README.engine.cn.md +22 -1
- package/README.engine.md +22 -1
- package/README.md +8 -1
- package/dist/index.d.mts +147 -1
- package/dist/index.d.ts +147 -1
- package/dist/index.js +1 -1
- package/dist/index.mjs +1 -1
- package/docs/README.md +8 -1
- package/docs/_media/README.action.md +53 -311
- package/docs/_media/README.cn.md +10 -2
- package/docs/_media/README.engine.md +22 -1
- package/docs/classes/CheerioFetchEngine.md +236 -88
- package/docs/classes/ClickAction.md +23 -23
- package/docs/classes/EvaluateAction.md +23 -23
- package/docs/classes/ExtractAction.md +23 -23
- package/docs/classes/FetchAction.md +27 -23
- package/docs/classes/FetchEngine.md +218 -86
- package/docs/classes/FetchSession.md +13 -13
- package/docs/classes/FillAction.md +23 -23
- package/docs/classes/GetContentAction.md +23 -23
- package/docs/classes/GotoAction.md +23 -23
- package/docs/classes/KeyboardPressAction.md +533 -0
- package/docs/classes/KeyboardTypeAction.md +533 -0
- package/docs/classes/MouseClickAction.md +533 -0
- package/docs/classes/MouseMoveAction.md +533 -0
- package/docs/classes/PauseAction.md +23 -23
- package/docs/classes/PlaywrightFetchEngine.md +337 -87
- package/docs/classes/SubmitAction.md +23 -23
- package/docs/classes/TrimAction.md +23 -23
- package/docs/classes/WaitForAction.md +23 -23
- package/docs/classes/WebFetcher.md +5 -5
- package/docs/enumerations/FetchActionResultStatus.md +4 -4
- package/docs/functions/fetchWeb.md +2 -2
- package/docs/globals.md +8 -0
- package/docs/interfaces/BaseFetchActionProperties.md +12 -12
- package/docs/interfaces/BaseFetchCollectorActionProperties.md +16 -16
- package/docs/interfaces/BaseFetcherProperties.md +31 -27
- package/docs/interfaces/Cookie.md +14 -14
- package/docs/interfaces/DispatchedEngineAction.md +4 -4
- package/docs/interfaces/EvaluateActionOptions.md +3 -3
- package/docs/interfaces/ExtractActionProperties.md +12 -12
- package/docs/interfaces/FetchActionInContext.md +15 -15
- package/docs/interfaces/FetchActionProperties.md +13 -13
- package/docs/interfaces/FetchActionResult.md +6 -6
- package/docs/interfaces/FetchContext.md +41 -37
- package/docs/interfaces/FetchEngineContext.md +36 -32
- package/docs/interfaces/FetchMetadata.md +5 -5
- package/docs/interfaces/FetchResponse.md +14 -14
- package/docs/interfaces/FetchReturnTypeRegistry.md +7 -7
- package/docs/interfaces/FetchSite.md +34 -30
- package/docs/interfaces/FetcherOptions.md +33 -29
- package/docs/interfaces/GotoActionOptions.md +14 -6
- package/docs/interfaces/KeyboardPressParams.md +25 -0
- package/docs/interfaces/KeyboardTypeParams.md +25 -0
- package/docs/interfaces/MouseClickParams.md +49 -0
- package/docs/interfaces/MouseMoveParams.md +41 -0
- package/docs/interfaces/PendingEngineRequest.md +3 -3
- package/docs/interfaces/StorageOptions.md +5 -5
- package/docs/interfaces/SubmitActionOptions.md +2 -2
- package/docs/interfaces/TrimActionOptions.md +3 -3
- package/docs/interfaces/WaitForActionOptions.md +5 -5
- package/docs/type-aliases/BaseFetchActionOptions.md +1 -1
- package/docs/type-aliases/BaseFetchCollectorOptions.md +1 -1
- package/docs/type-aliases/BrowserEngine.md +1 -1
- package/docs/type-aliases/FetchActionCapabilities.md +1 -1
- package/docs/type-aliases/FetchActionCapabilityMode.md +1 -1
- package/docs/type-aliases/FetchActionOptions.md +1 -1
- package/docs/type-aliases/FetchEngineAction.md +2 -2
- package/docs/type-aliases/FetchEngineType.md +1 -1
- package/docs/type-aliases/FetchReturnType.md +1 -1
- package/docs/type-aliases/FetchReturnTypeFor.md +1 -1
- package/docs/type-aliases/OnFetchPauseCallback.md +1 -1
- package/docs/type-aliases/ResourceType.md +1 -1
- package/docs/type-aliases/TrimPreset.md +1 -1
- package/docs/variables/DefaultFetcherProperties.md +1 -1
- package/docs/variables/FetcherOptionKeys.md +1 -1
- package/docs/variables/TRIM_PRESETS.md +1 -1
- package/package.json +10 -10
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Abstract Class: FetchEngine\<TContext, TCrawler, TOptions\>
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
9
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:289](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L289)
|
|
10
10
|
|
|
11
11
|
## Extended by
|
|
12
12
|
|
|
@@ -47,7 +47,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:272](https://github.com/isd
|
|
|
47
47
|
|
|
48
48
|
> `protected` `optional` **\_initialCookies**: [`Cookie`](../interfaces/Cookie.md)[]
|
|
49
49
|
|
|
50
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
50
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:396](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L396)
|
|
51
51
|
|
|
52
52
|
***
|
|
53
53
|
|
|
@@ -55,7 +55,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:379](https://github.com/isd
|
|
|
55
55
|
|
|
56
56
|
> `protected` **\_initializedSessions**: `Set`\<`string`\>
|
|
57
57
|
|
|
58
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
58
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:397](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L397)
|
|
59
59
|
|
|
60
60
|
***
|
|
61
61
|
|
|
@@ -63,7 +63,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:380](https://github.com/isd
|
|
|
63
63
|
|
|
64
64
|
> `protected` **actionEmitter**: `EventEmitter`
|
|
65
65
|
|
|
66
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
66
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:401](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L401)
|
|
67
67
|
|
|
68
68
|
***
|
|
69
69
|
|
|
@@ -71,7 +71,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:384](https://github.com/isd
|
|
|
71
71
|
|
|
72
72
|
> `protected` **actionQueue**: [`DispatchedEngineAction`](../interfaces/DispatchedEngineAction.md)[] = `[]`
|
|
73
73
|
|
|
74
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
74
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:408](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L408)
|
|
75
75
|
|
|
76
76
|
***
|
|
77
77
|
|
|
@@ -79,7 +79,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:391](https://github.com/isd
|
|
|
79
79
|
|
|
80
80
|
> `protected` `optional` **activeContext**: `TContext`
|
|
81
81
|
|
|
82
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
82
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:405](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L405)
|
|
83
83
|
|
|
84
84
|
***
|
|
85
85
|
|
|
@@ -87,7 +87,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:388](https://github.com/isd
|
|
|
87
87
|
|
|
88
88
|
> `protected` **blockedTypes**: `Set`\<`string`\>
|
|
89
89
|
|
|
90
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
90
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:410](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L410)
|
|
91
91
|
|
|
92
92
|
***
|
|
93
93
|
|
|
@@ -95,7 +95,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:393](https://github.com/isd
|
|
|
95
95
|
|
|
96
96
|
> `protected` `optional` **config**: `Configuration`
|
|
97
97
|
|
|
98
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
98
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:390](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L390)
|
|
99
99
|
|
|
100
100
|
***
|
|
101
101
|
|
|
@@ -103,7 +103,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:373](https://github.com/isd
|
|
|
103
103
|
|
|
104
104
|
> `protected` `optional` **crawler**: `TCrawler`
|
|
105
105
|
|
|
106
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
106
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:387](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L387)
|
|
107
107
|
|
|
108
108
|
***
|
|
109
109
|
|
|
@@ -111,7 +111,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:370](https://github.com/isd
|
|
|
111
111
|
|
|
112
112
|
> `protected` `optional` **crawlerRunPromise**: `Promise`\<`FinalStatistics`\>
|
|
113
113
|
|
|
114
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
114
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:389](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L389)
|
|
115
115
|
|
|
116
116
|
***
|
|
117
117
|
|
|
@@ -119,7 +119,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:372](https://github.com/isd
|
|
|
119
119
|
|
|
120
120
|
> `protected` `optional` **ctx**: [`FetchEngineContext`](../interfaces/FetchEngineContext.md)
|
|
121
121
|
|
|
122
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
122
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:385](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L385)
|
|
123
123
|
|
|
124
124
|
***
|
|
125
125
|
|
|
@@ -127,7 +127,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:368](https://github.com/isd
|
|
|
127
127
|
|
|
128
128
|
> `protected` `optional` **currentSession**: `Session`
|
|
129
129
|
|
|
130
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
130
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:398](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L398)
|
|
131
131
|
|
|
132
132
|
***
|
|
133
133
|
|
|
@@ -135,7 +135,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:381](https://github.com/isd
|
|
|
135
135
|
|
|
136
136
|
> `protected` **hdrs**: `Record`\<`string`, `string`\> = `{}`
|
|
137
137
|
|
|
138
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
138
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:395](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L395)
|
|
139
139
|
|
|
140
140
|
***
|
|
141
141
|
|
|
@@ -143,7 +143,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:378](https://github.com/isd
|
|
|
143
143
|
|
|
144
144
|
> `protected` `optional` **isCrawlerReady**: `boolean`
|
|
145
145
|
|
|
146
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
146
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:388](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L388)
|
|
147
147
|
|
|
148
148
|
***
|
|
149
149
|
|
|
@@ -151,7 +151,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:371](https://github.com/isd
|
|
|
151
151
|
|
|
152
152
|
> `protected` **isEngineDisposed**: `boolean` = `false`
|
|
153
153
|
|
|
154
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
154
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:403](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L403)
|
|
155
155
|
|
|
156
156
|
***
|
|
157
157
|
|
|
@@ -159,7 +159,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:386](https://github.com/isd
|
|
|
159
159
|
|
|
160
160
|
> `protected` **isExecutingAction**: `boolean` = `false`
|
|
161
161
|
|
|
162
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
162
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:406](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L406)
|
|
163
163
|
|
|
164
164
|
***
|
|
165
165
|
|
|
@@ -167,7 +167,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:389](https://github.com/isd
|
|
|
167
167
|
|
|
168
168
|
> `protected` **isPageActive**: `boolean` = `false`
|
|
169
169
|
|
|
170
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
170
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:402](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L402)
|
|
171
171
|
|
|
172
172
|
***
|
|
173
173
|
|
|
@@ -175,7 +175,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:385](https://github.com/isd
|
|
|
175
175
|
|
|
176
176
|
> `protected` **isProcessingActionLoop**: `boolean` = `false`
|
|
177
177
|
|
|
178
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
178
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:409](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L409)
|
|
179
179
|
|
|
180
180
|
***
|
|
181
181
|
|
|
@@ -183,7 +183,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:392](https://github.com/isd
|
|
|
183
183
|
|
|
184
184
|
> `protected` `optional` **kvStore**: `KeyValueStore`
|
|
185
185
|
|
|
186
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
186
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:392](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L392)
|
|
187
187
|
|
|
188
188
|
***
|
|
189
189
|
|
|
@@ -191,7 +191,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:375](https://github.com/isd
|
|
|
191
191
|
|
|
192
192
|
> `protected` `optional` **lastResponse**: [`FetchResponse`](../interfaces/FetchResponse.md)
|
|
193
193
|
|
|
194
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
194
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:407](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L407)
|
|
195
195
|
|
|
196
196
|
***
|
|
197
197
|
|
|
@@ -199,7 +199,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:390](https://github.com/isd
|
|
|
199
199
|
|
|
200
200
|
> `protected` **navigationLock**: `PromiseLock`
|
|
201
201
|
|
|
202
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
202
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:404](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L404)
|
|
203
203
|
|
|
204
204
|
***
|
|
205
205
|
|
|
@@ -207,7 +207,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:387](https://github.com/isd
|
|
|
207
207
|
|
|
208
208
|
> `protected` `optional` **opts**: [`BaseFetcherProperties`](../interfaces/BaseFetcherProperties.md)
|
|
209
209
|
|
|
210
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
210
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:386](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L386)
|
|
211
211
|
|
|
212
212
|
***
|
|
213
213
|
|
|
@@ -215,7 +215,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:369](https://github.com/isd
|
|
|
215
215
|
|
|
216
216
|
> `protected` **pendingRequests**: `Map`\<`string`, [`PendingEngineRequest`](../interfaces/PendingEngineRequest.md)\>
|
|
217
217
|
|
|
218
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
218
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:399](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L399)
|
|
219
219
|
|
|
220
220
|
***
|
|
221
221
|
|
|
@@ -223,7 +223,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:382](https://github.com/isd
|
|
|
223
223
|
|
|
224
224
|
> `protected` `optional` **proxyConfiguration**: `ProxyConfiguration`
|
|
225
225
|
|
|
226
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
226
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:393](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L393)
|
|
227
227
|
|
|
228
228
|
***
|
|
229
229
|
|
|
@@ -231,7 +231,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:376](https://github.com/isd
|
|
|
231
231
|
|
|
232
232
|
> `protected` **requestCounter**: `number` = `0`
|
|
233
233
|
|
|
234
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
234
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:400](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L400)
|
|
235
235
|
|
|
236
236
|
***
|
|
237
237
|
|
|
@@ -239,7 +239,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:383](https://github.com/isd
|
|
|
239
239
|
|
|
240
240
|
> `protected` `optional` **requestQueue**: `RequestQueue`
|
|
241
241
|
|
|
242
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
242
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:391](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L391)
|
|
243
243
|
|
|
244
244
|
***
|
|
245
245
|
|
|
@@ -247,7 +247,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:374](https://github.com/isd
|
|
|
247
247
|
|
|
248
248
|
> `readonly` `static` **id**: `string`
|
|
249
249
|
|
|
250
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
250
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:375](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L375)
|
|
251
251
|
|
|
252
252
|
Unique identifier for the engine implementation.
|
|
253
253
|
|
|
@@ -261,7 +261,7 @@ Must be defined by concrete implementations. Used for registration and lookup in
|
|
|
261
261
|
|
|
262
262
|
> `readonly` `static` **mode**: [`FetchEngineType`](../type-aliases/FetchEngineType.md)
|
|
263
263
|
|
|
264
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
264
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:383](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L383)
|
|
265
265
|
|
|
266
266
|
Execution mode of the engine (`'http'` or `'browser'`).
|
|
267
267
|
|
|
@@ -277,7 +277,7 @@ Must be defined by concrete implementations. Indicates whether engine operates a
|
|
|
277
277
|
|
|
278
278
|
> **get** **context**(): [`FetchEngineContext`](../interfaces/FetchEngineContext.md) \| `undefined`
|
|
279
279
|
|
|
280
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
280
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:919](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L919)
|
|
281
281
|
|
|
282
282
|
Gets the fetch engine context associated with this instance.
|
|
283
283
|
|
|
@@ -293,7 +293,7 @@ Gets the fetch engine context associated with this instance.
|
|
|
293
293
|
|
|
294
294
|
> **get** **id**(): `string`
|
|
295
295
|
|
|
296
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
296
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:894](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L894)
|
|
297
297
|
|
|
298
298
|
Gets the unique identifier of this engine implementation.
|
|
299
299
|
|
|
@@ -309,7 +309,7 @@ Gets the unique identifier of this engine implementation.
|
|
|
309
309
|
|
|
310
310
|
> **get** **mode**(): [`FetchEngineType`](../type-aliases/FetchEngineType.md)
|
|
311
311
|
|
|
312
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
312
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:912](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L912)
|
|
313
313
|
|
|
314
314
|
Gets the execution mode of this engine (`'http'` or `'browser'`).
|
|
315
315
|
|
|
@@ -323,7 +323,7 @@ Gets the execution mode of this engine (`'http'` or `'browser'`).
|
|
|
323
323
|
|
|
324
324
|
> `abstract` `protected` **\_buildResponse**(`context`): `Promise`\<[`FetchResponse`](../interfaces/FetchResponse.md)\>
|
|
325
325
|
|
|
326
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
326
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:658](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L658)
|
|
327
327
|
|
|
328
328
|
**`Internal`**
|
|
329
329
|
|
|
@@ -353,7 +353,7 @@ Converts implementation-specific context (Playwright `page` or Cheerio `$`) to s
|
|
|
353
353
|
|
|
354
354
|
> `protected` `optional` **\_cleanup**(): `Promise`\<`void`\>
|
|
355
355
|
|
|
356
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
356
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:420](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L420)
|
|
357
357
|
|
|
358
358
|
#### Returns
|
|
359
359
|
|
|
@@ -365,7 +365,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:399](https://github.com/isd
|
|
|
365
365
|
|
|
366
366
|
> `protected` **\_commonCleanup**(): `Promise`\<`void`\>
|
|
367
367
|
|
|
368
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
368
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:1321](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L1321)
|
|
369
369
|
|
|
370
370
|
#### Returns
|
|
371
371
|
|
|
@@ -377,7 +377,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:1237](https://github.com/is
|
|
|
377
377
|
|
|
378
378
|
> `abstract` **\_contains**(`container`, `element`): `Promise`\<`boolean`\>
|
|
379
379
|
|
|
380
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
380
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:532](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L532)
|
|
381
381
|
|
|
382
382
|
**`Internal`**
|
|
383
383
|
|
|
@@ -417,7 +417,7 @@ IExtractEngine.\_contains for implementation details.
|
|
|
417
417
|
|
|
418
418
|
> `abstract` `protected` **\_createCrawler**(`options`, `config?`): `TCrawler`
|
|
419
419
|
|
|
420
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
420
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:635](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L635)
|
|
421
421
|
|
|
422
422
|
**`Internal`**
|
|
423
423
|
|
|
@@ -445,7 +445,7 @@ The final crawler options.
|
|
|
445
445
|
|
|
446
446
|
> `protected` **\_executePendingActions**(`context`): `Promise`\<`void`\>
|
|
447
447
|
|
|
448
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
448
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:1162](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L1162)
|
|
449
449
|
|
|
450
450
|
**`Internal`**
|
|
451
451
|
|
|
@@ -494,7 +494,7 @@ If called outside valid page context window (`!this.isPageActive`)
|
|
|
494
494
|
|
|
495
495
|
> `protected` **\_extract**(`schema`, `scope`, `parentStrict?`): `Promise`\<`any`\>
|
|
496
496
|
|
|
497
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
497
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:563](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L563)
|
|
498
498
|
|
|
499
499
|
#### Parameters
|
|
500
500
|
|
|
@@ -520,7 +520,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:542](https://github.com/isd
|
|
|
520
520
|
|
|
521
521
|
> `protected` **\_extractColumnar**(`schema`, `container`, `opts?`): `Promise`\<`any`[] \| `null`\>
|
|
522
522
|
|
|
523
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
523
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:605](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L605)
|
|
524
524
|
|
|
525
525
|
**`Internal`**
|
|
526
526
|
|
|
@@ -558,7 +558,7 @@ An array of extracted items, or null if requirements aren't met.
|
|
|
558
558
|
|
|
559
559
|
> `protected` **\_extractNested**(`items`, `elements`, `opts?`): `Promise`\<`any`[]\>
|
|
560
560
|
|
|
561
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
561
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:588](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L588)
|
|
562
562
|
|
|
563
563
|
**`Internal`**
|
|
564
564
|
|
|
@@ -594,7 +594,7 @@ The list of item elements.
|
|
|
594
594
|
|
|
595
595
|
> `protected` **\_extractSegmented**(`schema`, `container`, `opts?`): `Promise`\<`any`[] \| `null`\>
|
|
596
596
|
|
|
597
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
597
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:622](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L622)
|
|
598
598
|
|
|
599
599
|
**`Internal`**
|
|
600
600
|
|
|
@@ -632,7 +632,7 @@ An array of extracted items.
|
|
|
632
632
|
|
|
633
633
|
> `abstract` **\_extractValue**(`schema`, `scope`): `Promise`\<`any`\>
|
|
634
634
|
|
|
635
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
635
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:466](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L466)
|
|
636
636
|
|
|
637
637
|
**`Internal`**
|
|
638
638
|
|
|
@@ -672,7 +672,7 @@ IExtractEngine.\_extractValue for behavior contract.
|
|
|
672
672
|
|
|
673
673
|
> `abstract` **\_findClosestAncestor**(`scope`, `candidates`): `Promise`\<`any`\>
|
|
674
674
|
|
|
675
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
675
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:518](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L518)
|
|
676
676
|
|
|
677
677
|
**`Internal`**
|
|
678
678
|
|
|
@@ -712,7 +712,7 @@ IExtractEngine.\_findClosestAncestor for implementation details.
|
|
|
712
712
|
|
|
713
713
|
> `abstract` **\_findCommonAncestor**(`scope1`, `scope2`): `Promise`\<`any`\>
|
|
714
714
|
|
|
715
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
715
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:545](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L545)
|
|
716
716
|
|
|
717
717
|
**`Internal`**
|
|
718
718
|
|
|
@@ -748,7 +748,7 @@ A promise resolving to the LCA element scope, or `null` if none found.
|
|
|
748
748
|
|
|
749
749
|
> `abstract` **\_findContainerChild**(`element`, `container`): `Promise`\<`any`\>
|
|
750
750
|
|
|
751
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
751
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:558](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L558)
|
|
752
752
|
|
|
753
753
|
**`Internal`**
|
|
754
754
|
|
|
@@ -784,7 +784,7 @@ The child element of container, or null.
|
|
|
784
784
|
|
|
785
785
|
> `abstract` `protected` **\_getInitialElementScope**(`context`): `any`
|
|
786
786
|
|
|
787
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
787
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:1083](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L1083)
|
|
788
788
|
|
|
789
789
|
**`Internal`**
|
|
790
790
|
|
|
@@ -808,7 +808,7 @@ Crawlee crawling context
|
|
|
808
808
|
|
|
809
809
|
> `abstract` `protected` **\_getSpecificCrawlerOptions**(`ctx`): `Partial`\<`TOptions`\> \| `Promise`\<`Partial`\<`TOptions`\>\>
|
|
810
810
|
|
|
811
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
811
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:645](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L645)
|
|
812
812
|
|
|
813
813
|
**`Internal`**
|
|
814
814
|
|
|
@@ -832,7 +832,7 @@ The fetch engine context.
|
|
|
832
832
|
|
|
833
833
|
> `protected` **\_getTrimInfo**(`options`): `object`
|
|
834
834
|
|
|
835
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
835
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:422](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L422)
|
|
836
836
|
|
|
837
837
|
#### Parameters
|
|
838
838
|
|
|
@@ -862,7 +862,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:401](https://github.com/isd
|
|
|
862
862
|
|
|
863
863
|
> `protected` **\_handlePause**(`action`): `Promise`\<`void`\>
|
|
864
864
|
|
|
865
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
865
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:1122](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L1122)
|
|
866
866
|
|
|
867
867
|
#### Parameters
|
|
868
868
|
|
|
@@ -882,7 +882,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:1049](https://github.com/is
|
|
|
882
882
|
|
|
883
883
|
> `abstract` **\_isSameElement**(`scope1`, `scope2`): `Promise`\<`boolean`\>
|
|
884
884
|
|
|
885
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
885
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:490](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L490)
|
|
886
886
|
|
|
887
887
|
**`Internal`**
|
|
888
888
|
|
|
@@ -918,7 +918,7 @@ True if they are the same DOM node.
|
|
|
918
918
|
|
|
919
919
|
> **\_logDebug**(`category`, ...`args`): `void`
|
|
920
920
|
|
|
921
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
921
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:412](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L412)
|
|
922
922
|
|
|
923
923
|
Logs debug information if debug mode is enabled.
|
|
924
924
|
|
|
@@ -950,7 +950,7 @@ Arguments to log.
|
|
|
950
950
|
|
|
951
951
|
> `abstract` **\_nextSiblingsUntil**(`scope`, `untilSelector?`): `Promise`\<`any`[]\>
|
|
952
952
|
|
|
953
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
953
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:504](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L504)
|
|
954
954
|
|
|
955
955
|
**`Internal`**
|
|
956
956
|
|
|
@@ -987,7 +987,7 @@ List of sibling elements between anchor and untilSelector.
|
|
|
987
987
|
|
|
988
988
|
> `protected` **\_normalizeArrayMode**(`mode?`): `any`
|
|
989
989
|
|
|
990
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
990
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:576](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L576)
|
|
991
991
|
|
|
992
992
|
**`Internal`**
|
|
993
993
|
|
|
@@ -1011,7 +1011,7 @@ The mode string or options object.
|
|
|
1011
1011
|
|
|
1012
1012
|
> `abstract` **\_parentElement**(`scope`): `Promise`\<`any`\>
|
|
1013
1013
|
|
|
1014
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1014
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:478](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L478)
|
|
1015
1015
|
|
|
1016
1016
|
**`Internal`**
|
|
1017
1017
|
|
|
@@ -1041,7 +1041,7 @@ Parent element or null.
|
|
|
1041
1041
|
|
|
1042
1042
|
> `protected` **\_processAction**(`context`, `action`): `Promise`\<`any`\>
|
|
1043
1043
|
|
|
1044
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1044
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:1093](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L1093)
|
|
1045
1045
|
|
|
1046
1046
|
**`Internal`**
|
|
1047
1047
|
|
|
@@ -1071,7 +1071,7 @@ Action to execute
|
|
|
1071
1071
|
|
|
1072
1072
|
> `abstract` **\_querySelectorAll**(`scope`, `selector`): `Promise`\<`any`[]\>
|
|
1073
1073
|
|
|
1074
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1074
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:452](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L452)
|
|
1075
1075
|
|
|
1076
1076
|
**`Internal`**
|
|
1077
1077
|
|
|
@@ -1111,7 +1111,7 @@ IExtractEngine.\_querySelectorAll for behavior contract.
|
|
|
1111
1111
|
|
|
1112
1112
|
> `protected` **\_sharedFailedRequestHandler**(`context`, `error?`): `Promise`\<`void`\>
|
|
1113
1113
|
|
|
1114
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1114
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:1269](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L1269)
|
|
1115
1115
|
|
|
1116
1116
|
#### Parameters
|
|
1117
1117
|
|
|
@@ -1133,7 +1133,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:1185](https://github.com/is
|
|
|
1133
1133
|
|
|
1134
1134
|
> `protected` **\_sharedRequestHandler**(`context`): `Promise`\<`void`\>
|
|
1135
1135
|
|
|
1136
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1136
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:1228](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L1228)
|
|
1137
1137
|
|
|
1138
1138
|
#### Parameters
|
|
1139
1139
|
|
|
@@ -1151,7 +1151,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:1144](https://github.com/is
|
|
|
1151
1151
|
|
|
1152
1152
|
> **blockResources**(`types`, `overwrite?`): `Promise`\<`number`\>
|
|
1153
1153
|
|
|
1154
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1154
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:1385](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L1385)
|
|
1155
1155
|
|
|
1156
1156
|
Blocks specified resource types from loading.
|
|
1157
1157
|
|
|
@@ -1188,7 +1188,7 @@ await engine.blockResources(['script'], true); // Replace existing
|
|
|
1188
1188
|
|
|
1189
1189
|
> `protected` **buildResponse**(`context`): `Promise`\<[`FetchResponse`](../interfaces/FetchResponse.md)\>
|
|
1190
1190
|
|
|
1191
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1191
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:659](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L659)
|
|
1192
1192
|
|
|
1193
1193
|
#### Parameters
|
|
1194
1194
|
|
|
@@ -1206,7 +1206,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:638](https://github.com/isd
|
|
|
1206
1206
|
|
|
1207
1207
|
> **cleanup**(): `Promise`\<`void`\>
|
|
1208
1208
|
|
|
1209
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1209
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:1065](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L1065)
|
|
1210
1210
|
|
|
1211
1211
|
#### Returns
|
|
1212
1212
|
|
|
@@ -1218,7 +1218,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:992](https://github.com/isd
|
|
|
1218
1218
|
|
|
1219
1219
|
> **click**(`selector`): `Promise`\<`void`\>
|
|
1220
1220
|
|
|
1221
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1221
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:753](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L753)
|
|
1222
1222
|
|
|
1223
1223
|
Clicks on element matching selector.
|
|
1224
1224
|
|
|
@@ -1248,7 +1248,7 @@ When no active page context exists
|
|
|
1248
1248
|
|
|
1249
1249
|
> **cookies**(): `Promise`\<[`Cookie`](../interfaces/Cookie.md)[]\>
|
|
1250
1250
|
|
|
1251
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1251
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:1501](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L1501)
|
|
1252
1252
|
|
|
1253
1253
|
Manages cookies for current session with multiple overloads.
|
|
1254
1254
|
|
|
@@ -1273,7 +1273,7 @@ await engine.cookies([{ name: 'session', value: '123' }]);
|
|
|
1273
1273
|
|
|
1274
1274
|
> **cookies**(`cookies`): `Promise`\<`boolean`\>
|
|
1275
1275
|
|
|
1276
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1276
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:1502](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L1502)
|
|
1277
1277
|
|
|
1278
1278
|
Manages cookies for current session with multiple overloads.
|
|
1279
1279
|
|
|
@@ -1308,7 +1308,7 @@ await engine.cookies([{ name: 'session', value: '123' }]);
|
|
|
1308
1308
|
|
|
1309
1309
|
> `protected` **dispatchAction**\<`T`\>(`action`): `Promise`\<`T`\>
|
|
1310
1310
|
|
|
1311
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1311
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:1292](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L1292)
|
|
1312
1312
|
|
|
1313
1313
|
#### Type Parameters
|
|
1314
1314
|
|
|
@@ -1332,7 +1332,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:1208](https://github.com/is
|
|
|
1332
1332
|
|
|
1333
1333
|
> **dispose**(): `Promise`\<`void`\>
|
|
1334
1334
|
|
|
1335
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1335
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:1537](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L1537)
|
|
1336
1336
|
|
|
1337
1337
|
Disposes of engine, cleaning up all resources.
|
|
1338
1338
|
|
|
@@ -1348,7 +1348,7 @@ Promise resolving when disposal completes
|
|
|
1348
1348
|
|
|
1349
1349
|
> **evaluate**(`params`): `Promise`\<`any`\>
|
|
1350
1350
|
|
|
1351
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1351
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:873](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L873)
|
|
1352
1352
|
|
|
1353
1353
|
Executes a custom function or expression within the current page context.
|
|
1354
1354
|
|
|
@@ -1390,7 +1390,7 @@ If no active page context exists or if execution fails.
|
|
|
1390
1390
|
|
|
1391
1391
|
> `abstract` `protected` **executeAction**(`context`, `action`): `Promise`\<`any`\>
|
|
1392
1392
|
|
|
1393
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1393
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:708](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L708)
|
|
1394
1394
|
|
|
1395
1395
|
**`Internal`**
|
|
1396
1396
|
|
|
@@ -1426,7 +1426,7 @@ Handles specific user interactions using underlying technology (Playwright/Cheer
|
|
|
1426
1426
|
|
|
1427
1427
|
> **extract**\<`T`\>(`schema`): `Promise`\<`T`\>
|
|
1428
1428
|
|
|
1429
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1429
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:883](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L883)
|
|
1430
1430
|
|
|
1431
1431
|
Extracts structured data from the current page content.
|
|
1432
1432
|
|
|
@@ -1456,7 +1456,7 @@ A promise that resolves to an object with the extracted data.
|
|
|
1456
1456
|
|
|
1457
1457
|
> **fill**(`selector`, `value`): `Promise`\<`void`\>
|
|
1458
1458
|
|
|
1459
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1459
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:817](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L817)
|
|
1460
1460
|
|
|
1461
1461
|
Fills input element with specified value.
|
|
1462
1462
|
|
|
@@ -1490,7 +1490,7 @@ When no active page context exists
|
|
|
1490
1490
|
|
|
1491
1491
|
> **getContent**(): `Promise`\<[`FetchResponse`](../interfaces/FetchResponse.md)\>
|
|
1492
1492
|
|
|
1493
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1493
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:1399](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L1399)
|
|
1494
1494
|
|
|
1495
1495
|
Gets content of current page.
|
|
1496
1496
|
|
|
@@ -1510,7 +1510,7 @@ When no content has been fetched yet
|
|
|
1510
1510
|
|
|
1511
1511
|
> **getState**(): `Promise`\<\{ `cookies`: [`Cookie`](../interfaces/Cookie.md)[]; `sessionState?`: `any`; \}\>
|
|
1512
1512
|
|
|
1513
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1513
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:902](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L902)
|
|
1514
1514
|
|
|
1515
1515
|
Returns the current state of the engine (cookies)
|
|
1516
1516
|
that can be used to restore the session later.
|
|
@@ -1525,7 +1525,7 @@ that can be used to restore the session later.
|
|
|
1525
1525
|
|
|
1526
1526
|
> `abstract` **goto**(`url`, `params?`): `Promise`\<`void` \| [`FetchResponse`](../interfaces/FetchResponse.md)\>
|
|
1527
1527
|
|
|
1528
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1528
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:725](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L725)
|
|
1529
1529
|
|
|
1530
1530
|
Navigates to the specified URL.
|
|
1531
1531
|
|
|
@@ -1563,7 +1563,7 @@ await engine.goto('https://example.com');
|
|
|
1563
1563
|
|
|
1564
1564
|
> **headers**(): `Promise`\<`Record`\<`string`, `string`\>\>
|
|
1565
1565
|
|
|
1566
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1566
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:1440](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L1440)
|
|
1567
1567
|
|
|
1568
1568
|
Manages HTTP headers for requests with multiple overloads.
|
|
1569
1569
|
|
|
@@ -1590,7 +1590,7 @@ await engine.headers('auth', 'token');
|
|
|
1590
1590
|
|
|
1591
1591
|
> **headers**(`name`): `Promise`\<`string`\>
|
|
1592
1592
|
|
|
1593
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1593
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:1441](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L1441)
|
|
1594
1594
|
|
|
1595
1595
|
Manages HTTP headers for requests with multiple overloads.
|
|
1596
1596
|
|
|
@@ -1625,7 +1625,7 @@ await engine.headers('auth', 'token');
|
|
|
1625
1625
|
|
|
1626
1626
|
> **headers**(`headers`, `replaced?`): `Promise`\<`boolean`\>
|
|
1627
1627
|
|
|
1628
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1628
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:1442](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L1442)
|
|
1629
1629
|
|
|
1630
1630
|
Manages HTTP headers for requests with multiple overloads.
|
|
1631
1631
|
|
|
@@ -1666,7 +1666,7 @@ await engine.headers('auth', 'token');
|
|
|
1666
1666
|
|
|
1667
1667
|
> **headers**(`name`, `value`): `Promise`\<`boolean`\>
|
|
1668
1668
|
|
|
1669
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1669
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:1446](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L1446)
|
|
1670
1670
|
|
|
1671
1671
|
Manages HTTP headers for requests with multiple overloads.
|
|
1672
1672
|
|
|
@@ -1709,7 +1709,7 @@ await engine.headers('auth', 'token');
|
|
|
1709
1709
|
|
|
1710
1710
|
> **initialize**(`context`, `options?`): `Promise`\<`void`\>
|
|
1711
1711
|
|
|
1712
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1712
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:934](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L934)
|
|
1713
1713
|
|
|
1714
1714
|
Initializes the fetch engine with provided context and options.
|
|
1715
1715
|
|
|
@@ -1740,11 +1740,143 @@ Automatically called when creating engine via `FetchEngine.create()`.
|
|
|
1740
1740
|
|
|
1741
1741
|
***
|
|
1742
1742
|
|
|
1743
|
+
### keyboardPress()
|
|
1744
|
+
|
|
1745
|
+
> **keyboardPress**(`key`, `delay?`): `Promise`\<`void`\>
|
|
1746
|
+
|
|
1747
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:802](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L802)
|
|
1748
|
+
|
|
1749
|
+
Presses specified key.
|
|
1750
|
+
|
|
1751
|
+
#### Parameters
|
|
1752
|
+
|
|
1753
|
+
##### key
|
|
1754
|
+
|
|
1755
|
+
`string`
|
|
1756
|
+
|
|
1757
|
+
Key to press
|
|
1758
|
+
|
|
1759
|
+
##### delay?
|
|
1760
|
+
|
|
1761
|
+
`number`
|
|
1762
|
+
|
|
1763
|
+
Delay after key press
|
|
1764
|
+
|
|
1765
|
+
#### Returns
|
|
1766
|
+
|
|
1767
|
+
`Promise`\<`void`\>
|
|
1768
|
+
|
|
1769
|
+
***
|
|
1770
|
+
|
|
1771
|
+
### keyboardType()
|
|
1772
|
+
|
|
1773
|
+
> **keyboardType**(`text`, `delay?`): `Promise`\<`void`\>
|
|
1774
|
+
|
|
1775
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:792](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L792)
|
|
1776
|
+
|
|
1777
|
+
Types text into current focused element.
|
|
1778
|
+
|
|
1779
|
+
#### Parameters
|
|
1780
|
+
|
|
1781
|
+
##### text
|
|
1782
|
+
|
|
1783
|
+
`string`
|
|
1784
|
+
|
|
1785
|
+
Text to type
|
|
1786
|
+
|
|
1787
|
+
##### delay?
|
|
1788
|
+
|
|
1789
|
+
`number`
|
|
1790
|
+
|
|
1791
|
+
Delay between key presses
|
|
1792
|
+
|
|
1793
|
+
#### Returns
|
|
1794
|
+
|
|
1795
|
+
`Promise`\<`void`\>
|
|
1796
|
+
|
|
1797
|
+
***
|
|
1798
|
+
|
|
1799
|
+
### mouseClick()
|
|
1800
|
+
|
|
1801
|
+
> **mouseClick**(`params`): `Promise`\<`void`\>
|
|
1802
|
+
|
|
1803
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:776](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L776)
|
|
1804
|
+
|
|
1805
|
+
Clicks at current position or specified position.
|
|
1806
|
+
|
|
1807
|
+
#### Parameters
|
|
1808
|
+
|
|
1809
|
+
##### params
|
|
1810
|
+
|
|
1811
|
+
Click parameters (x, y, button, clickCount, delay)
|
|
1812
|
+
|
|
1813
|
+
###### button?
|
|
1814
|
+
|
|
1815
|
+
`"left"` \| `"right"` \| `"middle"`
|
|
1816
|
+
|
|
1817
|
+
###### clickCount?
|
|
1818
|
+
|
|
1819
|
+
`number`
|
|
1820
|
+
|
|
1821
|
+
###### delay?
|
|
1822
|
+
|
|
1823
|
+
`number`
|
|
1824
|
+
|
|
1825
|
+
###### x?
|
|
1826
|
+
|
|
1827
|
+
`number`
|
|
1828
|
+
|
|
1829
|
+
###### y?
|
|
1830
|
+
|
|
1831
|
+
`number`
|
|
1832
|
+
|
|
1833
|
+
#### Returns
|
|
1834
|
+
|
|
1835
|
+
`Promise`\<`void`\>
|
|
1836
|
+
|
|
1837
|
+
***
|
|
1838
|
+
|
|
1839
|
+
### mouseMove()
|
|
1840
|
+
|
|
1841
|
+
> **mouseMove**(`params`): `Promise`\<`void`\>
|
|
1842
|
+
|
|
1843
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:762](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L762)
|
|
1844
|
+
|
|
1845
|
+
Moves mouse to specified position or element.
|
|
1846
|
+
|
|
1847
|
+
#### Parameters
|
|
1848
|
+
|
|
1849
|
+
##### params
|
|
1850
|
+
|
|
1851
|
+
Move parameters (x, y, selector, steps)
|
|
1852
|
+
|
|
1853
|
+
###### selector?
|
|
1854
|
+
|
|
1855
|
+
`string`
|
|
1856
|
+
|
|
1857
|
+
###### steps?
|
|
1858
|
+
|
|
1859
|
+
`number`
|
|
1860
|
+
|
|
1861
|
+
###### x?
|
|
1862
|
+
|
|
1863
|
+
`number`
|
|
1864
|
+
|
|
1865
|
+
###### y?
|
|
1866
|
+
|
|
1867
|
+
`number`
|
|
1868
|
+
|
|
1869
|
+
#### Returns
|
|
1870
|
+
|
|
1871
|
+
`Promise`\<`void`\>
|
|
1872
|
+
|
|
1873
|
+
***
|
|
1874
|
+
|
|
1743
1875
|
### pause()
|
|
1744
1876
|
|
|
1745
1877
|
> **pause**(`message?`): `Promise`\<`void`\>
|
|
1746
1878
|
|
|
1747
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1879
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:851](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L851)
|
|
1748
1880
|
|
|
1749
1881
|
Pauses execution, allowing for manual intervention or inspection.
|
|
1750
1882
|
|
|
@@ -1772,7 +1904,7 @@ When no active page context exists
|
|
|
1772
1904
|
|
|
1773
1905
|
> **submit**(`selector?`, `options?`): `Promise`\<`void`\>
|
|
1774
1906
|
|
|
1775
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1907
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:829](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L829)
|
|
1776
1908
|
|
|
1777
1909
|
Submits a form.
|
|
1778
1910
|
|
|
@@ -1806,7 +1938,7 @@ When no active page context exists
|
|
|
1806
1938
|
|
|
1807
1939
|
> **trim**(`options`): `Promise`\<`void`\>
|
|
1808
1940
|
|
|
1809
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1941
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:840](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L840)
|
|
1810
1942
|
|
|
1811
1943
|
Removes elements from the DOM based on selectors and presets.
|
|
1812
1944
|
|
|
@@ -1834,7 +1966,7 @@ When no active page context exists
|
|
|
1834
1966
|
|
|
1835
1967
|
> **waitFor**(`params?`): `Promise`\<`void`\>
|
|
1836
1968
|
|
|
1837
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1969
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:742](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L742)
|
|
1838
1970
|
|
|
1839
1971
|
Waits for specified condition before continuing.
|
|
1840
1972
|
|
|
@@ -1865,7 +1997,7 @@ await engine.waitFor({ selector: '#content' }); // Wait for element
|
|
|
1865
1997
|
|
|
1866
1998
|
> `static` **create**(`ctx`, `options?`): `Promise`\<`AnyFetchEngine` \| `undefined`\>
|
|
1867
1999
|
|
|
1868
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
2000
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:349](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L349)
|
|
1869
2001
|
|
|
1870
2002
|
Factory method to create and initialize a fetch engine instance.
|
|
1871
2003
|
|
|
@@ -1903,7 +2035,7 @@ Primary entry point for engine creation. Selects appropriate implementation base
|
|
|
1903
2035
|
|
|
1904
2036
|
> `static` **get**(`id`): `AnyFetchEngineCtor` \| `undefined`
|
|
1905
2037
|
|
|
1906
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
2038
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:322](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L322)
|
|
1907
2039
|
|
|
1908
2040
|
Retrieves a fetch engine implementation by its unique ID.
|
|
1909
2041
|
|
|
@@ -1927,7 +2059,7 @@ Engine class if found, otherwise `undefined`
|
|
|
1927
2059
|
|
|
1928
2060
|
> `static` **getByMode**(`mode`): `AnyFetchEngineCtor` \| `undefined`
|
|
1929
2061
|
|
|
1930
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
2062
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:332](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L332)
|
|
1931
2063
|
|
|
1932
2064
|
Retrieves a fetch engine implementation by execution mode.
|
|
1933
2065
|
|
|
@@ -1951,7 +2083,7 @@ Engine class if found, otherwise `undefined`
|
|
|
1951
2083
|
|
|
1952
2084
|
> `static` **register**(`engineClass`): `void`
|
|
1953
2085
|
|
|
1954
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
2086
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:309](https://github.com/isdk/web-fetcher.js/blob/e691a2370f59d15979b47994c8ca14d7b7d2edd3/src/engine/base.ts#L309)
|
|
1955
2087
|
|
|
1956
2088
|
Registers a fetch engine implementation with the global registry.
|
|
1957
2089
|
|