@isdk/web-fetcher 0.3.1 → 0.3.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.action.cn.md +28 -4
- package/README.action.md +27 -4
- package/README.cn.md +21 -0
- package/README.engine.cn.md +35 -7
- package/README.engine.md +30 -2
- package/README.md +23 -1
- package/dist/index.d.mts +1571 -1448
- package/dist/index.d.ts +1571 -1448
- package/dist/index.js +1 -1
- package/dist/index.mjs +1 -1
- package/docs/README.md +23 -1
- package/docs/_media/README.action.md +27 -4
- package/docs/_media/README.cn.md +21 -0
- package/docs/_media/README.engine.md +30 -2
- package/docs/classes/CheerioFetchEngine.md +169 -93
- package/docs/classes/ClickAction.md +29 -29
- package/docs/classes/EngineUpgradeError.md +335 -0
- package/docs/classes/EvaluateAction.md +29 -29
- package/docs/classes/ExtractAction.md +29 -29
- package/docs/classes/FetchAction.md +31 -29
- package/docs/classes/FetchEngine.md +159 -91
- package/docs/classes/FetchSession.md +14 -14
- package/docs/classes/FillAction.md +29 -29
- package/docs/classes/GetContentAction.md +29 -29
- package/docs/classes/GotoAction.md +29 -29
- package/docs/classes/KeyboardPressAction.md +29 -29
- package/docs/classes/KeyboardTypeAction.md +29 -29
- package/docs/classes/MouseClickAction.md +29 -29
- package/docs/classes/MouseMoveAction.md +29 -29
- package/docs/classes/MouseWheelAction.md +533 -0
- package/docs/classes/PauseAction.md +29 -29
- package/docs/classes/PlaywrightFetchEngine.md +252 -118
- package/docs/classes/ScrollIntoViewAction.md +533 -0
- package/docs/classes/SubmitAction.md +29 -29
- package/docs/classes/TrimAction.md +29 -29
- package/docs/classes/WaitForAction.md +29 -29
- package/docs/classes/WebFetcher.md +5 -5
- package/docs/enumerations/FetchActionResultStatus.md +4 -4
- package/docs/functions/fetchWeb.md +2 -2
- package/docs/functions/getRandomDelay.md +25 -0
- package/docs/globals.md +8 -1
- package/docs/interfaces/BaseFetchActionProperties.md +13 -13
- package/docs/interfaces/BaseFetchCollectorActionProperties.md +17 -17
- package/docs/interfaces/BaseFetcherProperties.md +44 -28
- package/docs/interfaces/DispatchedEngineAction.md +4 -4
- package/docs/interfaces/EvaluateActionOptions.md +3 -3
- package/docs/interfaces/ExtractActionProperties.md +13 -13
- package/docs/interfaces/FetchActionMeta.md +73 -0
- package/docs/interfaces/FetchActionProperties.md +15 -19
- package/docs/interfaces/FetchActionResult.md +7 -7
- package/docs/interfaces/FetchContext.md +65 -41
- package/docs/interfaces/FetchEngineContext.md +57 -33
- package/docs/interfaces/FetchMetadata.md +5 -5
- package/docs/interfaces/FetchResponse.md +14 -14
- package/docs/interfaces/FetchReturnTypeRegistry.md +7 -7
- package/docs/interfaces/FetchSite.md +55 -31
- package/docs/interfaces/FetcherOptions.md +55 -31
- package/docs/interfaces/GotoActionOptions.md +8 -8
- package/docs/interfaces/KeyboardPressParams.md +3 -3
- package/docs/interfaces/KeyboardTypeParams.md +3 -3
- package/docs/interfaces/MouseClickParams.md +6 -6
- package/docs/interfaces/MouseMoveParams.md +5 -5
- package/docs/interfaces/MouseWheelParams.md +69 -0
- package/docs/interfaces/PendingEngineRequest.md +3 -3
- package/docs/interfaces/ScrollIntoViewParams.md +17 -0
- package/docs/interfaces/StorageOptions.md +5 -5
- package/docs/interfaces/SubmitActionOptions.md +2 -2
- package/docs/interfaces/TrimActionOptions.md +3 -3
- package/docs/interfaces/WaitForActionOptions.md +5 -5
- package/docs/type-aliases/BaseFetchActionOptions.md +1 -1
- package/docs/type-aliases/BaseFetchCollectorOptions.md +1 -1
- package/docs/type-aliases/BrowserEngine.md +1 -1
- package/docs/type-aliases/FetchActionCapabilities.md +1 -1
- package/docs/type-aliases/FetchActionCapabilityMode.md +1 -1
- package/docs/type-aliases/FetchActionInContext.md +38 -0
- package/docs/type-aliases/FetchActionOptions.md +1 -1
- package/docs/type-aliases/FetchEngineAction.md +2 -2
- package/docs/type-aliases/FetchEngineType.md +1 -1
- package/docs/type-aliases/FetchReturnType.md +1 -1
- package/docs/type-aliases/FetchReturnTypeFor.md +1 -1
- package/docs/type-aliases/OnFetchPauseCallback.md +1 -1
- package/docs/type-aliases/ResourceType.md +1 -1
- package/docs/type-aliases/TrimPreset.md +1 -1
- package/docs/variables/DefaultFetcherProperties.md +1 -1
- package/docs/variables/FetcherOptionKeys.md +1 -1
- package/docs/variables/TRIM_PRESETS.md +1 -1
- package/package.json +7 -7
- package/docs/interfaces/FetchActionInContext.md +0 -190
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: FetchEngineContext
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/web-fetcher/src/core/context.ts:
|
|
9
|
+
Defined in: [packages/web-fetcher/src/core/context.ts:72](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/context.ts#L72)
|
|
10
10
|
|
|
11
11
|
Context provided to the Fetch Engine during navigation and request handling.
|
|
12
12
|
|
|
@@ -29,7 +29,7 @@ to perform a fetch operation and build a response.
|
|
|
29
29
|
|
|
30
30
|
> `optional` **antibot**: `boolean`
|
|
31
31
|
|
|
32
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
32
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:159](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L159)
|
|
33
33
|
|
|
34
34
|
#### Inherited from
|
|
35
35
|
|
|
@@ -41,7 +41,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:74](https://github.com/isdk/
|
|
|
41
41
|
|
|
42
42
|
> `optional` **blockResources**: `string`[]
|
|
43
43
|
|
|
44
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
44
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:176](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L176)
|
|
45
45
|
|
|
46
46
|
#### Inherited from
|
|
47
47
|
|
|
@@ -53,7 +53,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:91](https://github.com/isdk/
|
|
|
53
53
|
|
|
54
54
|
> `optional` **browser**: `object`
|
|
55
55
|
|
|
56
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
56
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:186](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L186)
|
|
57
57
|
|
|
58
58
|
#### engine?
|
|
59
59
|
|
|
@@ -86,7 +86,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:101](https://github.com/isdk
|
|
|
86
86
|
|
|
87
87
|
> `optional` **cookies**: [`Cookie`](Cookie.md)[]
|
|
88
88
|
|
|
89
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
89
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:163](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L163)
|
|
90
90
|
|
|
91
91
|
#### Inherited from
|
|
92
92
|
|
|
@@ -98,7 +98,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:78](https://github.com/isdk/
|
|
|
98
98
|
|
|
99
99
|
> `optional` **debug**: `string` \| `boolean` \| `string`[]
|
|
100
100
|
|
|
101
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
101
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:160](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L160)
|
|
102
102
|
|
|
103
103
|
#### Inherited from
|
|
104
104
|
|
|
@@ -110,7 +110,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:75](https://github.com/isdk/
|
|
|
110
110
|
|
|
111
111
|
> `optional` **delayBetweenRequestsMs**: `number`
|
|
112
112
|
|
|
113
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
113
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:208](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L208)
|
|
114
114
|
|
|
115
115
|
#### Inherited from
|
|
116
116
|
|
|
@@ -122,7 +122,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:123](https://github.com/isdk
|
|
|
122
122
|
|
|
123
123
|
> `optional` **enableSmart**: `boolean`
|
|
124
124
|
|
|
125
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
125
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:155](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L155)
|
|
126
126
|
|
|
127
127
|
#### Inherited from
|
|
128
128
|
|
|
@@ -134,7 +134,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:72](https://github.com/isdk/
|
|
|
134
134
|
|
|
135
135
|
> `optional` **engine**: `string`
|
|
136
136
|
|
|
137
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
137
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:154](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L154)
|
|
138
138
|
|
|
139
139
|
抓取模式
|
|
140
140
|
|
|
@@ -152,7 +152,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:71](https://github.com/isdk/
|
|
|
152
152
|
|
|
153
153
|
> `optional` **finalUrl**: `string`
|
|
154
154
|
|
|
155
|
-
Defined in: [packages/web-fetcher/src/core/context.ts:
|
|
155
|
+
Defined in: [packages/web-fetcher/src/core/context.ts:84](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/context.ts#L84)
|
|
156
156
|
|
|
157
157
|
The final URL after all redirects have been followed.
|
|
158
158
|
|
|
@@ -162,7 +162,7 @@ The final URL after all redirects have been followed.
|
|
|
162
162
|
|
|
163
163
|
> `optional` **headers**: `Record`\<`string`, `string`\>
|
|
164
164
|
|
|
165
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
165
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:162](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L162)
|
|
166
166
|
|
|
167
167
|
#### Inherited from
|
|
168
168
|
|
|
@@ -174,7 +174,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:77](https://github.com/isdk/
|
|
|
174
174
|
|
|
175
175
|
> `optional` **http**: `object`
|
|
176
176
|
|
|
177
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
177
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:199](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L199)
|
|
178
178
|
|
|
179
179
|
#### body?
|
|
180
180
|
|
|
@@ -182,7 +182,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:114](https://github.com/isdk
|
|
|
182
182
|
|
|
183
183
|
#### method?
|
|
184
184
|
|
|
185
|
-
> `optional` **method**: `"GET"` \| `"POST"` \| `"PUT"` \| `"
|
|
185
|
+
> `optional` **method**: `"GET"` \| `"POST"` \| `"PUT"` \| `"PATCH"` \| `"DELETE"`
|
|
186
186
|
|
|
187
187
|
#### Inherited from
|
|
188
188
|
|
|
@@ -194,7 +194,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:114](https://github.com/isdk
|
|
|
194
194
|
|
|
195
195
|
> **id**: `string`
|
|
196
196
|
|
|
197
|
-
Defined in: [packages/web-fetcher/src/core/context.ts:
|
|
197
|
+
Defined in: [packages/web-fetcher/src/core/context.ts:76](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/context.ts#L76)
|
|
198
198
|
|
|
199
199
|
Unique identifier for the session or request batch.
|
|
200
200
|
|
|
@@ -204,7 +204,7 @@ Unique identifier for the session or request batch.
|
|
|
204
204
|
|
|
205
205
|
> `optional` **ignoreSslErrors**: `boolean`
|
|
206
206
|
|
|
207
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
207
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:184](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L184)
|
|
208
208
|
|
|
209
209
|
#### Inherited from
|
|
210
210
|
|
|
@@ -216,7 +216,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:99](https://github.com/isdk/
|
|
|
216
216
|
|
|
217
217
|
> **internal**: `BaseFetchContextInteralState`
|
|
218
218
|
|
|
219
|
-
Defined in: [packages/web-fetcher/src/core/context.ts:
|
|
219
|
+
Defined in: [packages/web-fetcher/src/core/context.ts:98](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/context.ts#L98)
|
|
220
220
|
|
|
221
221
|
Engine-specific internal state.
|
|
222
222
|
|
|
@@ -226,7 +226,7 @@ Engine-specific internal state.
|
|
|
226
226
|
|
|
227
227
|
> `optional` **lastResponse**: [`FetchResponse`](FetchResponse.md)
|
|
228
228
|
|
|
229
|
-
Defined in: [packages/web-fetcher/src/core/context.ts:
|
|
229
|
+
Defined in: [packages/web-fetcher/src/core/context.ts:89](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/context.ts#L89)
|
|
230
230
|
|
|
231
231
|
The standardized response object from the most recent navigation.
|
|
232
232
|
|
|
@@ -236,7 +236,7 @@ The standardized response object from the most recent navigation.
|
|
|
236
236
|
|
|
237
237
|
> `optional` **lastResult**: [`FetchActionResult`](FetchActionResult.md)\<[`FetchReturnType`](../type-aliases/FetchReturnType.md)\>
|
|
238
238
|
|
|
239
|
-
Defined in: [packages/web-fetcher/src/core/context.ts:
|
|
239
|
+
Defined in: [packages/web-fetcher/src/core/context.ts:93](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/context.ts#L93)
|
|
240
240
|
|
|
241
241
|
The result object from the most recent action execution.
|
|
242
242
|
|
|
@@ -246,7 +246,7 @@ The result object from the most recent action execution.
|
|
|
246
246
|
|
|
247
247
|
> `optional` **maxConcurrency**: `number`
|
|
248
248
|
|
|
249
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
249
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:206](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L206)
|
|
250
250
|
|
|
251
251
|
#### Inherited from
|
|
252
252
|
|
|
@@ -258,7 +258,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:121](https://github.com/isdk
|
|
|
258
258
|
|
|
259
259
|
> `optional` **maxRequestsPerMinute**: `number`
|
|
260
260
|
|
|
261
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
261
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:207](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L207)
|
|
262
262
|
|
|
263
263
|
#### Inherited from
|
|
264
264
|
|
|
@@ -270,7 +270,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:122](https://github.com/isdk
|
|
|
270
270
|
|
|
271
271
|
> `optional` **output**: `object`
|
|
272
272
|
|
|
273
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
273
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:169](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L169)
|
|
274
274
|
|
|
275
275
|
#### cookies?
|
|
276
276
|
|
|
@@ -290,7 +290,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:84](https://github.com/isdk/
|
|
|
290
290
|
|
|
291
291
|
> `optional` **overrideSessionState**: `boolean`
|
|
292
292
|
|
|
293
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
293
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:166](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L166)
|
|
294
294
|
|
|
295
295
|
#### Inherited from
|
|
296
296
|
|
|
@@ -302,7 +302,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:81](https://github.com/isdk/
|
|
|
302
302
|
|
|
303
303
|
> `optional` **proxy**: `string` \| `string`[]
|
|
304
304
|
|
|
305
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
305
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:174](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L174)
|
|
306
306
|
|
|
307
307
|
#### Inherited from
|
|
308
308
|
|
|
@@ -314,7 +314,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:89](https://github.com/isdk/
|
|
|
314
314
|
|
|
315
315
|
> `optional` **requestHandlerTimeoutSecs**: `number`
|
|
316
316
|
|
|
317
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
317
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:205](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L205)
|
|
318
318
|
|
|
319
319
|
#### Inherited from
|
|
320
320
|
|
|
@@ -326,7 +326,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:120](https://github.com/isdk
|
|
|
326
326
|
|
|
327
327
|
> `optional` **retries**: `number`
|
|
328
328
|
|
|
329
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
329
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:209](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L209)
|
|
330
330
|
|
|
331
331
|
#### Inherited from
|
|
332
332
|
|
|
@@ -338,7 +338,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:124](https://github.com/isdk
|
|
|
338
338
|
|
|
339
339
|
> `optional` **sessionPoolOptions**: `SessionPoolOptions`
|
|
340
340
|
|
|
341
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
341
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:165](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L165)
|
|
342
342
|
|
|
343
343
|
#### Inherited from
|
|
344
344
|
|
|
@@ -350,7 +350,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:80](https://github.com/isdk/
|
|
|
350
350
|
|
|
351
351
|
> `optional` **sessionState**: `any`
|
|
352
352
|
|
|
353
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
353
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:164](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L164)
|
|
354
354
|
|
|
355
355
|
#### Inherited from
|
|
356
356
|
|
|
@@ -362,7 +362,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:79](https://github.com/isdk/
|
|
|
362
362
|
|
|
363
363
|
> `optional` **sites**: [`FetchSite`](FetchSite.md)[]
|
|
364
364
|
|
|
365
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
365
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:211](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L211)
|
|
366
366
|
|
|
367
367
|
#### Inherited from
|
|
368
368
|
|
|
@@ -374,7 +374,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:126](https://github.com/isdk
|
|
|
374
374
|
|
|
375
375
|
> `optional` **storage**: [`StorageOptions`](StorageOptions.md)
|
|
376
376
|
|
|
377
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
377
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:181](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L181)
|
|
378
378
|
|
|
379
379
|
Storage configuration for session isolation and persistence.
|
|
380
380
|
|
|
@@ -384,11 +384,23 @@ Storage configuration for session isolation and persistence.
|
|
|
384
384
|
|
|
385
385
|
***
|
|
386
386
|
|
|
387
|
+
### syncStateOnUpgrade?
|
|
388
|
+
|
|
389
|
+
> `optional` **syncStateOnUpgrade**: `boolean`
|
|
390
|
+
|
|
391
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:156](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L156)
|
|
392
|
+
|
|
393
|
+
#### Inherited from
|
|
394
|
+
|
|
395
|
+
[`BaseFetcherProperties`](BaseFetcherProperties.md).[`syncStateOnUpgrade`](BaseFetcherProperties.md#syncstateonupgrade)
|
|
396
|
+
|
|
397
|
+
***
|
|
398
|
+
|
|
387
399
|
### throwHttpErrors?
|
|
388
400
|
|
|
389
401
|
> `optional` **throwHttpErrors**: `boolean`
|
|
390
402
|
|
|
391
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
403
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:167](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L167)
|
|
392
404
|
|
|
393
405
|
#### Inherited from
|
|
394
406
|
|
|
@@ -400,7 +412,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:82](https://github.com/isdk/
|
|
|
400
412
|
|
|
401
413
|
> `optional` **timeoutMs**: `number`
|
|
402
414
|
|
|
403
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
415
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:204](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L204)
|
|
404
416
|
|
|
405
417
|
#### Inherited from
|
|
406
418
|
|
|
@@ -408,11 +420,23 @@ Defined in: [packages/web-fetcher/src/core/types.ts:119](https://github.com/isdk
|
|
|
408
420
|
|
|
409
421
|
***
|
|
410
422
|
|
|
423
|
+
### upgradeThresholdMs?
|
|
424
|
+
|
|
425
|
+
> `optional` **upgradeThresholdMs**: `number`
|
|
426
|
+
|
|
427
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:157](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L157)
|
|
428
|
+
|
|
429
|
+
#### Inherited from
|
|
430
|
+
|
|
431
|
+
[`BaseFetcherProperties`](BaseFetcherProperties.md).[`upgradeThresholdMs`](BaseFetcherProperties.md#upgradethresholdms)
|
|
432
|
+
|
|
433
|
+
***
|
|
434
|
+
|
|
411
435
|
### url?
|
|
412
436
|
|
|
413
437
|
> `optional` **url**: `string`
|
|
414
438
|
|
|
415
|
-
Defined in: [packages/web-fetcher/src/core/context.ts:
|
|
439
|
+
Defined in: [packages/web-fetcher/src/core/context.ts:80](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/context.ts#L80)
|
|
416
440
|
|
|
417
441
|
The target URL for the next navigation, if specified.
|
|
418
442
|
|
|
@@ -426,7 +450,7 @@ The target URL for the next navigation, if specified.
|
|
|
426
450
|
|
|
427
451
|
> `optional` **useSiteRegistry**: `boolean`
|
|
428
452
|
|
|
429
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
453
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:158](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L158)
|
|
430
454
|
|
|
431
455
|
#### Inherited from
|
|
432
456
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: FetchMetadata
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
9
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:235](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L235)
|
|
10
10
|
|
|
11
11
|
## Indexable
|
|
12
12
|
|
|
@@ -18,7 +18,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:150](https://github.com/isdk
|
|
|
18
18
|
|
|
19
19
|
> `optional` **engine**: [`BrowserEngine`](../type-aliases/BrowserEngine.md)
|
|
20
20
|
|
|
21
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
21
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:237](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L237)
|
|
22
22
|
|
|
23
23
|
***
|
|
24
24
|
|
|
@@ -26,7 +26,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:152](https://github.com/isdk
|
|
|
26
26
|
|
|
27
27
|
> **mode**: [`FetchEngineType`](../type-aliases/FetchEngineType.md)
|
|
28
28
|
|
|
29
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
29
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:236](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L236)
|
|
30
30
|
|
|
31
31
|
***
|
|
32
32
|
|
|
@@ -34,7 +34,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:151](https://github.com/isdk
|
|
|
34
34
|
|
|
35
35
|
> `optional` **proxy**: `string`
|
|
36
36
|
|
|
37
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
37
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:247](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L247)
|
|
38
38
|
|
|
39
39
|
***
|
|
40
40
|
|
|
@@ -42,7 +42,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:162](https://github.com/isdk
|
|
|
42
42
|
|
|
43
43
|
> `optional` **timings**: `object`
|
|
44
44
|
|
|
45
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
45
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:238](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L238)
|
|
46
46
|
|
|
47
47
|
#### dns?
|
|
48
48
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: FetchResponse
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
9
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:252](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L252)
|
|
10
10
|
|
|
11
11
|
## Properties
|
|
12
12
|
|
|
@@ -14,7 +14,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:167](https://github.com/isdk
|
|
|
14
14
|
|
|
15
15
|
> `optional` **body**: `string` \| `Buffer`\<`ArrayBufferLike`\>
|
|
16
16
|
|
|
17
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
17
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:259](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L259)
|
|
18
18
|
|
|
19
19
|
***
|
|
20
20
|
|
|
@@ -22,7 +22,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:174](https://github.com/isdk
|
|
|
22
22
|
|
|
23
23
|
> `optional` **contentType**: `string`
|
|
24
24
|
|
|
25
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
25
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:258](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L258)
|
|
26
26
|
|
|
27
27
|
***
|
|
28
28
|
|
|
@@ -30,7 +30,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:173](https://github.com/isdk
|
|
|
30
30
|
|
|
31
31
|
> `optional` **cookies**: [`Cookie`](Cookie.md)[]
|
|
32
32
|
|
|
33
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
33
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:263](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L263)
|
|
34
34
|
|
|
35
35
|
***
|
|
36
36
|
|
|
@@ -38,7 +38,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:178](https://github.com/isdk
|
|
|
38
38
|
|
|
39
39
|
> **finalUrl**: `string`
|
|
40
40
|
|
|
41
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
41
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:254](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L254)
|
|
42
42
|
|
|
43
43
|
***
|
|
44
44
|
|
|
@@ -46,7 +46,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:169](https://github.com/isdk
|
|
|
46
46
|
|
|
47
47
|
> **headers**: `Record`\<`string`, `string`\>
|
|
48
48
|
|
|
49
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
49
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:257](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L257)
|
|
50
50
|
|
|
51
51
|
***
|
|
52
52
|
|
|
@@ -54,7 +54,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:172](https://github.com/isdk
|
|
|
54
54
|
|
|
55
55
|
> `optional` **html**: `string`
|
|
56
56
|
|
|
57
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
57
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:260](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L260)
|
|
58
58
|
|
|
59
59
|
***
|
|
60
60
|
|
|
@@ -62,7 +62,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:175](https://github.com/isdk
|
|
|
62
62
|
|
|
63
63
|
> `optional` **json**: `any`
|
|
64
64
|
|
|
65
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
65
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:262](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L262)
|
|
66
66
|
|
|
67
67
|
***
|
|
68
68
|
|
|
@@ -70,7 +70,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:177](https://github.com/isdk
|
|
|
70
70
|
|
|
71
71
|
> `optional` **metadata**: [`FetchMetadata`](FetchMetadata.md)
|
|
72
72
|
|
|
73
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
73
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:265](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L265)
|
|
74
74
|
|
|
75
75
|
***
|
|
76
76
|
|
|
@@ -78,7 +78,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:180](https://github.com/isdk
|
|
|
78
78
|
|
|
79
79
|
> `optional` **sessionState**: `any`
|
|
80
80
|
|
|
81
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
81
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:264](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L264)
|
|
82
82
|
|
|
83
83
|
***
|
|
84
84
|
|
|
@@ -86,7 +86,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:179](https://github.com/isdk
|
|
|
86
86
|
|
|
87
87
|
> `optional` **statusCode**: `number`
|
|
88
88
|
|
|
89
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
89
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:255](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L255)
|
|
90
90
|
|
|
91
91
|
***
|
|
92
92
|
|
|
@@ -94,7 +94,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:170](https://github.com/isdk
|
|
|
94
94
|
|
|
95
95
|
> `optional` **statusText**: `string`
|
|
96
96
|
|
|
97
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
97
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:256](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L256)
|
|
98
98
|
|
|
99
99
|
***
|
|
100
100
|
|
|
@@ -102,7 +102,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:171](https://github.com/isdk
|
|
|
102
102
|
|
|
103
103
|
> `optional` **text**: `string`
|
|
104
104
|
|
|
105
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
105
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:261](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L261)
|
|
106
106
|
|
|
107
107
|
***
|
|
108
108
|
|
|
@@ -110,4 +110,4 @@ Defined in: [packages/web-fetcher/src/core/types.ts:176](https://github.com/isdk
|
|
|
110
110
|
|
|
111
111
|
> **url**: `string`
|
|
112
112
|
|
|
113
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
113
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:253](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L253)
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: FetchReturnTypeRegistry
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/web-fetcher/src/core/fetch-return-type.ts:
|
|
9
|
+
Defined in: [packages/web-fetcher/src/core/fetch-return-type.ts:11](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/fetch-return-type.ts#L11)
|
|
10
10
|
|
|
11
11
|
## Properties
|
|
12
12
|
|
|
@@ -14,7 +14,7 @@ Defined in: [packages/web-fetcher/src/core/fetch-return-type.ts:12](https://gith
|
|
|
14
14
|
|
|
15
15
|
> **any**: `any`
|
|
16
16
|
|
|
17
|
-
Defined in: [packages/web-fetcher/src/core/fetch-return-type.ts:
|
|
17
|
+
Defined in: [packages/web-fetcher/src/core/fetch-return-type.ts:16](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/fetch-return-type.ts#L16)
|
|
18
18
|
|
|
19
19
|
***
|
|
20
20
|
|
|
@@ -22,7 +22,7 @@ Defined in: [packages/web-fetcher/src/core/fetch-return-type.ts:17](https://gith
|
|
|
22
22
|
|
|
23
23
|
> **context**: [`FetchContext`](FetchContext.md)
|
|
24
24
|
|
|
25
|
-
Defined in: [packages/web-fetcher/src/core/fetch-return-type.ts:
|
|
25
|
+
Defined in: [packages/web-fetcher/src/core/fetch-return-type.ts:13](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/fetch-return-type.ts#L13)
|
|
26
26
|
|
|
27
27
|
***
|
|
28
28
|
|
|
@@ -30,7 +30,7 @@ Defined in: [packages/web-fetcher/src/core/fetch-return-type.ts:14](https://gith
|
|
|
30
30
|
|
|
31
31
|
> **none**: `void`
|
|
32
32
|
|
|
33
|
-
Defined in: [packages/web-fetcher/src/core/fetch-return-type.ts:
|
|
33
|
+
Defined in: [packages/web-fetcher/src/core/fetch-return-type.ts:17](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/fetch-return-type.ts#L17)
|
|
34
34
|
|
|
35
35
|
***
|
|
36
36
|
|
|
@@ -38,7 +38,7 @@ Defined in: [packages/web-fetcher/src/core/fetch-return-type.ts:18](https://gith
|
|
|
38
38
|
|
|
39
39
|
> **outputs**: `Record`\<`string`, `any`\>
|
|
40
40
|
|
|
41
|
-
Defined in: [packages/web-fetcher/src/core/fetch-return-type.ts:
|
|
41
|
+
Defined in: [packages/web-fetcher/src/core/fetch-return-type.ts:15](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/fetch-return-type.ts#L15)
|
|
42
42
|
|
|
43
43
|
***
|
|
44
44
|
|
|
@@ -46,7 +46,7 @@ Defined in: [packages/web-fetcher/src/core/fetch-return-type.ts:16](https://gith
|
|
|
46
46
|
|
|
47
47
|
> **response**: [`FetchResponse`](FetchResponse.md)
|
|
48
48
|
|
|
49
|
-
Defined in: [packages/web-fetcher/src/core/fetch-return-type.ts:
|
|
49
|
+
Defined in: [packages/web-fetcher/src/core/fetch-return-type.ts:12](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/fetch-return-type.ts#L12)
|
|
50
50
|
|
|
51
51
|
***
|
|
52
52
|
|
|
@@ -54,4 +54,4 @@ Defined in: [packages/web-fetcher/src/core/fetch-return-type.ts:13](https://gith
|
|
|
54
54
|
|
|
55
55
|
> **result**: [`FetchActionResult`](FetchActionResult.md)\<`any`\> \| `undefined`
|
|
56
56
|
|
|
57
|
-
Defined in: [packages/web-fetcher/src/core/fetch-return-type.ts:
|
|
57
|
+
Defined in: [packages/web-fetcher/src/core/fetch-return-type.ts:14](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/fetch-return-type.ts#L14)
|