@isdk/web-fetcher 0.2.10 → 0.2.12

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.
Files changed (65) hide show
  1. package/README.action.cn.md +81 -20
  2. package/README.action.md +81 -4
  3. package/README.cn.md +8 -6
  4. package/README.engine.cn.md +28 -8
  5. package/README.engine.md +28 -8
  6. package/README.md +8 -6
  7. package/dist/index.d.mts +408 -11
  8. package/dist/index.d.ts +408 -11
  9. package/dist/index.js +1 -1
  10. package/dist/index.mjs +1 -1
  11. package/docs/README.md +8 -6
  12. package/docs/_media/README.action.md +81 -4
  13. package/docs/_media/README.cn.md +8 -6
  14. package/docs/_media/README.engine.md +28 -8
  15. package/docs/classes/CheerioFetchEngine.md +365 -66
  16. package/docs/classes/ClickAction.md +23 -23
  17. package/docs/classes/ExtractAction.md +23 -23
  18. package/docs/classes/FetchAction.md +23 -23
  19. package/docs/classes/FetchEngine.md +321 -64
  20. package/docs/classes/FetchSession.md +118 -21
  21. package/docs/classes/FillAction.md +23 -23
  22. package/docs/classes/GetContentAction.md +23 -23
  23. package/docs/classes/GotoAction.md +23 -23
  24. package/docs/classes/PauseAction.md +23 -23
  25. package/docs/classes/PlaywrightFetchEngine.md +350 -65
  26. package/docs/classes/SubmitAction.md +23 -23
  27. package/docs/classes/WaitForAction.md +23 -23
  28. package/docs/classes/WebFetcher.md +53 -5
  29. package/docs/enumerations/FetchActionResultStatus.md +4 -4
  30. package/docs/functions/fetchWeb.md +2 -2
  31. package/docs/interfaces/BaseFetchActionProperties.md +19 -11
  32. package/docs/interfaces/BaseFetchCollectorActionProperties.md +27 -15
  33. package/docs/interfaces/BaseFetcherProperties.md +34 -26
  34. package/docs/interfaces/DispatchedEngineAction.md +4 -4
  35. package/docs/interfaces/ExtractActionProperties.md +23 -11
  36. package/docs/interfaces/FetchActionInContext.md +32 -15
  37. package/docs/interfaces/FetchActionProperties.md +24 -12
  38. package/docs/interfaces/FetchActionResult.md +6 -6
  39. package/docs/interfaces/FetchContext.md +91 -36
  40. package/docs/interfaces/FetchEngineContext.md +62 -31
  41. package/docs/interfaces/FetchMetadata.md +5 -5
  42. package/docs/interfaces/FetchResponse.md +14 -14
  43. package/docs/interfaces/FetchReturnTypeRegistry.md +7 -7
  44. package/docs/interfaces/FetchSite.md +41 -29
  45. package/docs/interfaces/FetcherOptions.md +40 -28
  46. package/docs/interfaces/GotoActionOptions.md +6 -6
  47. package/docs/interfaces/PendingEngineRequest.md +3 -3
  48. package/docs/interfaces/StorageOptions.md +5 -5
  49. package/docs/interfaces/SubmitActionOptions.md +2 -2
  50. package/docs/interfaces/WaitForActionOptions.md +5 -5
  51. package/docs/type-aliases/BaseFetchActionOptions.md +1 -1
  52. package/docs/type-aliases/BaseFetchCollectorOptions.md +1 -1
  53. package/docs/type-aliases/BrowserEngine.md +1 -1
  54. package/docs/type-aliases/FetchActionCapabilities.md +1 -1
  55. package/docs/type-aliases/FetchActionCapabilityMode.md +1 -1
  56. package/docs/type-aliases/FetchActionOptions.md +1 -1
  57. package/docs/type-aliases/FetchEngineAction.md +1 -1
  58. package/docs/type-aliases/FetchEngineType.md +1 -1
  59. package/docs/type-aliases/FetchReturnType.md +1 -1
  60. package/docs/type-aliases/FetchReturnTypeFor.md +1 -1
  61. package/docs/type-aliases/OnFetchPauseCallback.md +1 -1
  62. package/docs/type-aliases/ResourceType.md +1 -1
  63. package/docs/variables/DefaultFetcherProperties.md +1 -1
  64. package/docs/variables/FetcherOptionKeys.md +1 -1
  65. package/package.json +7 -4
