@isdk/web-fetcher 0.2.11 → 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.
- package/README.action.cn.md +81 -20
- package/README.action.md +81 -4
- package/README.engine.cn.md +28 -8
- package/README.engine.md +28 -8
- package/dist/index.d.mts +405 -10
- package/dist/index.d.ts +405 -10
- package/dist/index.js +1 -1
- package/dist/index.mjs +1 -1
- package/docs/_media/README.action.md +81 -4
- package/docs/_media/README.engine.md +28 -8
- package/docs/classes/CheerioFetchEngine.md +354 -67
- package/docs/classes/ClickAction.md +23 -23
- package/docs/classes/ExtractAction.md +23 -23
- package/docs/classes/FetchAction.md +23 -23
- package/docs/classes/FetchEngine.md +314 -65
- package/docs/classes/FetchSession.md +118 -21
- package/docs/classes/FillAction.md +23 -23
- package/docs/classes/GetContentAction.md +23 -23
- package/docs/classes/GotoAction.md +23 -23
- package/docs/classes/PauseAction.md +23 -23
- package/docs/classes/PlaywrightFetchEngine.md +339 -66
- package/docs/classes/SubmitAction.md +23 -23
- package/docs/classes/WaitForAction.md +23 -23
- package/docs/classes/WebFetcher.md +53 -5
- package/docs/enumerations/FetchActionResultStatus.md +4 -4
- package/docs/functions/fetchWeb.md +2 -2
- package/docs/interfaces/BaseFetchActionProperties.md +19 -11
- package/docs/interfaces/BaseFetchCollectorActionProperties.md +27 -15
- package/docs/interfaces/BaseFetcherProperties.md +27 -27
- package/docs/interfaces/DispatchedEngineAction.md +4 -4
- package/docs/interfaces/ExtractActionProperties.md +23 -11
- package/docs/interfaces/FetchActionInContext.md +32 -15
- package/docs/interfaces/FetchActionProperties.md +24 -12
- package/docs/interfaces/FetchActionResult.md +6 -6
- package/docs/interfaces/FetchContext.md +80 -37
- package/docs/interfaces/FetchEngineContext.md +51 -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 +30 -30
- package/docs/interfaces/FetcherOptions.md +29 -29
- package/docs/interfaces/GotoActionOptions.md +6 -6
- package/docs/interfaces/PendingEngineRequest.md +3 -3
- package/docs/interfaces/StorageOptions.md +5 -5
- package/docs/interfaces/SubmitActionOptions.md +2 -2
- 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 +1 -1
- 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/variables/DefaultFetcherProperties.md +1 -1
- package/docs/variables/FetcherOptionKeys.md +1 -1
- package/package.json +7 -4
|
@@ -6,7 +6,14 @@
|
|
|
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:73](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/core/context.ts#L73)
|
|
10
|
+
|
|
11
|
+
Context provided to the Fetch Engine during navigation and request handling.
|
|
12
|
+
|
|
13
|
+
## Remarks
|
|
14
|
+
|
|
15
|
+
This interface contains the minimum set of properties required by an engine
|
|
16
|
+
to perform a fetch operation and build a response.
|
|
10
17
|
|
|
11
18
|
## Extends
|
|
12
19
|
|
|
@@ -22,7 +29,7 @@ Defined in: [packages/web-fetcher/src/core/context.ts:24](https://github.com/isd
|
|
|
22
29
|
|
|
23
30
|
> `optional` **antibot**: `boolean`
|
|
24
31
|
|
|
25
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
32
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:74](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/core/types.ts#L74)
|
|
26
33
|
|
|
27
34
|
#### Inherited from
|
|
28
35
|
|
|
@@ -34,7 +41,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:68](https://github.com/isdk/
|
|
|
34
41
|
|
|
35
42
|
> `optional` **blockResources**: `string`[]
|
|
36
43
|
|
|
37
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
44
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:91](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/core/types.ts#L91)
|
|
38
45
|
|
|
39
46
|
#### Inherited from
|
|
40
47
|
|
|
@@ -46,7 +53,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:85](https://github.com/isdk/
|
|
|
46
53
|
|
|
47
54
|
> `optional` **browser**: `object`
|
|
48
55
|
|
|
49
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
56
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:101](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/core/types.ts#L101)
|
|
50
57
|
|
|
51
58
|
#### engine?
|
|
52
59
|
|
|
@@ -75,7 +82,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:95](https://github.com/isdk/
|
|
|
75
82
|
|
|
76
83
|
> `optional` **cookies**: [`Cookie`](Cookie.md)[]
|
|
77
84
|
|
|
78
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
85
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:78](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/core/types.ts#L78)
|
|
79
86
|
|
|
80
87
|
#### Inherited from
|
|
81
88
|
|
|
@@ -87,7 +94,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:72](https://github.com/isdk/
|
|
|
87
94
|
|
|
88
95
|
> `optional` **debug**: `boolean`
|
|
89
96
|
|
|
90
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
97
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:75](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/core/types.ts#L75)
|
|
91
98
|
|
|
92
99
|
#### Inherited from
|
|
93
100
|
|
|
@@ -99,7 +106,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:69](https://github.com/isdk/
|
|
|
99
106
|
|
|
100
107
|
> `optional` **delayBetweenRequestsMs**: `number`
|
|
101
108
|
|
|
102
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
109
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:122](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/core/types.ts#L122)
|
|
103
110
|
|
|
104
111
|
#### Inherited from
|
|
105
112
|
|
|
@@ -111,7 +118,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:116](https://github.com/isdk
|
|
|
111
118
|
|
|
112
119
|
> `optional` **enableSmart**: `boolean`
|
|
113
120
|
|
|
114
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
121
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:72](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/core/types.ts#L72)
|
|
115
122
|
|
|
116
123
|
#### Inherited from
|
|
117
124
|
|
|
@@ -123,7 +130,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:66](https://github.com/isdk/
|
|
|
123
130
|
|
|
124
131
|
> `optional` **engine**: `string`
|
|
125
132
|
|
|
126
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
133
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:71](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/core/types.ts#L71)
|
|
127
134
|
|
|
128
135
|
抓取模式
|
|
129
136
|
|
|
@@ -141,7 +148,9 @@ Defined in: [packages/web-fetcher/src/core/types.ts:65](https://github.com/isdk/
|
|
|
141
148
|
|
|
142
149
|
> `optional` **finalUrl**: `string`
|
|
143
150
|
|
|
144
|
-
Defined in: [packages/web-fetcher/src/core/context.ts:
|
|
151
|
+
Defined in: [packages/web-fetcher/src/core/context.ts:85](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/core/context.ts#L85)
|
|
152
|
+
|
|
153
|
+
The final URL after all redirects have been followed.
|
|
145
154
|
|
|
146
155
|
***
|
|
147
156
|
|
|
@@ -149,7 +158,7 @@ Defined in: [packages/web-fetcher/src/core/context.ts:27](https://github.com/isd
|
|
|
149
158
|
|
|
150
159
|
> `optional` **headers**: `Record`\<`string`, `string`\>
|
|
151
160
|
|
|
152
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
161
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:77](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/core/types.ts#L77)
|
|
153
162
|
|
|
154
163
|
#### Inherited from
|
|
155
164
|
|
|
@@ -161,7 +170,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:71](https://github.com/isdk/
|
|
|
161
170
|
|
|
162
171
|
> `optional` **http**: `object`
|
|
163
172
|
|
|
164
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
173
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:113](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/core/types.ts#L113)
|
|
165
174
|
|
|
166
175
|
#### body?
|
|
167
176
|
|
|
@@ -181,7 +190,9 @@ Defined in: [packages/web-fetcher/src/core/types.ts:107](https://github.com/isdk
|
|
|
181
190
|
|
|
182
191
|
> **id**: `string`
|
|
183
192
|
|
|
184
|
-
Defined in: [packages/web-fetcher/src/core/context.ts:
|
|
193
|
+
Defined in: [packages/web-fetcher/src/core/context.ts:77](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/core/context.ts#L77)
|
|
194
|
+
|
|
195
|
+
Unique identifier for the session or request batch.
|
|
185
196
|
|
|
186
197
|
***
|
|
187
198
|
|
|
@@ -189,7 +200,7 @@ Defined in: [packages/web-fetcher/src/core/context.ts:25](https://github.com/isd
|
|
|
189
200
|
|
|
190
201
|
> `optional` **ignoreSslErrors**: `boolean`
|
|
191
202
|
|
|
192
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
203
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:99](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/core/types.ts#L99)
|
|
193
204
|
|
|
194
205
|
#### Inherited from
|
|
195
206
|
|
|
@@ -201,7 +212,9 @@ Defined in: [packages/web-fetcher/src/core/types.ts:93](https://github.com/isdk/
|
|
|
201
212
|
|
|
202
213
|
> **internal**: `BaseFetchContextInteralState`
|
|
203
214
|
|
|
204
|
-
Defined in: [packages/web-fetcher/src/core/context.ts:
|
|
215
|
+
Defined in: [packages/web-fetcher/src/core/context.ts:99](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/core/context.ts#L99)
|
|
216
|
+
|
|
217
|
+
Engine-specific internal state.
|
|
205
218
|
|
|
206
219
|
***
|
|
207
220
|
|
|
@@ -209,7 +222,9 @@ Defined in: [packages/web-fetcher/src/core/context.ts:32](https://github.com/isd
|
|
|
209
222
|
|
|
210
223
|
> `optional` **lastResponse**: [`FetchResponse`](FetchResponse.md)
|
|
211
224
|
|
|
212
|
-
Defined in: [packages/web-fetcher/src/core/context.ts:
|
|
225
|
+
Defined in: [packages/web-fetcher/src/core/context.ts:90](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/core/context.ts#L90)
|
|
226
|
+
|
|
227
|
+
The standardized response object from the most recent navigation.
|
|
213
228
|
|
|
214
229
|
***
|
|
215
230
|
|
|
@@ -217,7 +232,9 @@ Defined in: [packages/web-fetcher/src/core/context.ts:29](https://github.com/isd
|
|
|
217
232
|
|
|
218
233
|
> `optional` **lastResult**: [`FetchActionResult`](FetchActionResult.md)\<[`FetchReturnType`](../type-aliases/FetchReturnType.md)\>
|
|
219
234
|
|
|
220
|
-
Defined in: [packages/web-fetcher/src/core/context.ts:
|
|
235
|
+
Defined in: [packages/web-fetcher/src/core/context.ts:94](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/core/context.ts#L94)
|
|
236
|
+
|
|
237
|
+
The result object from the most recent action execution.
|
|
221
238
|
|
|
222
239
|
***
|
|
223
240
|
|
|
@@ -225,7 +242,7 @@ Defined in: [packages/web-fetcher/src/core/context.ts:30](https://github.com/isd
|
|
|
225
242
|
|
|
226
243
|
> `optional` **maxConcurrency**: `number`
|
|
227
244
|
|
|
228
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
245
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:120](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/core/types.ts#L120)
|
|
229
246
|
|
|
230
247
|
#### Inherited from
|
|
231
248
|
|
|
@@ -237,7 +254,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:114](https://github.com/isdk
|
|
|
237
254
|
|
|
238
255
|
> `optional` **maxRequestsPerMinute**: `number`
|
|
239
256
|
|
|
240
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
257
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:121](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/core/types.ts#L121)
|
|
241
258
|
|
|
242
259
|
#### Inherited from
|
|
243
260
|
|
|
@@ -249,7 +266,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:115](https://github.com/isdk
|
|
|
249
266
|
|
|
250
267
|
> `optional` **output**: `object`
|
|
251
268
|
|
|
252
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
269
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:84](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/core/types.ts#L84)
|
|
253
270
|
|
|
254
271
|
#### cookies?
|
|
255
272
|
|
|
@@ -269,7 +286,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:78](https://github.com/isdk/
|
|
|
269
286
|
|
|
270
287
|
> `optional` **overrideSessionState**: `boolean`
|
|
271
288
|
|
|
272
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
289
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:81](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/core/types.ts#L81)
|
|
273
290
|
|
|
274
291
|
#### Inherited from
|
|
275
292
|
|
|
@@ -281,7 +298,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:75](https://github.com/isdk/
|
|
|
281
298
|
|
|
282
299
|
> `optional` **proxy**: `string` \| `string`[]
|
|
283
300
|
|
|
284
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
301
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:89](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/core/types.ts#L89)
|
|
285
302
|
|
|
286
303
|
#### Inherited from
|
|
287
304
|
|
|
@@ -293,7 +310,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:83](https://github.com/isdk/
|
|
|
293
310
|
|
|
294
311
|
> `optional` **requestHandlerTimeoutSecs**: `number`
|
|
295
312
|
|
|
296
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
313
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:119](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/core/types.ts#L119)
|
|
297
314
|
|
|
298
315
|
#### Inherited from
|
|
299
316
|
|
|
@@ -305,7 +322,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:113](https://github.com/isdk
|
|
|
305
322
|
|
|
306
323
|
> `optional` **retries**: `number`
|
|
307
324
|
|
|
308
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
325
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:123](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/core/types.ts#L123)
|
|
309
326
|
|
|
310
327
|
#### Inherited from
|
|
311
328
|
|
|
@@ -317,7 +334,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:117](https://github.com/isdk
|
|
|
317
334
|
|
|
318
335
|
> `optional` **sessionPoolOptions**: `SessionPoolOptions`
|
|
319
336
|
|
|
320
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
337
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:80](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/core/types.ts#L80)
|
|
321
338
|
|
|
322
339
|
#### Inherited from
|
|
323
340
|
|
|
@@ -329,7 +346,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:74](https://github.com/isdk/
|
|
|
329
346
|
|
|
330
347
|
> `optional` **sessionState**: `any`
|
|
331
348
|
|
|
332
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
349
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:79](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/core/types.ts#L79)
|
|
333
350
|
|
|
334
351
|
#### Inherited from
|
|
335
352
|
|
|
@@ -341,7 +358,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:73](https://github.com/isdk/
|
|
|
341
358
|
|
|
342
359
|
> `optional` **sites**: [`FetchSite`](FetchSite.md)[]
|
|
343
360
|
|
|
344
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
361
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:125](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/core/types.ts#L125)
|
|
345
362
|
|
|
346
363
|
#### Inherited from
|
|
347
364
|
|
|
@@ -353,7 +370,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:119](https://github.com/isdk
|
|
|
353
370
|
|
|
354
371
|
> `optional` **storage**: [`StorageOptions`](StorageOptions.md)
|
|
355
372
|
|
|
356
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
373
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:96](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/core/types.ts#L96)
|
|
357
374
|
|
|
358
375
|
Storage configuration for session isolation and persistence.
|
|
359
376
|
|
|
@@ -367,7 +384,7 @@ Storage configuration for session isolation and persistence.
|
|
|
367
384
|
|
|
368
385
|
> `optional` **throwHttpErrors**: `boolean`
|
|
369
386
|
|
|
370
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
387
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:82](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/core/types.ts#L82)
|
|
371
388
|
|
|
372
389
|
#### Inherited from
|
|
373
390
|
|
|
@@ -379,7 +396,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:76](https://github.com/isdk/
|
|
|
379
396
|
|
|
380
397
|
> `optional` **timeoutMs**: `number`
|
|
381
398
|
|
|
382
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
399
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:118](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/core/types.ts#L118)
|
|
383
400
|
|
|
384
401
|
#### Inherited from
|
|
385
402
|
|
|
@@ -391,7 +408,9 @@ Defined in: [packages/web-fetcher/src/core/types.ts:112](https://github.com/isdk
|
|
|
391
408
|
|
|
392
409
|
> `optional` **url**: `string`
|
|
393
410
|
|
|
394
|
-
Defined in: [packages/web-fetcher/src/core/context.ts:
|
|
411
|
+
Defined in: [packages/web-fetcher/src/core/context.ts:81](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/core/context.ts#L81)
|
|
412
|
+
|
|
413
|
+
The target URL for the next navigation, if specified.
|
|
395
414
|
|
|
396
415
|
#### Overrides
|
|
397
416
|
|
|
@@ -403,7 +422,7 @@ Defined in: [packages/web-fetcher/src/core/context.ts:26](https://github.com/isd
|
|
|
403
422
|
|
|
404
423
|
> `optional` **useSiteRegistry**: `boolean`
|
|
405
424
|
|
|
406
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
425
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:73](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/core/types.ts#L73)
|
|
407
426
|
|
|
408
427
|
#### Inherited from
|
|
409
428
|
|
|
@@ -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:149](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/core/types.ts#L149)
|
|
10
10
|
|
|
11
11
|
## Indexable
|
|
12
12
|
|
|
@@ -18,7 +18,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:143](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:151](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/core/types.ts#L151)
|
|
22
22
|
|
|
23
23
|
***
|
|
24
24
|
|
|
@@ -26,7 +26,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:145](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:150](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/core/types.ts#L150)
|
|
30
30
|
|
|
31
31
|
***
|
|
32
32
|
|
|
@@ -34,7 +34,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:144](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:161](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/core/types.ts#L161)
|
|
38
38
|
|
|
39
39
|
***
|
|
40
40
|
|
|
@@ -42,7 +42,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:155](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:152](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/core/types.ts#L152)
|
|
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:166](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/core/types.ts#L166)
|
|
10
10
|
|
|
11
11
|
## Properties
|
|
12
12
|
|
|
@@ -14,7 +14,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:160](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:173](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/core/types.ts#L173)
|
|
18
18
|
|
|
19
19
|
***
|
|
20
20
|
|
|
@@ -22,7 +22,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:167](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:172](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/core/types.ts#L172)
|
|
26
26
|
|
|
27
27
|
***
|
|
28
28
|
|
|
@@ -30,7 +30,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:166](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:177](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/core/types.ts#L177)
|
|
34
34
|
|
|
35
35
|
***
|
|
36
36
|
|
|
@@ -38,7 +38,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:171](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:168](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/core/types.ts#L168)
|
|
42
42
|
|
|
43
43
|
***
|
|
44
44
|
|
|
@@ -46,7 +46,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:162](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:171](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/core/types.ts#L171)
|
|
50
50
|
|
|
51
51
|
***
|
|
52
52
|
|
|
@@ -54,7 +54,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:165](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:174](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/core/types.ts#L174)
|
|
58
58
|
|
|
59
59
|
***
|
|
60
60
|
|
|
@@ -62,7 +62,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:168](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:176](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/core/types.ts#L176)
|
|
66
66
|
|
|
67
67
|
***
|
|
68
68
|
|
|
@@ -70,7 +70,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:170](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:179](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/core/types.ts#L179)
|
|
74
74
|
|
|
75
75
|
***
|
|
76
76
|
|
|
@@ -78,7 +78,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:173](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:178](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/core/types.ts#L178)
|
|
82
82
|
|
|
83
83
|
***
|
|
84
84
|
|
|
@@ -86,7 +86,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:172](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:169](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/core/types.ts#L169)
|
|
90
90
|
|
|
91
91
|
***
|
|
92
92
|
|
|
@@ -94,7 +94,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:163](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:170](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/core/types.ts#L170)
|
|
98
98
|
|
|
99
99
|
***
|
|
100
100
|
|
|
@@ -102,7 +102,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:164](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:175](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/core/types.ts#L175)
|
|
106
106
|
|
|
107
107
|
***
|
|
108
108
|
|
|
@@ -110,4 +110,4 @@ Defined in: [packages/web-fetcher/src/core/types.ts:169](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:167](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/core/types.ts#L167)
|
|
@@ -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:12](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/core/fetch-return-type.ts#L12)
|
|
10
10
|
|
|
11
11
|
## Properties
|
|
12
12
|
|
|
@@ -14,7 +14,7 @@ Defined in: [packages/web-fetcher/src/core/fetch-return-type.ts:7](https://githu
|
|
|
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:17](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/core/fetch-return-type.ts#L17)
|
|
18
18
|
|
|
19
19
|
***
|
|
20
20
|
|
|
@@ -22,7 +22,7 @@ Defined in: [packages/web-fetcher/src/core/fetch-return-type.ts:12](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:14](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/core/fetch-return-type.ts#L14)
|
|
26
26
|
|
|
27
27
|
***
|
|
28
28
|
|
|
@@ -30,7 +30,7 @@ Defined in: [packages/web-fetcher/src/core/fetch-return-type.ts:9](https://githu
|
|
|
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:18](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/core/fetch-return-type.ts#L18)
|
|
34
34
|
|
|
35
35
|
***
|
|
36
36
|
|
|
@@ -38,7 +38,7 @@ Defined in: [packages/web-fetcher/src/core/fetch-return-type.ts:13](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:16](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/core/fetch-return-type.ts#L16)
|
|
42
42
|
|
|
43
43
|
***
|
|
44
44
|
|
|
@@ -46,7 +46,7 @@ Defined in: [packages/web-fetcher/src/core/fetch-return-type.ts:11](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:13](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/core/fetch-return-type.ts#L13)
|
|
50
50
|
|
|
51
51
|
***
|
|
52
52
|
|
|
@@ -54,4 +54,4 @@ Defined in: [packages/web-fetcher/src/core/fetch-return-type.ts:8](https://githu
|
|
|
54
54
|
|
|
55
55
|
> **result**: `undefined` \| [`FetchActionResult`](FetchActionResult.md)\<`any`\>
|
|
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:15](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/core/fetch-return-type.ts#L15)
|