@isdk/web-fetcher 0.2.0

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 (66) hide show
  1. package/README.action.cn.md +469 -0
  2. package/README.action.md +452 -0
  3. package/README.cn.md +147 -0
  4. package/README.engine.cn.md +262 -0
  5. package/README.engine.md +262 -0
  6. package/README.md +147 -0
  7. package/dist/index.d.mts +1603 -0
  8. package/dist/index.d.ts +1603 -0
  9. package/dist/index.js +1 -0
  10. package/dist/index.mjs +1 -0
  11. package/docs/README.md +151 -0
  12. package/docs/_media/LICENSE-MIT +22 -0
  13. package/docs/_media/README.action.md +452 -0
  14. package/docs/_media/README.cn.md +147 -0
  15. package/docs/_media/README.engine.md +262 -0
  16. package/docs/classes/CheerioFetchEngine.md +1447 -0
  17. package/docs/classes/ClickAction.md +533 -0
  18. package/docs/classes/ExtractAction.md +533 -0
  19. package/docs/classes/FetchAction.md +444 -0
  20. package/docs/classes/FetchEngine.md +1230 -0
  21. package/docs/classes/FetchSession.md +111 -0
  22. package/docs/classes/FillAction.md +533 -0
  23. package/docs/classes/GetContentAction.md +533 -0
  24. package/docs/classes/GotoAction.md +537 -0
  25. package/docs/classes/PauseAction.md +533 -0
  26. package/docs/classes/PlaywrightFetchEngine.md +1437 -0
  27. package/docs/classes/SubmitAction.md +533 -0
  28. package/docs/classes/WaitForAction.md +533 -0
  29. package/docs/classes/WebFetcher.md +85 -0
  30. package/docs/enumerations/FetchActionResultStatus.md +40 -0
  31. package/docs/functions/fetchWeb.md +43 -0
  32. package/docs/globals.md +72 -0
  33. package/docs/interfaces/BaseFetchActionProperties.md +83 -0
  34. package/docs/interfaces/BaseFetchCollectorActionProperties.md +145 -0
  35. package/docs/interfaces/BaseFetcherProperties.md +206 -0
  36. package/docs/interfaces/Cookie.md +142 -0
  37. package/docs/interfaces/DispatchedEngineAction.md +60 -0
  38. package/docs/interfaces/ExtractActionProperties.md +113 -0
  39. package/docs/interfaces/FetchActionInContext.md +149 -0
  40. package/docs/interfaces/FetchActionProperties.md +125 -0
  41. package/docs/interfaces/FetchActionResult.md +55 -0
  42. package/docs/interfaces/FetchContext.md +424 -0
  43. package/docs/interfaces/FetchEngineContext.md +328 -0
  44. package/docs/interfaces/FetchMetadata.md +73 -0
  45. package/docs/interfaces/FetchResponse.md +105 -0
  46. package/docs/interfaces/FetchReturnTypeRegistry.md +57 -0
  47. package/docs/interfaces/FetchSite.md +320 -0
  48. package/docs/interfaces/FetcherOptions.md +300 -0
  49. package/docs/interfaces/GotoActionOptions.md +66 -0
  50. package/docs/interfaces/PendingEngineRequest.md +51 -0
  51. package/docs/interfaces/SubmitActionOptions.md +23 -0
  52. package/docs/interfaces/WaitForActionOptions.md +39 -0
  53. package/docs/type-aliases/BaseFetchActionOptions.md +11 -0
  54. package/docs/type-aliases/BaseFetchCollectorOptions.md +11 -0
  55. package/docs/type-aliases/BrowserEngine.md +11 -0
  56. package/docs/type-aliases/FetchActionCapabilities.md +11 -0
  57. package/docs/type-aliases/FetchActionCapabilityMode.md +11 -0
  58. package/docs/type-aliases/FetchActionOptions.md +11 -0
  59. package/docs/type-aliases/FetchEngineAction.md +18 -0
  60. package/docs/type-aliases/FetchEngineType.md +11 -0
  61. package/docs/type-aliases/FetchReturnType.md +11 -0
  62. package/docs/type-aliases/FetchReturnTypeFor.md +17 -0
  63. package/docs/type-aliases/OnFetchPauseCallback.md +23 -0
  64. package/docs/type-aliases/ResourceType.md +11 -0
  65. package/docs/variables/DefaultFetcherProperties.md +11 -0
  66. package/package.json +90 -0