@@ -6,7 +6,15 @@
6
6
 
7
7
  # Interface: FetchContext
8
8
 
9
- Defined in: [packages/web-fetcher/src/core/context.ts:35](https://github.com/isdk/web-fetcher.js/blob/c6694f50698959edc7c0cdb928907e3e0ef9bb70/src/core/context.ts#L35)
9
+ Defined in: [packages/web-fetcher/src/core/context.ts:110](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/core/context.ts#L110)
10
+
11
+ The full execution context for a Web Fetcher session or action batch.
12
+
13
+ ## Remarks
14
+
15
+ This object is the central state container for the fetch operation. It provides
16
+ access to configuration, the event bus, shared outputs, and the execution engine.
17
+ It is passed to every action during execution.
10
18
 
11
19
  ## Extends
12
20
 
@@ -18,7 +26,7 @@ Defined in: [packages/web-fetcher/src/core/context.ts:35](https://github.com/isd
18
26
 
19
27
  > `optional` **antibot**: `boolean`
20
28
 
21
- Defined in: [packages/web-fetcher/src/core/types.ts:68](https://github.com/isdk/web-fetcher.js/blob/c6694f50698959edc7c0cdb928907e3e0ef9bb70/src/core/types.ts#L68)
29
+ Defined in: [packages/web-fetcher/src/core/types.ts:74](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/core/types.ts#L74)
22
30
 
23
31
  #### Inherited from
24
32
 
@@ -30,7 +38,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:68](https://github.com/isdk/
30
38
 
31
39
  > `optional` **blockResources**: `string`[]
32
40
 
33
- Defined in: [packages/web-fetcher/src/core/types.ts:84](https://github.com/isdk/web-fetcher.js/blob/c6694f50698959edc7c0cdb928907e3e0ef9bb70/src/core/types.ts#L84)
41
+ Defined in: [packages/web-fetcher/src/core/types.ts:91](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/core/types.ts#L91)
34
42
 
35
43
  #### Inherited from
36
44
 
@@ -42,7 +50,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:84](https://github.com/isdk/
42
50
 
43
51
  > `optional` **browser**: `object`
44
52
 
45
- Defined in: [packages/web-fetcher/src/core/types.ts:94](https://github.com/isdk/web-fetcher.js/blob/c6694f50698959edc7c0cdb928907e3e0ef9bb70/src/core/types.ts#L94)
53
+ Defined in: [packages/web-fetcher/src/core/types.ts:101](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/core/types.ts#L101)
46
54
 
47
55
  #### engine?
48
56
 
@@ -71,7 +79,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:94](https://github.com/isdk/
71
79
 
72
80
  > `optional` **cookies**: [`Cookie`](Cookie.md)[]
73
81
 
74
- Defined in: [packages/web-fetcher/src/core/types.ts:71](https://github.com/isdk/web-fetcher.js/blob/c6694f50698959edc7c0cdb928907e3e0ef9bb70/src/core/types.ts#L71)
82
+ Defined in: [packages/web-fetcher/src/core/types.ts:78](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/core/types.ts#L78)
75
83
 
76
84
  #### Inherited from
77
85
 
@@ -83,7 +91,21 @@ Defined in: [packages/web-fetcher/src/core/types.ts:71](https://github.com/isdk/
83
91
 
84
92
  > `optional` **currentAction**: [`FetchActionInContext`](FetchActionInContext.md)
85
93
 
86
- Defined in: [packages/web-fetcher/src/core/context.ts:36](https://github.com/isdk/web-fetcher.js/blob/c6694f50698959edc7c0cdb928907e3e0ef9bb70/src/core/context.ts#L36)
94
+ Defined in: [packages/web-fetcher/src/core/context.ts:114](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/core/context.ts#L114)
95
+
96
+ Metadata about the action currently being executed.
97
+
98
+ ***
99
+
100
+ ### debug?
101
+
102
+ > `optional` **debug**: `boolean`
103
+
104
+ Defined in: [packages/web-fetcher/src/core/types.ts:75](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/core/types.ts#L75)
105
+
106
+ #### Inherited from
107
+
108
+ [`FetchEngineContext`](FetchEngineContext.md).[`debug`](FetchEngineContext.md#debug)
87
109
 
88
110
  ***
89
111
 
@@ -91,7 +113,7 @@ Defined in: [packages/web-fetcher/src/core/context.ts:36](https://github.com/isd
91
113
 
92
114
  > `optional` **delayBetweenRequestsMs**: `number`
93
115
 
94
- Defined in: [packages/web-fetcher/src/core/types.ts:115](https://github.com/isdk/web-fetcher.js/blob/c6694f50698959edc7c0cdb928907e3e0ef9bb70/src/core/types.ts#L115)
116
+ Defined in: [packages/web-fetcher/src/core/types.ts:122](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/core/types.ts#L122)
95
117
 
96
118
  #### Inherited from
97
119
 
@@ -103,7 +125,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:115](https://github.com/isdk
103
125
 
104
126
  > `optional` **enableSmart**: `boolean`
105
127
 
106
- Defined in: [packages/web-fetcher/src/core/types.ts:66](https://github.com/isdk/web-fetcher.js/blob/c6694f50698959edc7c0cdb928907e3e0ef9bb70/src/core/types.ts#L66)
128
+ Defined in: [packages/web-fetcher/src/core/types.ts:72](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/core/types.ts#L72)
107
129
 
108
130
  #### Inherited from
109
131
 
@@ -115,7 +137,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:66](https://github.com/isdk/
115
137
 
116
138
  > `optional` **engine**: `string`
117
139
 
118
- Defined in: [packages/web-fetcher/src/core/types.ts:65](https://github.com/isdk/web-fetcher.js/blob/c6694f50698959edc7c0cdb928907e3e0ef9bb70/src/core/types.ts#L65)
140
+ Defined in: [packages/web-fetcher/src/core/types.ts:71](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/core/types.ts#L71)
119
141
 
120
142
  抓取模式
121
143
 
@@ -133,7 +155,9 @@ Defined in: [packages/web-fetcher/src/core/types.ts:65](https://github.com/isdk/
133
155
 
134
156
  > **eventBus**: `EventEmitter`
135
157
 
136
- Defined in: [packages/web-fetcher/src/core/context.ts:48](https://github.com/isdk/web-fetcher.js/blob/c6694f50698959edc7c0cdb928907e3e0ef9bb70/src/core/context.ts#L48)
158
+ Defined in: [packages/web-fetcher/src/core/context.ts:154](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/core/context.ts#L154)
159
+
160
+ The central event bus for publishing and subscribing to session and action events.
137
161
 
138
162
  ***
139
163
 
@@ -141,7 +165,9 @@ Defined in: [packages/web-fetcher/src/core/context.ts:48](https://github.com/isd
141
165
 
142
166
  > `optional` **finalUrl**: `string`
143
167
 
144
- Defined in: [packages/web-fetcher/src/core/context.ts:27](https://github.com/isdk/web-fetcher.js/blob/c6694f50698959edc7c0cdb928907e3e0ef9bb70/src/core/context.ts#L27)
168
+ Defined in: [packages/web-fetcher/src/core/context.ts:85](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/core/context.ts#L85)
169
+
170
+ The final URL after all redirects have been followed.
145
171
 
146
172
  #### Inherited from
147
173
 
@@ -153,7 +179,7 @@ Defined in: [packages/web-fetcher/src/core/context.ts:27](https://github.com/isd
153
179
 
154
180
  > `optional` **headers**: `Record`\<`string`, `string`\>
155
181
 
156
- Defined in: [packages/web-fetcher/src/core/types.ts:70](https://github.com/isdk/web-fetcher.js/blob/c6694f50698959edc7c0cdb928907e3e0ef9bb70/src/core/types.ts#L70)
182
+ Defined in: [packages/web-fetcher/src/core/types.ts:77](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/core/types.ts#L77)
157
183
 
158
184
  #### Inherited from
159
185
 
@@ -165,7 +191,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:70](https://github.com/isdk/
165
191
 
166
192
  > `optional` **http**: `object`
167
193
 
168
- Defined in: [packages/web-fetcher/src/core/types.ts:106](https://github.com/isdk/web-fetcher.js/blob/c6694f50698959edc7c0cdb928907e3e0ef9bb70/src/core/types.ts#L106)
194
+ Defined in: [packages/web-fetcher/src/core/types.ts:113](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/core/types.ts#L113)
169
195
 
170
196
  #### body?
171
197
 
@@ -185,7 +211,9 @@ Defined in: [packages/web-fetcher/src/core/types.ts:106](https://github.com/isdk
185
211
 
186
212
  > **id**: `string`
187
213
 
188
- Defined in: [packages/web-fetcher/src/core/context.ts:25](https://github.com/isdk/web-fetcher.js/blob/c6694f50698959edc7c0cdb928907e3e0ef9bb70/src/core/context.ts#L25)
214
+ Defined in: [packages/web-fetcher/src/core/context.ts:77](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/core/context.ts#L77)
215
+
216
+ Unique identifier for the session or request batch.
189
217
 
190
218
  #### Inherited from
191
219
 
@@ -197,7 +225,7 @@ Defined in: [packages/web-fetcher/src/core/context.ts:25](https://github.com/isd
197
225
 
198
226
  > `optional` **ignoreSslErrors**: `boolean`
199
227
 
200
- Defined in: [packages/web-fetcher/src/core/types.ts:92](https://github.com/isdk/web-fetcher.js/blob/c6694f50698959edc7c0cdb928907e3e0ef9bb70/src/core/types.ts#L92)
228
+ Defined in: [packages/web-fetcher/src/core/types.ts:99](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/core/types.ts#L99)
201
229
 
202
230
  #### Inherited from
203
231
 
@@ -209,7 +237,9 @@ Defined in: [packages/web-fetcher/src/core/types.ts:92](https://github.com/isdk/
209
237
 
210
238
  > **internal**: `FetchContextInteralState`
211
239
 
212
- Defined in: [packages/web-fetcher/src/core/context.ts:46](https://github.com/isdk/web-fetcher.js/blob/c6694f50698959edc7c0cdb928907e3e0ef9bb70/src/core/context.ts#L46)
240
+ Defined in: [packages/web-fetcher/src/core/context.ts:149](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/core/context.ts#L149)
241
+
242
+ Internal state for engine and lifecycle management.
213
243
 
214
244
  #### Overrides
215
245
 
@@ -221,7 +251,9 @@ Defined in: [packages/web-fetcher/src/core/context.ts:46](https://github.com/isd
221
251
 
222
252
  > `optional` **lastResponse**: [`FetchResponse`](FetchResponse.md)
223
253
 
224
- Defined in: [packages/web-fetcher/src/core/context.ts:29](https://github.com/isdk/web-fetcher.js/blob/c6694f50698959edc7c0cdb928907e3e0ef9bb70/src/core/context.ts#L29)
254
+ Defined in: [packages/web-fetcher/src/core/context.ts:90](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/core/context.ts#L90)
255
+
256
+ The standardized response object from the most recent navigation.
225
257
 
226
258
  #### Inherited from
227
259
 
@@ -233,7 +265,9 @@ Defined in: [packages/web-fetcher/src/core/context.ts:29](https://github.com/isd
233
265
 
234
266
  > `optional` **lastResult**: [`FetchActionResult`](FetchActionResult.md)\<[`FetchReturnType`](../type-aliases/FetchReturnType.md)\>
235
267
 
236
- Defined in: [packages/web-fetcher/src/core/context.ts:30](https://github.com/isdk/web-fetcher.js/blob/c6694f50698959edc7c0cdb928907e3e0ef9bb70/src/core/context.ts#L30)
268
+ Defined in: [packages/web-fetcher/src/core/context.ts:94](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/core/context.ts#L94)
269
+
270
+ The result object from the most recent action execution.
237
271
 
238
272
  #### Inherited from
239
273
 
@@ -245,7 +279,7 @@ Defined in: [packages/web-fetcher/src/core/context.ts:30](https://github.com/isd
245
279
 
246
280
  > `optional` **maxConcurrency**: `number`
247
281
 
248
- Defined in: [packages/web-fetcher/src/core/types.ts:113](https://github.com/isdk/web-fetcher.js/blob/c6694f50698959edc7c0cdb928907e3e0ef9bb70/src/core/types.ts#L113)
282
+ Defined in: [packages/web-fetcher/src/core/types.ts:120](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/core/types.ts#L120)
249
283
 
250
284
  #### Inherited from
251
285
 
@@ -257,7 +291,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:113](https://github.com/isdk
257
291
 
258
292
  > `optional` **maxRequestsPerMinute**: `number`
259
293
 
260
- Defined in: [packages/web-fetcher/src/core/types.ts:114](https://github.com/isdk/web-fetcher.js/blob/c6694f50698959edc7c0cdb928907e3e0ef9bb70/src/core/types.ts#L114)
294
+ Defined in: [packages/web-fetcher/src/core/types.ts:121](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/core/types.ts#L121)
261
295
 
262
296
  #### Inherited from
263
297
 
@@ -269,7 +303,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:114](https://github.com/isdk
269
303
 
270
304
  > `optional` **output**: `object`
271
305
 
272
- Defined in: [packages/web-fetcher/src/core/types.ts:77](https://github.com/isdk/web-fetcher.js/blob/c6694f50698959edc7c0cdb928907e3e0ef9bb70/src/core/types.ts#L77)
306
+ Defined in: [packages/web-fetcher/src/core/types.ts:84](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/core/types.ts#L84)
273
307
 
274
308
  #### cookies?
275
309
 
@@ -289,7 +323,10 @@ Defined in: [packages/web-fetcher/src/core/types.ts:77](https://github.com/isdk/
289
323
 
290
324
  > **outputs**: `Record`\<`string`, `any`\>
291
325
 
292
- Defined in: [packages/web-fetcher/src/core/context.ts:38](https://github.com/isdk/web-fetcher.js/blob/c6694f50698959edc7c0cdb928907e3e0ef9bb70/src/core/context.ts#L38)
326
+ Defined in: [packages/web-fetcher/src/core/context.ts:120](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/core/context.ts#L120)
327
+
328
+ A shared key-value store for storing data extracted from pages or
329
+ metadata generated during action execution.
293
330
 
294
331
  ***
295
332
 
@@ -297,7 +334,7 @@ Defined in: [packages/web-fetcher/src/core/context.ts:38](https://github.com/isd
297
334
 
298
335
  > `optional` **overrideSessionState**: `boolean`
299
336
 
300
- Defined in: [packages/web-fetcher/src/core/types.ts:74](https://github.com/isdk/web-fetcher.js/blob/c6694f50698959edc7c0cdb928907e3e0ef9bb70/src/core/types.ts#L74)
337
+ Defined in: [packages/web-fetcher/src/core/types.ts:81](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/core/types.ts#L81)
301
338
 
302
339
  #### Inherited from
303
340
 
@@ -309,7 +346,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:74](https://github.com/isdk/
309
346
 
310
347
  > `optional` **proxy**: `string` \| `string`[]
311
348
 
312
- Defined in: [packages/web-fetcher/src/core/types.ts:82](https://github.com/isdk/web-fetcher.js/blob/c6694f50698959edc7c0cdb928907e3e0ef9bb70/src/core/types.ts#L82)
349
+ Defined in: [packages/web-fetcher/src/core/types.ts:89](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/core/types.ts#L89)
313
350
 
314
351
  #### Inherited from
315
352
 
@@ -321,7 +358,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:82](https://github.com/isdk/
321
358
 
322
359
  > `optional` **requestHandlerTimeoutSecs**: `number`
323
360
 
324
- Defined in: [packages/web-fetcher/src/core/types.ts:112](https://github.com/isdk/web-fetcher.js/blob/c6694f50698959edc7c0cdb928907e3e0ef9bb70/src/core/types.ts#L112)
361
+ Defined in: [packages/web-fetcher/src/core/types.ts:119](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/core/types.ts#L119)
325
362
 
326
363
  #### Inherited from
327
364
 
@@ -333,7 +370,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:112](https://github.com/isdk
333
370
 
334
371
  > `optional` **retries**: `number`
335
372
 
336
- Defined in: [packages/web-fetcher/src/core/types.ts:116](https://github.com/isdk/web-fetcher.js/blob/c6694f50698959edc7c0cdb928907e3e0ef9bb70/src/core/types.ts#L116)
373
+ Defined in: [packages/web-fetcher/src/core/types.ts:123](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/core/types.ts#L123)
337
374
 
338
375
  #### Inherited from
339
376
 
@@ -345,7 +382,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:116](https://github.com/isdk
345
382
 
346
383
  > `optional` **sessionPoolOptions**: `SessionPoolOptions`
347
384
 
348
- Defined in: [packages/web-fetcher/src/core/types.ts:73](https://github.com/isdk/web-fetcher.js/blob/c6694f50698959edc7c0cdb928907e3e0ef9bb70/src/core/types.ts#L73)
385
+ Defined in: [packages/web-fetcher/src/core/types.ts:80](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/core/types.ts#L80)
349
386
 
350
387
  #### Inherited from
351
388
 
@@ -357,7 +394,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:73](https://github.com/isdk/
357
394
 
358
395
  > `optional` **sessionState**: `any`
359
396
 
360
- Defined in: [packages/web-fetcher/src/core/types.ts:72](https://github.com/isdk/web-fetcher.js/blob/c6694f50698959edc7c0cdb928907e3e0ef9bb70/src/core/types.ts#L72)
397
+ Defined in: [packages/web-fetcher/src/core/types.ts:79](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/core/types.ts#L79)
361
398
 
362
399
  #### Inherited from
363
400
 
@@ -369,7 +406,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:72](https://github.com/isdk/
369
406
 
370
407
  > `optional` **sites**: [`FetchSite`](FetchSite.md)[]
371
408
 
372
- Defined in: [packages/web-fetcher/src/core/types.ts:118](https://github.com/isdk/web-fetcher.js/blob/c6694f50698959edc7c0cdb928907e3e0ef9bb70/src/core/types.ts#L118)
409
+ Defined in: [packages/web-fetcher/src/core/types.ts:125](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/core/types.ts#L125)
373
410
 
374
411
  #### Inherited from
375
412
 
@@ -381,7 +418,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:118](https://github.com/isdk
381
418
 
382
419
  > `optional` **storage**: [`StorageOptions`](StorageOptions.md)
383
420
 
384
- Defined in: [packages/web-fetcher/src/core/types.ts:89](https://github.com/isdk/web-fetcher.js/blob/c6694f50698959edc7c0cdb928907e3e0ef9bb70/src/core/types.ts#L89)
421
+ Defined in: [packages/web-fetcher/src/core/types.ts:96](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/core/types.ts#L96)
385
422
 
386
423
  Storage configuration for session isolation and persistence.
387
424
 
@@ -395,7 +432,7 @@ Storage configuration for session isolation and persistence.
395
432
 
396
433
  > `optional` **throwHttpErrors**: `boolean`
397
434
 
398
- Defined in: [packages/web-fetcher/src/core/types.ts:75](https://github.com/isdk/web-fetcher.js/blob/c6694f50698959edc7c0cdb928907e3e0ef9bb70/src/core/types.ts#L75)
435
+ Defined in: [packages/web-fetcher/src/core/types.ts:82](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/core/types.ts#L82)
399
436
 
400
437
  #### Inherited from
401
438
 
@@ -407,7 +444,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:75](https://github.com/isdk/
407
444
 
408
445
  > `optional` **timeoutMs**: `number`
409
446
 
410
- Defined in: [packages/web-fetcher/src/core/types.ts:111](https://github.com/isdk/web-fetcher.js/blob/c6694f50698959edc7c0cdb928907e3e0ef9bb70/src/core/types.ts#L111)
447
+ Defined in: [packages/web-fetcher/src/core/types.ts:118](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/core/types.ts#L118)
411
448
 
412
449
  #### Inherited from
413
450
 
@@ -419,7 +456,9 @@ Defined in: [packages/web-fetcher/src/core/types.ts:111](https://github.com/isdk
419
456
 
420
457
  > `optional` **url**: `string`
421
458
 
422
- Defined in: [packages/web-fetcher/src/core/context.ts:26](https://github.com/isdk/web-fetcher.js/blob/c6694f50698959edc7c0cdb928907e3e0ef9bb70/src/core/context.ts#L26)
459
+ Defined in: [packages/web-fetcher/src/core/context.ts:81](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/core/context.ts#L81)
460
+
461
+ The target URL for the next navigation, if specified.
423
462
 
424
463
  #### Inherited from
425
464
 
@@ -431,7 +470,7 @@ Defined in: [packages/web-fetcher/src/core/context.ts:26](https://github.com/isd
431
470
 
432
471
  > `optional` **useSiteRegistry**: `boolean`
433
472
 
434
- Defined in: [packages/web-fetcher/src/core/types.ts:67](https://github.com/isdk/web-fetcher.js/blob/c6694f50698959edc7c0cdb928907e3e0ef9bb70/src/core/types.ts#L67)
473
+ Defined in: [packages/web-fetcher/src/core/types.ts:73](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/core/types.ts#L73)
435
474
 
436
475
  #### Inherited from
437
476
 
@@ -443,7 +482,9 @@ Defined in: [packages/web-fetcher/src/core/types.ts:67](https://github.com/isdk/
443
482
 
444
483
  > **action**\<`R`\>(`name`, `params?`, `options?`): `Promise`\<[`FetchActionResult`](FetchActionResult.md)\<`R`\>\>
445
484
 
446
- Defined in: [packages/web-fetcher/src/core/context.ts:43](https://github.com/isdk/web-fetcher.js/blob/c6694f50698959edc7c0cdb928907e3e0ef9bb70/src/core/context.ts#L43)
485
+ Defined in: [packages/web-fetcher/src/core/context.ts:140](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/core/context.ts#L140)
486
+
487
+ Convenience method to execute an action by its registered name or ID.
447
488
 
448
489
  #### Type Parameters
449
490
 
@@ -457,25 +498,35 @@ Defined in: [packages/web-fetcher/src/core/context.ts:43](https://github.com/isd
457
498
 
458
499
  `string`
459
500
 
501
+ The registered name or ID of the action.
502
+
460
503
  ##### params?
461
504
 
462
505
  `any`
463
506
 
507
+ Parameters specific to the action type.
508
+
464
509
  ##### options?
465
510
 
466
511
  `Partial`\<`_RequireAtLeastOne`\<[`FetchActionProperties`](FetchActionProperties.md), `"name"` \| `"id"` \| `"action"`\>\>
467
512
 
513
+ Additional execution options (e.g., storeAs, failOnError).
514
+
468
515
  #### Returns
469
516
 
470
517
  `Promise`\<[`FetchActionResult`](FetchActionResult.md)\<`R`\>\>
471
518
 
519
+ A promise that resolves to the action's result.
520
+
472
521
  ***
473
522
 
474
523
  ### execute()
475
524
 
476
525
  > **execute**\<`R`\>(`actionOptions`): `Promise`\<[`FetchActionResult`](FetchActionResult.md)\<`R`\>\>
477
526
 
478
- Defined in: [packages/web-fetcher/src/core/context.ts:41](https://github.com/isdk/web-fetcher.js/blob/c6694f50698959edc7c0cdb928907e3e0ef9bb70/src/core/context.ts#L41)
527
+ Defined in: [packages/web-fetcher/src/core/context.ts:128](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/core/context.ts#L128)
528
+
529
+ Executes a FetchAction within the current context.
479
530
 
480
531
  #### Type Parameters
481
532
 
@@ -489,6 +540,10 @@ Defined in: [packages/web-fetcher/src/core/context.ts:41](https://github.com/isd
489
540
 
490
541
  `_RequireAtLeastOne`
491
542
 
543
+ Configuration for the action to be executed.
544
+
492
545
  #### Returns
493
546
 
494
547
  `Promise`\<[`FetchActionResult`](FetchActionResult.md)\<`R`\>\>
548
+
549
+ A promise that resolves to the action's result.