@@ -0,0 +1,320 @@
1
+ [**@isdk/web-fetcher**](../README.md)
2
+
3
+ ***
4
+
5
+ [@isdk/web-fetcher](../globals.md) / FetchSite
6
+
7
+ # Interface: FetchSite
8
+
9
+ Defined in: [packages/web-fetcher/src/core/types.ts:79](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/core/types.ts#L79)
10
+
11
+ ## Extends
12
+
13
+ - [`BaseFetcherProperties`](BaseFetcherProperties.md)
14
+
15
+ ## Properties
16
+
17
+ ### antibot?
18
+
19
+ > `optional` **antibot**: `boolean`
20
+
21
+ Defined in: [packages/web-fetcher/src/core/types.ts:37](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/core/types.ts#L37)
22
+
23
+ #### Inherited from
24
+
25
+ [`BaseFetcherProperties`](BaseFetcherProperties.md).[`antibot`](BaseFetcherProperties.md#antibot)
26
+
27
+ ***
28
+
29
+ ### blockResources?
30
+
31
+ > `optional` **blockResources**: `string`[]
32
+
33
+ Defined in: [packages/web-fetcher/src/core/types.ts:46](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/core/types.ts#L46)
34
+
35
+ #### Inherited from
36
+
37
+ [`BaseFetcherProperties`](BaseFetcherProperties.md).[`blockResources`](BaseFetcherProperties.md#blockresources)
38
+
39
+ ***
40
+
41
+ ### browser?
42
+
43
+ > `optional` **browser**: `object`
44
+
45
+ Defined in: [packages/web-fetcher/src/core/types.ts:52](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/core/types.ts#L52)
46
+
47
+ #### engine?
48
+
49
+ > `optional` **engine**: [`BrowserEngine`](../type-aliases/BrowserEngine.md)
50
+
51
+ 浏览器引擎,默认为 playwright
52
+
53
+ - `playwright`: 使用 Playwright 引擎
54
+ - `puppeteer`: 使用 Puppeteer 引擎
55
+
56
+ #### headless?
57
+
58
+ > `optional` **headless**: `boolean`
59
+
60
+ #### waitUntil?
61
+
62
+ > `optional` **waitUntil**: `"load"` \| `"domcontentloaded"` \| `"networkidle"` \| `"commit"`
63
+
64
+ #### Inherited from
65
+
66
+ [`BaseFetcherProperties`](BaseFetcherProperties.md).[`browser`](BaseFetcherProperties.md#browser)
67
+
68
+ ***
69
+
70
+ ### cookies?
71
+
72
+ > `optional` **cookies**: [`Cookie`](Cookie.md)[]
73
+
74
+ Defined in: [packages/web-fetcher/src/core/types.ts:40](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/core/types.ts#L40)
75
+
76
+ #### Inherited from
77
+
78
+ [`BaseFetcherProperties`](BaseFetcherProperties.md).[`cookies`](BaseFetcherProperties.md#cookies)
79
+
80
+ ***
81
+
82
+ ### delayBetweenRequestsMs?
83
+
84
+ > `optional` **delayBetweenRequestsMs**: `number`
85
+
86
+ Defined in: [packages/web-fetcher/src/core/types.ts:72](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/core/types.ts#L72)
87
+
88
+ #### Inherited from
89
+
90
+ [`BaseFetcherProperties`](BaseFetcherProperties.md).[`delayBetweenRequestsMs`](BaseFetcherProperties.md#delaybetweenrequestsms)
91
+
92
+ ***
93
+
94
+ ### domain
95
+
96
+ > **domain**: `string`
97
+
98
+ Defined in: [packages/web-fetcher/src/core/types.ts:80](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/core/types.ts#L80)
99
+
100
+ ***
101
+
102
+ ### enableSmart?
103
+
104
+ > `optional` **enableSmart**: `boolean`
105
+
106
+ Defined in: [packages/web-fetcher/src/core/types.ts:35](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/core/types.ts#L35)
107
+
108
+ #### Inherited from
109
+
110
+ [`BaseFetcherProperties`](BaseFetcherProperties.md).[`enableSmart`](BaseFetcherProperties.md#enablesmart)
111
+
112
+ ***
113
+
114
+ ### engine?
115
+
116
+ > `optional` **engine**: `string`
117
+
118
+ Defined in: [packages/web-fetcher/src/core/types.ts:34](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/core/types.ts#L34)
119
+
120
+ 抓取模式
121
+
122
+ - `http`: 使用 HTTP 进行抓取
123
+ - `browser`: 使用浏览器进行抓取
124
+ - `auto`: auto 会走“智能探测”选择 http 或 browser, 但是如果没有启用 smart,并且在站点注册表中没有,那么则等价为 http.
125
+
126
+ #### Inherited from
127
+
128
+ [`BaseFetcherProperties`](BaseFetcherProperties.md).[`engine`](BaseFetcherProperties.md#engine)
129
+
130
+ ***
131
+
132
+ ### headers?
133
+
134
+ > `optional` **headers**: `Record`\<`string`, `string`\>
135
+
136
+ Defined in: [packages/web-fetcher/src/core/types.ts:39](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/core/types.ts#L39)
137
+
138
+ #### Inherited from
139
+
140
+ [`BaseFetcherProperties`](BaseFetcherProperties.md).[`headers`](BaseFetcherProperties.md#headers)
141
+
142
+ ***
143
+
144
+ ### http?
145
+
146
+ > `optional` **http**: `object`
147
+
148
+ Defined in: [packages/web-fetcher/src/core/types.ts:64](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/core/types.ts#L64)
149
+
150
+ #### body?
151
+
152
+ > `optional` **body**: `any`
153
+
154
+ #### method?
155
+
156
+ > `optional` **method**: `"GET"` \| `"POST"` \| `"PUT"` \| `"DELETE"` \| `"PATCH"`
157
+
158
+ #### Inherited from
159
+
160
+ [`BaseFetcherProperties`](BaseFetcherProperties.md).[`http`](BaseFetcherProperties.md#http)
161
+
162
+ ***
163
+
164
+ ### ignoreSslErrors?
165
+
166
+ > `optional` **ignoreSslErrors**: `boolean`
167
+
168
+ Defined in: [packages/web-fetcher/src/core/types.ts:50](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/core/types.ts#L50)
169
+
170
+ #### Inherited from
171
+
172
+ [`BaseFetcherProperties`](BaseFetcherProperties.md).[`ignoreSslErrors`](BaseFetcherProperties.md#ignoresslerrors)
173
+
174
+ ***
175
+
176
+ ### maxConcurrency?
177
+
178
+ > `optional` **maxConcurrency**: `number`
179
+
180
+ Defined in: [packages/web-fetcher/src/core/types.ts:70](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/core/types.ts#L70)
181
+
182
+ #### Inherited from
183
+
184
+ [`BaseFetcherProperties`](BaseFetcherProperties.md).[`maxConcurrency`](BaseFetcherProperties.md#maxconcurrency)
185
+
186
+ ***
187
+
188
+ ### maxRequestsPerMinute?
189
+
190
+ > `optional` **maxRequestsPerMinute**: `number`
191
+
192
+ Defined in: [packages/web-fetcher/src/core/types.ts:71](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/core/types.ts#L71)
193
+
194
+ #### Inherited from
195
+
196
+ [`BaseFetcherProperties`](BaseFetcherProperties.md).[`maxRequestsPerMinute`](BaseFetcherProperties.md#maxrequestsperminute)
197
+
198
+ ***
199
+
200
+ ### meta?
201
+
202
+ > `optional` **meta**: `object`
203
+
204
+ Defined in: [packages/web-fetcher/src/core/types.ts:83](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/core/types.ts#L83)
205
+
206
+ #### source?
207
+
208
+ > `optional` **source**: `"manual"` \| `"smart"`
209
+
210
+ #### ttlMs?
211
+
212
+ > `optional` **ttlMs**: `number`
213
+
214
+ #### updatedAt?
215
+
216
+ > `optional` **updatedAt**: `number`
217
+
218
+ ***
219
+
220
+ ### pathScope?
221
+
222
+ > `optional` **pathScope**: `string`[]
223
+
224
+ Defined in: [packages/web-fetcher/src/core/types.ts:81](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/core/types.ts#L81)
225
+
226
+ ***
227
+
228
+ ### proxy?
229
+
230
+ > `optional` **proxy**: `string` \| `string`[]
231
+
232
+ Defined in: [packages/web-fetcher/src/core/types.ts:44](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/core/types.ts#L44)
233
+
234
+ #### Inherited from
235
+
236
+ [`BaseFetcherProperties`](BaseFetcherProperties.md).[`proxy`](BaseFetcherProperties.md#proxy)
237
+
238
+ ***
239
+
240
+ ### retries?
241
+
242
+ > `optional` **retries**: `number`
243
+
244
+ Defined in: [packages/web-fetcher/src/core/types.ts:73](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/core/types.ts#L73)
245
+
246
+ #### Inherited from
247
+
248
+ [`BaseFetcherProperties`](BaseFetcherProperties.md).[`retries`](BaseFetcherProperties.md#retries)
249
+
250
+ ***
251
+
252
+ ### reuseCookies?
253
+
254
+ > `optional` **reuseCookies**: `boolean`
255
+
256
+ Defined in: [packages/web-fetcher/src/core/types.ts:41](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/core/types.ts#L41)
257
+
258
+ #### Inherited from
259
+
260
+ [`BaseFetcherProperties`](BaseFetcherProperties.md).[`reuseCookies`](BaseFetcherProperties.md#reusecookies)
261
+
262
+ ***
263
+
264
+ ### sites?
265
+
266
+ > `optional` **sites**: `FetchSite`[]
267
+
268
+ Defined in: [packages/web-fetcher/src/core/types.ts:75](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/core/types.ts#L75)
269
+
270
+ #### Inherited from
271
+
272
+ [`BaseFetcherProperties`](BaseFetcherProperties.md).[`sites`](BaseFetcherProperties.md#sites)
273
+
274
+ ***
275
+
276
+ ### throwHttpErrors?
277
+
278
+ > `optional` **throwHttpErrors**: `boolean`
279
+
280
+ Defined in: [packages/web-fetcher/src/core/types.ts:42](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/core/types.ts#L42)
281
+
282
+ #### Inherited from
283
+
284
+ [`BaseFetcherProperties`](BaseFetcherProperties.md).[`throwHttpErrors`](BaseFetcherProperties.md#throwhttperrors)
285
+
286
+ ***
287
+
288
+ ### timeoutMs?
289
+
290
+ > `optional` **timeoutMs**: `number`
291
+
292
+ Defined in: [packages/web-fetcher/src/core/types.ts:69](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/core/types.ts#L69)
293
+
294
+ #### Inherited from
295
+
296
+ [`BaseFetcherProperties`](BaseFetcherProperties.md).[`timeoutMs`](BaseFetcherProperties.md#timeoutms)
297
+
298
+ ***
299
+
300
+ ### url?
301
+
302
+ > `optional` **url**: `string`
303
+
304
+ Defined in: [packages/web-fetcher/src/core/types.ts:76](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/core/types.ts#L76)
305
+
306
+ #### Inherited from
307
+
308
+ [`BaseFetcherProperties`](BaseFetcherProperties.md).[`url`](BaseFetcherProperties.md#url)
309
+
310
+ ***
311
+
312
+ ### useSiteRegistry?
313
+
314
+ > `optional` **useSiteRegistry**: `boolean`
315
+
316
+ Defined in: [packages/web-fetcher/src/core/types.ts:36](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/core/types.ts#L36)
317
+
318
+ #### Inherited from
319
+
320
+ [`BaseFetcherProperties`](BaseFetcherProperties.md).[`useSiteRegistry`](BaseFetcherProperties.md#usesiteregistry)
@@ -0,0 +1,300 @@
1
+ [**@isdk/web-fetcher**](../README.md)
2
+
3
+ ***
4
+
5
+ [@isdk/web-fetcher](../globals.md) / FetcherOptions
6
+
7
+ # Interface: FetcherOptions
8
+
9
+ Defined in: [packages/web-fetcher/src/core/types.ts:94](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/core/types.ts#L94)
10
+
11
+ ## Extends
12
+
13
+ - [`BaseFetcherProperties`](BaseFetcherProperties.md)
14
+
15
+ ## Properties
16
+
17
+ ### actions?
18
+
19
+ > `optional` **actions**: `_RequireAtLeastOne`\<[`FetchActionProperties`](FetchActionProperties.md), `"name"` \| `"id"`\>[]
20
+
21
+ Defined in: [packages/web-fetcher/src/core/types.ts:95](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/core/types.ts#L95)
22
+
23
+ ***
24
+
25
+ ### antibot?
26
+
27
+ > `optional` **antibot**: `boolean`
28
+
29
+ Defined in: [packages/web-fetcher/src/core/types.ts:37](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/core/types.ts#L37)
30
+
31
+ #### Inherited from
32
+
33
+ [`BaseFetcherProperties`](BaseFetcherProperties.md).[`antibot`](BaseFetcherProperties.md#antibot)
34
+
35
+ ***
36
+
37
+ ### blockResources?
38
+
39
+ > `optional` **blockResources**: `string`[]
40
+
41
+ Defined in: [packages/web-fetcher/src/core/types.ts:46](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/core/types.ts#L46)
42
+
43
+ #### Inherited from
44
+
45
+ [`BaseFetcherProperties`](BaseFetcherProperties.md).[`blockResources`](BaseFetcherProperties.md#blockresources)
46
+
47
+ ***
48
+
49
+ ### browser?
50
+
51
+ > `optional` **browser**: `object`
52
+
53
+ Defined in: [packages/web-fetcher/src/core/types.ts:52](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/core/types.ts#L52)
54
+
55
+ #### engine?
56
+
57
+ > `optional` **engine**: [`BrowserEngine`](../type-aliases/BrowserEngine.md)
58
+
59
+ 浏览器引擎,默认为 playwright
60
+
61
+ - `playwright`: 使用 Playwright 引擎
62
+ - `puppeteer`: 使用 Puppeteer 引擎
63
+
64
+ #### headless?
65
+
66
+ > `optional` **headless**: `boolean`
67
+
68
+ #### waitUntil?
69
+
70
+ > `optional` **waitUntil**: `"load"` \| `"domcontentloaded"` \| `"networkidle"` \| `"commit"`
71
+
72
+ #### Inherited from
73
+
74
+ [`BaseFetcherProperties`](BaseFetcherProperties.md).[`browser`](BaseFetcherProperties.md#browser)
75
+
76
+ ***
77
+
78
+ ### cookies?
79
+
80
+ > `optional` **cookies**: [`Cookie`](Cookie.md)[]
81
+
82
+ Defined in: [packages/web-fetcher/src/core/types.ts:40](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/core/types.ts#L40)
83
+
84
+ #### Inherited from
85
+
86
+ [`BaseFetcherProperties`](BaseFetcherProperties.md).[`cookies`](BaseFetcherProperties.md#cookies)
87
+
88
+ ***
89
+
90
+ ### delayBetweenRequestsMs?
91
+
92
+ > `optional` **delayBetweenRequestsMs**: `number`
93
+
94
+ Defined in: [packages/web-fetcher/src/core/types.ts:72](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/core/types.ts#L72)
95
+
96
+ #### Inherited from
97
+
98
+ [`BaseFetcherProperties`](BaseFetcherProperties.md).[`delayBetweenRequestsMs`](BaseFetcherProperties.md#delaybetweenrequestsms)
99
+
100
+ ***
101
+
102
+ ### enableSmart?
103
+
104
+ > `optional` **enableSmart**: `boolean`
105
+
106
+ Defined in: [packages/web-fetcher/src/core/types.ts:35](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/core/types.ts#L35)
107
+
108
+ #### Inherited from
109
+
110
+ [`BaseFetcherProperties`](BaseFetcherProperties.md).[`enableSmart`](BaseFetcherProperties.md#enablesmart)
111
+
112
+ ***
113
+
114
+ ### engine?
115
+
116
+ > `optional` **engine**: `string`
117
+
118
+ Defined in: [packages/web-fetcher/src/core/types.ts:34](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/core/types.ts#L34)
119
+
120
+ 抓取模式
121
+
122
+ - `http`: 使用 HTTP 进行抓取
123
+ - `browser`: 使用浏览器进行抓取
124
+ - `auto`: auto 会走“智能探测”选择 http 或 browser, 但是如果没有启用 smart,并且在站点注册表中没有,那么则等价为 http.
125
+
126
+ #### Inherited from
127
+
128
+ [`BaseFetcherProperties`](BaseFetcherProperties.md).[`engine`](BaseFetcherProperties.md#engine)
129
+
130
+ ***
131
+
132
+ ### headers?
133
+
134
+ > `optional` **headers**: `Record`\<`string`, `string`\>
135
+
136
+ Defined in: [packages/web-fetcher/src/core/types.ts:39](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/core/types.ts#L39)
137
+
138
+ #### Inherited from
139
+
140
+ [`BaseFetcherProperties`](BaseFetcherProperties.md).[`headers`](BaseFetcherProperties.md#headers)
141
+
142
+ ***
143
+
144
+ ### http?
145
+
146
+ > `optional` **http**: `object`
147
+
148
+ Defined in: [packages/web-fetcher/src/core/types.ts:64](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/core/types.ts#L64)
149
+
150
+ #### body?
151
+
152
+ > `optional` **body**: `any`
153
+
154
+ #### method?
155
+
156
+ > `optional` **method**: `"GET"` \| `"POST"` \| `"PUT"` \| `"DELETE"` \| `"PATCH"`
157
+
158
+ #### Inherited from
159
+
160
+ [`BaseFetcherProperties`](BaseFetcherProperties.md).[`http`](BaseFetcherProperties.md#http)
161
+
162
+ ***
163
+
164
+ ### ignoreSslErrors?
165
+
166
+ > `optional` **ignoreSslErrors**: `boolean`
167
+
168
+ Defined in: [packages/web-fetcher/src/core/types.ts:50](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/core/types.ts#L50)
169
+
170
+ #### Inherited from
171
+
172
+ [`BaseFetcherProperties`](BaseFetcherProperties.md).[`ignoreSslErrors`](BaseFetcherProperties.md#ignoresslerrors)
173
+
174
+ ***
175
+
176
+ ### maxConcurrency?
177
+
178
+ > `optional` **maxConcurrency**: `number`
179
+
180
+ Defined in: [packages/web-fetcher/src/core/types.ts:70](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/core/types.ts#L70)
181
+
182
+ #### Inherited from
183
+
184
+ [`BaseFetcherProperties`](BaseFetcherProperties.md).[`maxConcurrency`](BaseFetcherProperties.md#maxconcurrency)
185
+
186
+ ***
187
+
188
+ ### maxRequestsPerMinute?
189
+
190
+ > `optional` **maxRequestsPerMinute**: `number`
191
+
192
+ Defined in: [packages/web-fetcher/src/core/types.ts:71](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/core/types.ts#L71)
193
+
194
+ #### Inherited from
195
+
196
+ [`BaseFetcherProperties`](BaseFetcherProperties.md).[`maxRequestsPerMinute`](BaseFetcherProperties.md#maxrequestsperminute)
197
+
198
+ ***
199
+
200
+ ### onPause?
201
+
202
+ > `optional` **onPause**: [`OnFetchPauseCallback`](../type-aliases/OnFetchPauseCallback.md)
203
+
204
+ Defined in: [packages/web-fetcher/src/core/types.ts:96](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/core/types.ts#L96)
205
+
206
+ ***
207
+
208
+ ### proxy?
209
+
210
+ > `optional` **proxy**: `string` \| `string`[]
211
+
212
+ Defined in: [packages/web-fetcher/src/core/types.ts:44](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/core/types.ts#L44)
213
+
214
+ #### Inherited from
215
+
216
+ [`BaseFetcherProperties`](BaseFetcherProperties.md).[`proxy`](BaseFetcherProperties.md#proxy)
217
+
218
+ ***
219
+
220
+ ### retries?
221
+
222
+ > `optional` **retries**: `number`
223
+
224
+ Defined in: [packages/web-fetcher/src/core/types.ts:73](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/core/types.ts#L73)
225
+
226
+ #### Inherited from
227
+
228
+ [`BaseFetcherProperties`](BaseFetcherProperties.md).[`retries`](BaseFetcherProperties.md#retries)
229
+
230
+ ***
231
+
232
+ ### reuseCookies?
233
+
234
+ > `optional` **reuseCookies**: `boolean`
235
+
236
+ Defined in: [packages/web-fetcher/src/core/types.ts:41](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/core/types.ts#L41)
237
+
238
+ #### Inherited from
239
+
240
+ [`BaseFetcherProperties`](BaseFetcherProperties.md).[`reuseCookies`](BaseFetcherProperties.md#reusecookies)
241
+
242
+ ***
243
+
244
+ ### sites?
245
+
246
+ > `optional` **sites**: [`FetchSite`](FetchSite.md)[]
247
+
248
+ Defined in: [packages/web-fetcher/src/core/types.ts:75](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/core/types.ts#L75)
249
+
250
+ #### Inherited from
251
+
252
+ [`BaseFetcherProperties`](BaseFetcherProperties.md).[`sites`](BaseFetcherProperties.md#sites)
253
+
254
+ ***
255
+
256
+ ### throwHttpErrors?
257
+
258
+ > `optional` **throwHttpErrors**: `boolean`
259
+
260
+ Defined in: [packages/web-fetcher/src/core/types.ts:42](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/core/types.ts#L42)
261
+
262
+ #### Inherited from
263
+
264
+ [`BaseFetcherProperties`](BaseFetcherProperties.md).[`throwHttpErrors`](BaseFetcherProperties.md#throwhttperrors)
265
+
266
+ ***
267
+
268
+ ### timeoutMs?
269
+
270
+ > `optional` **timeoutMs**: `number`
271
+
272
+ Defined in: [packages/web-fetcher/src/core/types.ts:69](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/core/types.ts#L69)
273
+
274
+ #### Inherited from
275
+
276
+ [`BaseFetcherProperties`](BaseFetcherProperties.md).[`timeoutMs`](BaseFetcherProperties.md#timeoutms)
277
+
278
+ ***
279
+
280
+ ### url?
281
+
282
+ > `optional` **url**: `string`
283
+
284
+ Defined in: [packages/web-fetcher/src/core/types.ts:76](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/core/types.ts#L76)
285
+
286
+ #### Inherited from
287
+
288
+ [`BaseFetcherProperties`](BaseFetcherProperties.md).[`url`](BaseFetcherProperties.md#url)
289
+
290
+ ***
291
+
292
+ ### useSiteRegistry?
293
+
294
+ > `optional` **useSiteRegistry**: `boolean`
295
+
296
+ Defined in: [packages/web-fetcher/src/core/types.ts:36](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/core/types.ts#L36)
297
+
298
+ #### Inherited from
299
+
300
+ [`BaseFetcherProperties`](BaseFetcherProperties.md).[`useSiteRegistry`](BaseFetcherProperties.md#usesiteregistry)
@@ -0,0 +1,66 @@
1
+ [**@isdk/web-fetcher**](../README.md)
2
+
3
+ ***
4
+
5
+ [@isdk/web-fetcher](../globals.md) / GotoActionOptions
6
+
7
+ # Interface: GotoActionOptions
8
+
9
+ Defined in: [packages/web-fetcher/src/engine/base.ts:41](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/engine/base.ts#L41)
10
+
11
+ Options for the [FetchEngine.goto](../classes/FetchEngine.md#goto), allowing configuration of HTTP method, payload, headers, and navigation behavior.
12
+
13
+ ## Remarks
14
+
15
+ Used when navigating to a URL to specify additional parameters beyond the basic URL.
16
+
17
+ ## Example
18
+
19
+ ```ts
20
+ await engine.goto('https://example.com', {
21
+ method: 'POST',
22
+ payload: { username: 'user', password: 'pass' },
23
+ headers: { 'Content-Type': 'application/json' },
24
+ waitUntil: 'networkidle'
25
+ });
26
+ ```
27
+
28
+ ## Properties
29
+
30
+ ### headers?
31
+
32
+ > `optional` **headers**: `Record`\<`string`, `string`\>
33
+
34
+ Defined in: [packages/web-fetcher/src/engine/base.ts:44](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/engine/base.ts#L44)
35
+
36
+ ***
37
+
38
+ ### method?
39
+
40
+ > `optional` **method**: `"GET"` \| `"HEAD"` \| `"POST"` \| `"PUT"` \| `"DELETE"` \| `"TRACE"` \| `"OPTIONS"` \| `"CONNECT"` \| `"PATCH"`
41
+
42
+ Defined in: [packages/web-fetcher/src/engine/base.ts:42](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/engine/base.ts#L42)
43
+
44
+ ***
45
+
46
+ ### payload?
47
+
48
+ > `optional` **payload**: `any`
49
+
50
+ Defined in: [packages/web-fetcher/src/engine/base.ts:43](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/engine/base.ts#L43)
51
+
52
+ ***
53
+
54
+ ### timeoutMs?
55
+
56
+ > `optional` **timeoutMs**: `number`
57
+
58
+ Defined in: [packages/web-fetcher/src/engine/base.ts:46](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/engine/base.ts#L46)
59
+
60
+ ***
61
+
62
+ ### waitUntil?
63
+
64
+ > `optional` **waitUntil**: `"load"` \| `"domcontentloaded"` \| `"networkidle"` \| `"commit"`
65
+
66
+ Defined in: [packages/web-fetcher/src/engine/base.ts:45](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/engine/base.ts#L45)