@isdk/web-fetcher 0.3.0 → 0.3.2
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 +77 -312
- package/README.action.extract.cn.md +263 -0
- package/README.action.extract.md +263 -0
- package/README.action.md +76 -311
- package/README.cn.md +12 -2
- package/README.engine.cn.md +22 -1
- package/README.engine.md +22 -1
- package/README.md +10 -1
- package/dist/index.d.mts +245 -1
- package/dist/index.d.ts +245 -1
- package/dist/index.js +1 -1
- package/dist/index.mjs +1 -1
- package/docs/README.md +10 -1
- package/docs/_media/README.action.md +76 -311
- package/docs/_media/README.cn.md +12 -2
- package/docs/_media/README.engine.md +22 -1
- package/docs/classes/CheerioFetchEngine.md +312 -88
- package/docs/classes/ClickAction.md +23 -23
- package/docs/classes/EvaluateAction.md +23 -23
- package/docs/classes/ExtractAction.md +23 -23
- package/docs/classes/FetchAction.md +29 -23
- package/docs/classes/FetchEngine.md +286 -86
- package/docs/classes/FetchSession.md +13 -13
- package/docs/classes/FillAction.md +23 -23
- package/docs/classes/GetContentAction.md +23 -23
- package/docs/classes/GotoAction.md +23 -23
- package/docs/classes/KeyboardPressAction.md +533 -0
- package/docs/classes/KeyboardTypeAction.md +533 -0
- package/docs/classes/MouseClickAction.md +533 -0
- package/docs/classes/MouseMoveAction.md +533 -0
- package/docs/classes/MouseWheelAction.md +533 -0
- package/docs/classes/PauseAction.md +23 -23
- package/docs/classes/PlaywrightFetchEngine.md +472 -88
- package/docs/classes/ScrollIntoViewAction.md +533 -0
- package/docs/classes/SubmitAction.md +23 -23
- package/docs/classes/TrimAction.md +23 -23
- package/docs/classes/WaitForAction.md +23 -23
- package/docs/classes/WebFetcher.md +5 -5
- package/docs/enumerations/FetchActionResultStatus.md +4 -4
- package/docs/functions/fetchWeb.md +2 -2
- package/docs/functions/getRandomDelay.md +25 -0
- package/docs/globals.md +13 -0
- package/docs/interfaces/BaseFetchActionProperties.md +12 -12
- package/docs/interfaces/BaseFetchCollectorActionProperties.md +16 -16
- package/docs/interfaces/BaseFetcherProperties.md +31 -27
- package/docs/interfaces/Cookie.md +14 -14
- package/docs/interfaces/DispatchedEngineAction.md +4 -4
- package/docs/interfaces/EvaluateActionOptions.md +3 -3
- package/docs/interfaces/ExtractActionProperties.md +12 -12
- package/docs/interfaces/FetchActionInContext.md +15 -15
- package/docs/interfaces/FetchActionProperties.md +13 -13
- package/docs/interfaces/FetchActionResult.md +6 -6
- package/docs/interfaces/FetchContext.md +41 -37
- package/docs/interfaces/FetchEngineContext.md +36 -32
- package/docs/interfaces/FetchMetadata.md +5 -5
- package/docs/interfaces/FetchResponse.md +14 -14
- package/docs/interfaces/FetchReturnTypeRegistry.md +7 -7
- package/docs/interfaces/FetchSite.md +34 -30
- package/docs/interfaces/FetcherOptions.md +33 -29
- package/docs/interfaces/GotoActionOptions.md +14 -6
- package/docs/interfaces/KeyboardPressParams.md +25 -0
- package/docs/interfaces/KeyboardTypeParams.md +25 -0
- package/docs/interfaces/MouseClickParams.md +49 -0
- package/docs/interfaces/MouseMoveParams.md +41 -0
- package/docs/interfaces/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/FetchActionOptions.md +1 -1
- package/docs/type-aliases/FetchEngineAction.md +2 -2
- package/docs/type-aliases/FetchEngineType.md +1 -1
- package/docs/type-aliases/FetchReturnType.md +1 -1
- package/docs/type-aliases/FetchReturnTypeFor.md +1 -1
- package/docs/type-aliases/OnFetchPauseCallback.md +1 -1
- package/docs/type-aliases/ResourceType.md +1 -1
- package/docs/type-aliases/TrimPreset.md +1 -1
- package/docs/variables/DefaultFetcherProperties.md +1 -1
- package/docs/variables/FetcherOptionKeys.md +1 -1
- package/docs/variables/TRIM_PRESETS.md +1 -1
- package/package.json +10 -10
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: FetchActionInContext
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/web-fetcher/src/core/context.ts:18](https://github.com/isdk/web-fetcher.js/blob/
|
|
9
|
+
Defined in: [packages/web-fetcher/src/core/context.ts:18](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/core/context.ts#L18)
|
|
10
10
|
|
|
11
11
|
Represents the state of an action being executed within a context.
|
|
12
12
|
|
|
@@ -29,7 +29,7 @@ nesting depth, and any errors encountered during execution.
|
|
|
29
29
|
|
|
30
30
|
> `optional` **action**: `string` \| [`FetchAction`](../classes/FetchAction.md)
|
|
31
31
|
|
|
32
|
-
Defined in: [packages/web-fetcher/src/action/fetch-action.ts:49](https://github.com/isdk/web-fetcher.js/blob/
|
|
32
|
+
Defined in: [packages/web-fetcher/src/action/fetch-action.ts:49](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/action/fetch-action.ts#L49)
|
|
33
33
|
|
|
34
34
|
#### Inherited from
|
|
35
35
|
|
|
@@ -41,7 +41,7 @@ Defined in: [packages/web-fetcher/src/action/fetch-action.ts:49](https://github.
|
|
|
41
41
|
|
|
42
42
|
> `optional` **args**: `any`
|
|
43
43
|
|
|
44
|
-
Defined in: [packages/web-fetcher/src/action/fetch-action.ts:52](https://github.com/isdk/web-fetcher.js/blob/
|
|
44
|
+
Defined in: [packages/web-fetcher/src/action/fetch-action.ts:52](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/action/fetch-action.ts#L52)
|
|
45
45
|
|
|
46
46
|
#### Inherited from
|
|
47
47
|
|
|
@@ -53,7 +53,7 @@ Defined in: [packages/web-fetcher/src/action/fetch-action.ts:52](https://github.
|
|
|
53
53
|
|
|
54
54
|
> `optional` **collectors**: `_RequireAtLeastOne`\<[`BaseFetchCollectorActionProperties`](BaseFetchCollectorActionProperties.md), `"name"` \| `"id"` \| `"action"`\>[]
|
|
55
55
|
|
|
56
|
-
Defined in: [packages/web-fetcher/src/action/fetch-action.ts:87](https://github.com/isdk/web-fetcher.js/blob/
|
|
56
|
+
Defined in: [packages/web-fetcher/src/action/fetch-action.ts:87](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/action/fetch-action.ts#L87)
|
|
57
57
|
|
|
58
58
|
#### Inherited from
|
|
59
59
|
|
|
@@ -65,7 +65,7 @@ Defined in: [packages/web-fetcher/src/action/fetch-action.ts:87](https://github.
|
|
|
65
65
|
|
|
66
66
|
> `optional` **depth**: `number`
|
|
67
67
|
|
|
68
|
-
Defined in: [packages/web-fetcher/src/core/context.ts:30](https://github.com/isdk/web-fetcher.js/blob/
|
|
68
|
+
Defined in: [packages/web-fetcher/src/core/context.ts:30](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/core/context.ts#L30)
|
|
69
69
|
|
|
70
70
|
The nesting depth of the action. Top-level actions (executed directly by the session) have a depth of 0.
|
|
71
71
|
|
|
@@ -75,7 +75,7 @@ The nesting depth of the action. Top-level actions (executed directly by the ses
|
|
|
75
75
|
|
|
76
76
|
> `optional` **error**: `Error`
|
|
77
77
|
|
|
78
|
-
Defined in: [packages/web-fetcher/src/core/context.ts:26](https://github.com/isdk/web-fetcher.js/blob/
|
|
78
|
+
Defined in: [packages/web-fetcher/src/core/context.ts:26](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/core/context.ts#L26)
|
|
79
79
|
|
|
80
80
|
Error encountered during action execution, if any.
|
|
81
81
|
|
|
@@ -85,7 +85,7 @@ Error encountered during action execution, if any.
|
|
|
85
85
|
|
|
86
86
|
> `optional` **failOnError**: `boolean`
|
|
87
87
|
|
|
88
|
-
Defined in: [packages/web-fetcher/src/action/fetch-action.ts:57](https://github.com/isdk/web-fetcher.js/blob/
|
|
88
|
+
Defined in: [packages/web-fetcher/src/action/fetch-action.ts:57](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/action/fetch-action.ts#L57)
|
|
89
89
|
|
|
90
90
|
#### Inherited from
|
|
91
91
|
|
|
@@ -97,7 +97,7 @@ Defined in: [packages/web-fetcher/src/action/fetch-action.ts:57](https://github.
|
|
|
97
97
|
|
|
98
98
|
> `optional` **failOnTimeout**: `boolean`
|
|
99
99
|
|
|
100
|
-
Defined in: [packages/web-fetcher/src/action/fetch-action.ts:59](https://github.com/isdk/web-fetcher.js/blob/
|
|
100
|
+
Defined in: [packages/web-fetcher/src/action/fetch-action.ts:59](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/action/fetch-action.ts#L59)
|
|
101
101
|
|
|
102
102
|
#### Inherited from
|
|
103
103
|
|
|
@@ -109,7 +109,7 @@ Defined in: [packages/web-fetcher/src/action/fetch-action.ts:59](https://github.
|
|
|
109
109
|
|
|
110
110
|
> `optional` **id**: `string`
|
|
111
111
|
|
|
112
|
-
Defined in: [packages/web-fetcher/src/action/fetch-action.ts:47](https://github.com/isdk/web-fetcher.js/blob/
|
|
112
|
+
Defined in: [packages/web-fetcher/src/action/fetch-action.ts:47](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/action/fetch-action.ts#L47)
|
|
113
113
|
|
|
114
114
|
#### Inherited from
|
|
115
115
|
|
|
@@ -121,7 +121,7 @@ Defined in: [packages/web-fetcher/src/action/fetch-action.ts:47](https://github.
|
|
|
121
121
|
|
|
122
122
|
> `optional` **index**: `number`
|
|
123
123
|
|
|
124
|
-
Defined in: [packages/web-fetcher/src/core/context.ts:22](https://github.com/isdk/web-fetcher.js/blob/
|
|
124
|
+
Defined in: [packages/web-fetcher/src/core/context.ts:22](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/core/context.ts#L22)
|
|
125
125
|
|
|
126
126
|
The 0-based index of the action in the execution sequence.
|
|
127
127
|
|
|
@@ -135,7 +135,7 @@ The 0-based index of the action in the execution sequence.
|
|
|
135
135
|
|
|
136
136
|
> `optional` **maxRetries**: `number`
|
|
137
137
|
|
|
138
|
-
Defined in: [packages/web-fetcher/src/action/fetch-action.ts:61](https://github.com/isdk/web-fetcher.js/blob/
|
|
138
|
+
Defined in: [packages/web-fetcher/src/action/fetch-action.ts:61](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/action/fetch-action.ts#L61)
|
|
139
139
|
|
|
140
140
|
#### Inherited from
|
|
141
141
|
|
|
@@ -147,7 +147,7 @@ Defined in: [packages/web-fetcher/src/action/fetch-action.ts:61](https://github.
|
|
|
147
147
|
|
|
148
148
|
> `optional` **name**: `string`
|
|
149
149
|
|
|
150
|
-
Defined in: [packages/web-fetcher/src/action/fetch-action.ts:48](https://github.com/isdk/web-fetcher.js/blob/
|
|
150
|
+
Defined in: [packages/web-fetcher/src/action/fetch-action.ts:48](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/action/fetch-action.ts#L48)
|
|
151
151
|
|
|
152
152
|
#### Inherited from
|
|
153
153
|
|
|
@@ -159,7 +159,7 @@ Defined in: [packages/web-fetcher/src/action/fetch-action.ts:48](https://github.
|
|
|
159
159
|
|
|
160
160
|
> `optional` **params**: `any`
|
|
161
161
|
|
|
162
|
-
Defined in: [packages/web-fetcher/src/action/fetch-action.ts:51](https://github.com/isdk/web-fetcher.js/blob/
|
|
162
|
+
Defined in: [packages/web-fetcher/src/action/fetch-action.ts:51](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/action/fetch-action.ts#L51)
|
|
163
163
|
|
|
164
164
|
#### Inherited from
|
|
165
165
|
|
|
@@ -171,7 +171,7 @@ Defined in: [packages/web-fetcher/src/action/fetch-action.ts:51](https://github.
|
|
|
171
171
|
|
|
172
172
|
> `optional` **storeAs**: `string`
|
|
173
173
|
|
|
174
|
-
Defined in: [packages/web-fetcher/src/action/fetch-action.ts:54](https://github.com/isdk/web-fetcher.js/blob/
|
|
174
|
+
Defined in: [packages/web-fetcher/src/action/fetch-action.ts:54](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/action/fetch-action.ts#L54)
|
|
175
175
|
|
|
176
176
|
#### Inherited from
|
|
177
177
|
|
|
@@ -183,7 +183,7 @@ Defined in: [packages/web-fetcher/src/action/fetch-action.ts:54](https://github.
|
|
|
183
183
|
|
|
184
184
|
> `optional` **timeoutMs**: `number`
|
|
185
185
|
|
|
186
|
-
Defined in: [packages/web-fetcher/src/action/fetch-action.ts:60](https://github.com/isdk/web-fetcher.js/blob/
|
|
186
|
+
Defined in: [packages/web-fetcher/src/action/fetch-action.ts:60](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/action/fetch-action.ts#L60)
|
|
187
187
|
|
|
188
188
|
#### Inherited from
|
|
189
189
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: FetchActionProperties
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/web-fetcher/src/action/fetch-action.ts:86](https://github.com/isdk/web-fetcher.js/blob/
|
|
9
|
+
Defined in: [packages/web-fetcher/src/action/fetch-action.ts:86](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/action/fetch-action.ts#L86)
|
|
10
10
|
|
|
11
11
|
## Extends
|
|
12
12
|
|
|
@@ -26,7 +26,7 @@ Defined in: [packages/web-fetcher/src/action/fetch-action.ts:86](https://github.
|
|
|
26
26
|
|
|
27
27
|
> `optional` **action**: `string` \| [`FetchAction`](../classes/FetchAction.md)
|
|
28
28
|
|
|
29
|
-
Defined in: [packages/web-fetcher/src/action/fetch-action.ts:49](https://github.com/isdk/web-fetcher.js/blob/
|
|
29
|
+
Defined in: [packages/web-fetcher/src/action/fetch-action.ts:49](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/action/fetch-action.ts#L49)
|
|
30
30
|
|
|
31
31
|
#### Inherited from
|
|
32
32
|
|
|
@@ -38,7 +38,7 @@ Defined in: [packages/web-fetcher/src/action/fetch-action.ts:49](https://github.
|
|
|
38
38
|
|
|
39
39
|
> `optional` **args**: `any`
|
|
40
40
|
|
|
41
|
-
Defined in: [packages/web-fetcher/src/action/fetch-action.ts:52](https://github.com/isdk/web-fetcher.js/blob/
|
|
41
|
+
Defined in: [packages/web-fetcher/src/action/fetch-action.ts:52](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/action/fetch-action.ts#L52)
|
|
42
42
|
|
|
43
43
|
#### Inherited from
|
|
44
44
|
|
|
@@ -50,7 +50,7 @@ Defined in: [packages/web-fetcher/src/action/fetch-action.ts:52](https://github.
|
|
|
50
50
|
|
|
51
51
|
> `optional` **collectors**: `_RequireAtLeastOne`\<[`BaseFetchCollectorActionProperties`](BaseFetchCollectorActionProperties.md), `"name"` \| `"id"` \| `"action"`\>[]
|
|
52
52
|
|
|
53
|
-
Defined in: [packages/web-fetcher/src/action/fetch-action.ts:87](https://github.com/isdk/web-fetcher.js/blob/
|
|
53
|
+
Defined in: [packages/web-fetcher/src/action/fetch-action.ts:87](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/action/fetch-action.ts#L87)
|
|
54
54
|
|
|
55
55
|
***
|
|
56
56
|
|
|
@@ -58,7 +58,7 @@ Defined in: [packages/web-fetcher/src/action/fetch-action.ts:87](https://github.
|
|
|
58
58
|
|
|
59
59
|
> `optional` **failOnError**: `boolean`
|
|
60
60
|
|
|
61
|
-
Defined in: [packages/web-fetcher/src/action/fetch-action.ts:57](https://github.com/isdk/web-fetcher.js/blob/
|
|
61
|
+
Defined in: [packages/web-fetcher/src/action/fetch-action.ts:57](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/action/fetch-action.ts#L57)
|
|
62
62
|
|
|
63
63
|
#### Inherited from
|
|
64
64
|
|
|
@@ -70,7 +70,7 @@ Defined in: [packages/web-fetcher/src/action/fetch-action.ts:57](https://github.
|
|
|
70
70
|
|
|
71
71
|
> `optional` **failOnTimeout**: `boolean`
|
|
72
72
|
|
|
73
|
-
Defined in: [packages/web-fetcher/src/action/fetch-action.ts:59](https://github.com/isdk/web-fetcher.js/blob/
|
|
73
|
+
Defined in: [packages/web-fetcher/src/action/fetch-action.ts:59](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/action/fetch-action.ts#L59)
|
|
74
74
|
|
|
75
75
|
#### Inherited from
|
|
76
76
|
|
|
@@ -82,7 +82,7 @@ Defined in: [packages/web-fetcher/src/action/fetch-action.ts:59](https://github.
|
|
|
82
82
|
|
|
83
83
|
> `optional` **id**: `string`
|
|
84
84
|
|
|
85
|
-
Defined in: [packages/web-fetcher/src/action/fetch-action.ts:47](https://github.com/isdk/web-fetcher.js/blob/
|
|
85
|
+
Defined in: [packages/web-fetcher/src/action/fetch-action.ts:47](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/action/fetch-action.ts#L47)
|
|
86
86
|
|
|
87
87
|
#### Inherited from
|
|
88
88
|
|
|
@@ -94,7 +94,7 @@ Defined in: [packages/web-fetcher/src/action/fetch-action.ts:47](https://github.
|
|
|
94
94
|
|
|
95
95
|
> `optional` **index**: `number`
|
|
96
96
|
|
|
97
|
-
Defined in: [packages/web-fetcher/src/action/fetch-action.ts:50](https://github.com/isdk/web-fetcher.js/blob/
|
|
97
|
+
Defined in: [packages/web-fetcher/src/action/fetch-action.ts:50](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/action/fetch-action.ts#L50)
|
|
98
98
|
|
|
99
99
|
#### Inherited from
|
|
100
100
|
|
|
@@ -106,7 +106,7 @@ Defined in: [packages/web-fetcher/src/action/fetch-action.ts:50](https://github.
|
|
|
106
106
|
|
|
107
107
|
> `optional` **maxRetries**: `number`
|
|
108
108
|
|
|
109
|
-
Defined in: [packages/web-fetcher/src/action/fetch-action.ts:61](https://github.com/isdk/web-fetcher.js/blob/
|
|
109
|
+
Defined in: [packages/web-fetcher/src/action/fetch-action.ts:61](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/action/fetch-action.ts#L61)
|
|
110
110
|
|
|
111
111
|
#### Inherited from
|
|
112
112
|
|
|
@@ -118,7 +118,7 @@ Defined in: [packages/web-fetcher/src/action/fetch-action.ts:61](https://github.
|
|
|
118
118
|
|
|
119
119
|
> `optional` **name**: `string`
|
|
120
120
|
|
|
121
|
-
Defined in: [packages/web-fetcher/src/action/fetch-action.ts:48](https://github.com/isdk/web-fetcher.js/blob/
|
|
121
|
+
Defined in: [packages/web-fetcher/src/action/fetch-action.ts:48](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/action/fetch-action.ts#L48)
|
|
122
122
|
|
|
123
123
|
#### Inherited from
|
|
124
124
|
|
|
@@ -130,7 +130,7 @@ Defined in: [packages/web-fetcher/src/action/fetch-action.ts:48](https://github.
|
|
|
130
130
|
|
|
131
131
|
> `optional` **params**: `any`
|
|
132
132
|
|
|
133
|
-
Defined in: [packages/web-fetcher/src/action/fetch-action.ts:51](https://github.com/isdk/web-fetcher.js/blob/
|
|
133
|
+
Defined in: [packages/web-fetcher/src/action/fetch-action.ts:51](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/action/fetch-action.ts#L51)
|
|
134
134
|
|
|
135
135
|
#### Inherited from
|
|
136
136
|
|
|
@@ -142,7 +142,7 @@ Defined in: [packages/web-fetcher/src/action/fetch-action.ts:51](https://github.
|
|
|
142
142
|
|
|
143
143
|
> `optional` **storeAs**: `string`
|
|
144
144
|
|
|
145
|
-
Defined in: [packages/web-fetcher/src/action/fetch-action.ts:54](https://github.com/isdk/web-fetcher.js/blob/
|
|
145
|
+
Defined in: [packages/web-fetcher/src/action/fetch-action.ts:54](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/action/fetch-action.ts#L54)
|
|
146
146
|
|
|
147
147
|
#### Inherited from
|
|
148
148
|
|
|
@@ -154,7 +154,7 @@ Defined in: [packages/web-fetcher/src/action/fetch-action.ts:54](https://github.
|
|
|
154
154
|
|
|
155
155
|
> `optional` **timeoutMs**: `number`
|
|
156
156
|
|
|
157
|
-
Defined in: [packages/web-fetcher/src/action/fetch-action.ts:60](https://github.com/isdk/web-fetcher.js/blob/
|
|
157
|
+
Defined in: [packages/web-fetcher/src/action/fetch-action.ts:60](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/action/fetch-action.ts#L60)
|
|
158
158
|
|
|
159
159
|
#### Inherited from
|
|
160
160
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: FetchActionResult\<R\>
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/web-fetcher/src/action/fetch-action.ts:36](https://github.com/isdk/web-fetcher.js/blob/
|
|
9
|
+
Defined in: [packages/web-fetcher/src/action/fetch-action.ts:36](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/action/fetch-action.ts#L36)
|
|
10
10
|
|
|
11
11
|
## Type Parameters
|
|
12
12
|
|
|
@@ -20,7 +20,7 @@ Defined in: [packages/web-fetcher/src/action/fetch-action.ts:36](https://github.
|
|
|
20
20
|
|
|
21
21
|
> `optional` **error**: `Error`
|
|
22
22
|
|
|
23
|
-
Defined in: [packages/web-fetcher/src/action/fetch-action.ts:42](https://github.com/isdk/web-fetcher.js/blob/
|
|
23
|
+
Defined in: [packages/web-fetcher/src/action/fetch-action.ts:42](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/action/fetch-action.ts#L42)
|
|
24
24
|
|
|
25
25
|
***
|
|
26
26
|
|
|
@@ -28,7 +28,7 @@ Defined in: [packages/web-fetcher/src/action/fetch-action.ts:42](https://github.
|
|
|
28
28
|
|
|
29
29
|
> `optional` **meta**: `FetchActionMeta`
|
|
30
30
|
|
|
31
|
-
Defined in: [packages/web-fetcher/src/action/fetch-action.ts:43](https://github.com/isdk/web-fetcher.js/blob/
|
|
31
|
+
Defined in: [packages/web-fetcher/src/action/fetch-action.ts:43](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/action/fetch-action.ts#L43)
|
|
32
32
|
|
|
33
33
|
***
|
|
34
34
|
|
|
@@ -36,7 +36,7 @@ Defined in: [packages/web-fetcher/src/action/fetch-action.ts:43](https://github.
|
|
|
36
36
|
|
|
37
37
|
> `optional` **result**: [`FetchReturnTypeFor`](../type-aliases/FetchReturnTypeFor.md)\<`R`\>
|
|
38
38
|
|
|
39
|
-
Defined in: [packages/web-fetcher/src/action/fetch-action.ts:41](https://github.com/isdk/web-fetcher.js/blob/
|
|
39
|
+
Defined in: [packages/web-fetcher/src/action/fetch-action.ts:41](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/action/fetch-action.ts#L41)
|
|
40
40
|
|
|
41
41
|
***
|
|
42
42
|
|
|
@@ -44,7 +44,7 @@ Defined in: [packages/web-fetcher/src/action/fetch-action.ts:41](https://github.
|
|
|
44
44
|
|
|
45
45
|
> `optional` **returnType**: `R`
|
|
46
46
|
|
|
47
|
-
Defined in: [packages/web-fetcher/src/action/fetch-action.ts:40](https://github.com/isdk/web-fetcher.js/blob/
|
|
47
|
+
Defined in: [packages/web-fetcher/src/action/fetch-action.ts:40](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/action/fetch-action.ts#L40)
|
|
48
48
|
|
|
49
49
|
***
|
|
50
50
|
|
|
@@ -52,4 +52,4 @@ Defined in: [packages/web-fetcher/src/action/fetch-action.ts:40](https://github.
|
|
|
52
52
|
|
|
53
53
|
> **status**: [`FetchActionResultStatus`](../enumerations/FetchActionResultStatus.md)
|
|
54
54
|
|
|
55
|
-
Defined in: [packages/web-fetcher/src/action/fetch-action.ts:39](https://github.com/isdk/web-fetcher.js/blob/
|
|
55
|
+
Defined in: [packages/web-fetcher/src/action/fetch-action.ts:39](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/action/fetch-action.ts#L39)
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: FetchContext
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/web-fetcher/src/core/context.ts:110](https://github.com/isdk/web-fetcher.js/blob/
|
|
9
|
+
Defined in: [packages/web-fetcher/src/core/context.ts:110](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/core/context.ts#L110)
|
|
10
10
|
|
|
11
11
|
The full execution context for a Web Fetcher session or action batch.
|
|
12
12
|
|
|
@@ -26,7 +26,7 @@ It is passed to every action during execution.
|
|
|
26
26
|
|
|
27
27
|
> `optional` **antibot**: `boolean`
|
|
28
28
|
|
|
29
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:74](https://github.com/isdk/web-fetcher.js/blob/
|
|
29
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:74](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/core/types.ts#L74)
|
|
30
30
|
|
|
31
31
|
#### Inherited from
|
|
32
32
|
|
|
@@ -38,7 +38,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:74](https://github.com/isdk/
|
|
|
38
38
|
|
|
39
39
|
> `optional` **blockResources**: `string`[]
|
|
40
40
|
|
|
41
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:91](https://github.com/isdk/web-fetcher.js/blob/
|
|
41
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:91](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/core/types.ts#L91)
|
|
42
42
|
|
|
43
43
|
#### Inherited from
|
|
44
44
|
|
|
@@ -50,7 +50,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:91](https://github.com/isdk/
|
|
|
50
50
|
|
|
51
51
|
> `optional` **browser**: `object`
|
|
52
52
|
|
|
53
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:101](https://github.com/isdk/web-fetcher.js/blob/
|
|
53
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:101](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/core/types.ts#L101)
|
|
54
54
|
|
|
55
55
|
#### engine?
|
|
56
56
|
|
|
@@ -65,6 +65,10 @@ Defined in: [packages/web-fetcher/src/core/types.ts:101](https://github.com/isdk
|
|
|
65
65
|
|
|
66
66
|
> `optional` **headless**: `boolean`
|
|
67
67
|
|
|
68
|
+
#### launchOptions?
|
|
69
|
+
|
|
70
|
+
> `optional` **launchOptions**: `Record`\<`string`, `any`\>
|
|
71
|
+
|
|
68
72
|
#### waitUntil?
|
|
69
73
|
|
|
70
74
|
> `optional` **waitUntil**: `"load"` \| `"domcontentloaded"` \| `"networkidle"` \| `"commit"`
|
|
@@ -79,7 +83,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:101](https://github.com/isdk
|
|
|
79
83
|
|
|
80
84
|
> `optional` **cookies**: [`Cookie`](Cookie.md)[]
|
|
81
85
|
|
|
82
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:78](https://github.com/isdk/web-fetcher.js/blob/
|
|
86
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:78](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/core/types.ts#L78)
|
|
83
87
|
|
|
84
88
|
#### Inherited from
|
|
85
89
|
|
|
@@ -91,7 +95,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:78](https://github.com/isdk/
|
|
|
91
95
|
|
|
92
96
|
> `optional` **currentAction**: [`FetchActionInContext`](FetchActionInContext.md)
|
|
93
97
|
|
|
94
|
-
Defined in: [packages/web-fetcher/src/core/context.ts:114](https://github.com/isdk/web-fetcher.js/blob/
|
|
98
|
+
Defined in: [packages/web-fetcher/src/core/context.ts:114](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/core/context.ts#L114)
|
|
95
99
|
|
|
96
100
|
Metadata about the action currently being executed.
|
|
97
101
|
|
|
@@ -101,7 +105,7 @@ Metadata about the action currently being executed.
|
|
|
101
105
|
|
|
102
106
|
> `optional` **debug**: `string` \| `boolean` \| `string`[]
|
|
103
107
|
|
|
104
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:75](https://github.com/isdk/web-fetcher.js/blob/
|
|
108
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:75](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/core/types.ts#L75)
|
|
105
109
|
|
|
106
110
|
#### Inherited from
|
|
107
111
|
|
|
@@ -113,7 +117,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:75](https://github.com/isdk/
|
|
|
113
117
|
|
|
114
118
|
> `optional` **delayBetweenRequestsMs**: `number`
|
|
115
119
|
|
|
116
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
120
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:123](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/core/types.ts#L123)
|
|
117
121
|
|
|
118
122
|
#### Inherited from
|
|
119
123
|
|
|
@@ -125,7 +129,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:122](https://github.com/isdk
|
|
|
125
129
|
|
|
126
130
|
> `optional` **enableSmart**: `boolean`
|
|
127
131
|
|
|
128
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:72](https://github.com/isdk/web-fetcher.js/blob/
|
|
132
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:72](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/core/types.ts#L72)
|
|
129
133
|
|
|
130
134
|
#### Inherited from
|
|
131
135
|
|
|
@@ -137,7 +141,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:72](https://github.com/isdk/
|
|
|
137
141
|
|
|
138
142
|
> `optional` **engine**: `string`
|
|
139
143
|
|
|
140
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:71](https://github.com/isdk/web-fetcher.js/blob/
|
|
144
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:71](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/core/types.ts#L71)
|
|
141
145
|
|
|
142
146
|
抓取模式
|
|
143
147
|
|
|
@@ -155,7 +159,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:71](https://github.com/isdk/
|
|
|
155
159
|
|
|
156
160
|
> **eventBus**: `EventEmitter`
|
|
157
161
|
|
|
158
|
-
Defined in: [packages/web-fetcher/src/core/context.ts:154](https://github.com/isdk/web-fetcher.js/blob/
|
|
162
|
+
Defined in: [packages/web-fetcher/src/core/context.ts:154](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/core/context.ts#L154)
|
|
159
163
|
|
|
160
164
|
The central event bus for publishing and subscribing to session and action events.
|
|
161
165
|
|
|
@@ -165,7 +169,7 @@ The central event bus for publishing and subscribing to session and action event
|
|
|
165
169
|
|
|
166
170
|
> `optional` **finalUrl**: `string`
|
|
167
171
|
|
|
168
|
-
Defined in: [packages/web-fetcher/src/core/context.ts:85](https://github.com/isdk/web-fetcher.js/blob/
|
|
172
|
+
Defined in: [packages/web-fetcher/src/core/context.ts:85](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/core/context.ts#L85)
|
|
169
173
|
|
|
170
174
|
The final URL after all redirects have been followed.
|
|
171
175
|
|
|
@@ -179,7 +183,7 @@ The final URL after all redirects have been followed.
|
|
|
179
183
|
|
|
180
184
|
> `optional` **headers**: `Record`\<`string`, `string`\>
|
|
181
185
|
|
|
182
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:77](https://github.com/isdk/web-fetcher.js/blob/
|
|
186
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:77](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/core/types.ts#L77)
|
|
183
187
|
|
|
184
188
|
#### Inherited from
|
|
185
189
|
|
|
@@ -191,7 +195,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:77](https://github.com/isdk/
|
|
|
191
195
|
|
|
192
196
|
> `optional` **http**: `object`
|
|
193
197
|
|
|
194
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
198
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:114](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/core/types.ts#L114)
|
|
195
199
|
|
|
196
200
|
#### body?
|
|
197
201
|
|
|
@@ -211,7 +215,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:113](https://github.com/isdk
|
|
|
211
215
|
|
|
212
216
|
> **id**: `string`
|
|
213
217
|
|
|
214
|
-
Defined in: [packages/web-fetcher/src/core/context.ts:77](https://github.com/isdk/web-fetcher.js/blob/
|
|
218
|
+
Defined in: [packages/web-fetcher/src/core/context.ts:77](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/core/context.ts#L77)
|
|
215
219
|
|
|
216
220
|
Unique identifier for the session or request batch.
|
|
217
221
|
|
|
@@ -225,7 +229,7 @@ Unique identifier for the session or request batch.
|
|
|
225
229
|
|
|
226
230
|
> `optional` **ignoreSslErrors**: `boolean`
|
|
227
231
|
|
|
228
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:99](https://github.com/isdk/web-fetcher.js/blob/
|
|
232
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:99](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/core/types.ts#L99)
|
|
229
233
|
|
|
230
234
|
#### Inherited from
|
|
231
235
|
|
|
@@ -237,7 +241,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:99](https://github.com/isdk/
|
|
|
237
241
|
|
|
238
242
|
> **internal**: `FetchContextInteralState`
|
|
239
243
|
|
|
240
|
-
Defined in: [packages/web-fetcher/src/core/context.ts:149](https://github.com/isdk/web-fetcher.js/blob/
|
|
244
|
+
Defined in: [packages/web-fetcher/src/core/context.ts:149](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/core/context.ts#L149)
|
|
241
245
|
|
|
242
246
|
Internal state for engine and lifecycle management.
|
|
243
247
|
|
|
@@ -251,7 +255,7 @@ Internal state for engine and lifecycle management.
|
|
|
251
255
|
|
|
252
256
|
> `optional` **lastResponse**: [`FetchResponse`](FetchResponse.md)
|
|
253
257
|
|
|
254
|
-
Defined in: [packages/web-fetcher/src/core/context.ts:90](https://github.com/isdk/web-fetcher.js/blob/
|
|
258
|
+
Defined in: [packages/web-fetcher/src/core/context.ts:90](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/core/context.ts#L90)
|
|
255
259
|
|
|
256
260
|
The standardized response object from the most recent navigation.
|
|
257
261
|
|
|
@@ -265,7 +269,7 @@ The standardized response object from the most recent navigation.
|
|
|
265
269
|
|
|
266
270
|
> `optional` **lastResult**: [`FetchActionResult`](FetchActionResult.md)\<[`FetchReturnType`](../type-aliases/FetchReturnType.md)\>
|
|
267
271
|
|
|
268
|
-
Defined in: [packages/web-fetcher/src/core/context.ts:94](https://github.com/isdk/web-fetcher.js/blob/
|
|
272
|
+
Defined in: [packages/web-fetcher/src/core/context.ts:94](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/core/context.ts#L94)
|
|
269
273
|
|
|
270
274
|
The result object from the most recent action execution.
|
|
271
275
|
|
|
@@ -279,7 +283,7 @@ The result object from the most recent action execution.
|
|
|
279
283
|
|
|
280
284
|
> `optional` **maxConcurrency**: `number`
|
|
281
285
|
|
|
282
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
286
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:121](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/core/types.ts#L121)
|
|
283
287
|
|
|
284
288
|
#### Inherited from
|
|
285
289
|
|
|
@@ -291,7 +295,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:120](https://github.com/isdk
|
|
|
291
295
|
|
|
292
296
|
> `optional` **maxRequestsPerMinute**: `number`
|
|
293
297
|
|
|
294
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
298
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:122](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/core/types.ts#L122)
|
|
295
299
|
|
|
296
300
|
#### Inherited from
|
|
297
301
|
|
|
@@ -303,7 +307,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:121](https://github.com/isdk
|
|
|
303
307
|
|
|
304
308
|
> `optional` **output**: `object`
|
|
305
309
|
|
|
306
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:84](https://github.com/isdk/web-fetcher.js/blob/
|
|
310
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:84](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/core/types.ts#L84)
|
|
307
311
|
|
|
308
312
|
#### cookies?
|
|
309
313
|
|
|
@@ -323,7 +327,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:84](https://github.com/isdk/
|
|
|
323
327
|
|
|
324
328
|
> **outputs**: `Record`\<`string`, `any`\>
|
|
325
329
|
|
|
326
|
-
Defined in: [packages/web-fetcher/src/core/context.ts:120](https://github.com/isdk/web-fetcher.js/blob/
|
|
330
|
+
Defined in: [packages/web-fetcher/src/core/context.ts:120](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/core/context.ts#L120)
|
|
327
331
|
|
|
328
332
|
A shared key-value store for storing data extracted from pages or
|
|
329
333
|
metadata generated during action execution.
|
|
@@ -334,7 +338,7 @@ metadata generated during action execution.
|
|
|
334
338
|
|
|
335
339
|
> `optional` **overrideSessionState**: `boolean`
|
|
336
340
|
|
|
337
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:81](https://github.com/isdk/web-fetcher.js/blob/
|
|
341
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:81](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/core/types.ts#L81)
|
|
338
342
|
|
|
339
343
|
#### Inherited from
|
|
340
344
|
|
|
@@ -346,7 +350,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:81](https://github.com/isdk/
|
|
|
346
350
|
|
|
347
351
|
> `optional` **proxy**: `string` \| `string`[]
|
|
348
352
|
|
|
349
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:89](https://github.com/isdk/web-fetcher.js/blob/
|
|
353
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:89](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/core/types.ts#L89)
|
|
350
354
|
|
|
351
355
|
#### Inherited from
|
|
352
356
|
|
|
@@ -358,7 +362,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:89](https://github.com/isdk/
|
|
|
358
362
|
|
|
359
363
|
> `optional` **requestHandlerTimeoutSecs**: `number`
|
|
360
364
|
|
|
361
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
365
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:120](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/core/types.ts#L120)
|
|
362
366
|
|
|
363
367
|
#### Inherited from
|
|
364
368
|
|
|
@@ -370,7 +374,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:119](https://github.com/isdk
|
|
|
370
374
|
|
|
371
375
|
> `optional` **retries**: `number`
|
|
372
376
|
|
|
373
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
377
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:124](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/core/types.ts#L124)
|
|
374
378
|
|
|
375
379
|
#### Inherited from
|
|
376
380
|
|
|
@@ -382,7 +386,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:123](https://github.com/isdk
|
|
|
382
386
|
|
|
383
387
|
> `optional` **sessionPoolOptions**: `SessionPoolOptions`
|
|
384
388
|
|
|
385
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:80](https://github.com/isdk/web-fetcher.js/blob/
|
|
389
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:80](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/core/types.ts#L80)
|
|
386
390
|
|
|
387
391
|
#### Inherited from
|
|
388
392
|
|
|
@@ -394,7 +398,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:80](https://github.com/isdk/
|
|
|
394
398
|
|
|
395
399
|
> `optional` **sessionState**: `any`
|
|
396
400
|
|
|
397
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:79](https://github.com/isdk/web-fetcher.js/blob/
|
|
401
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:79](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/core/types.ts#L79)
|
|
398
402
|
|
|
399
403
|
#### Inherited from
|
|
400
404
|
|
|
@@ -406,7 +410,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:79](https://github.com/isdk/
|
|
|
406
410
|
|
|
407
411
|
> `optional` **sites**: [`FetchSite`](FetchSite.md)[]
|
|
408
412
|
|
|
409
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
413
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:126](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/core/types.ts#L126)
|
|
410
414
|
|
|
411
415
|
#### Inherited from
|
|
412
416
|
|
|
@@ -418,7 +422,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:125](https://github.com/isdk
|
|
|
418
422
|
|
|
419
423
|
> `optional` **storage**: [`StorageOptions`](StorageOptions.md)
|
|
420
424
|
|
|
421
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:96](https://github.com/isdk/web-fetcher.js/blob/
|
|
425
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:96](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/core/types.ts#L96)
|
|
422
426
|
|
|
423
427
|
Storage configuration for session isolation and persistence.
|
|
424
428
|
|
|
@@ -432,7 +436,7 @@ Storage configuration for session isolation and persistence.
|
|
|
432
436
|
|
|
433
437
|
> `optional` **throwHttpErrors**: `boolean`
|
|
434
438
|
|
|
435
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:82](https://github.com/isdk/web-fetcher.js/blob/
|
|
439
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:82](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/core/types.ts#L82)
|
|
436
440
|
|
|
437
441
|
#### Inherited from
|
|
438
442
|
|
|
@@ -444,7 +448,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:82](https://github.com/isdk/
|
|
|
444
448
|
|
|
445
449
|
> `optional` **timeoutMs**: `number`
|
|
446
450
|
|
|
447
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
451
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:119](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/core/types.ts#L119)
|
|
448
452
|
|
|
449
453
|
#### Inherited from
|
|
450
454
|
|
|
@@ -456,7 +460,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:118](https://github.com/isdk
|
|
|
456
460
|
|
|
457
461
|
> `optional` **url**: `string`
|
|
458
462
|
|
|
459
|
-
Defined in: [packages/web-fetcher/src/core/context.ts:81](https://github.com/isdk/web-fetcher.js/blob/
|
|
463
|
+
Defined in: [packages/web-fetcher/src/core/context.ts:81](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/core/context.ts#L81)
|
|
460
464
|
|
|
461
465
|
The target URL for the next navigation, if specified.
|
|
462
466
|
|
|
@@ -470,7 +474,7 @@ The target URL for the next navigation, if specified.
|
|
|
470
474
|
|
|
471
475
|
> `optional` **useSiteRegistry**: `boolean`
|
|
472
476
|
|
|
473
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:73](https://github.com/isdk/web-fetcher.js/blob/
|
|
477
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:73](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/core/types.ts#L73)
|
|
474
478
|
|
|
475
479
|
#### Inherited from
|
|
476
480
|
|
|
@@ -482,7 +486,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:73](https://github.com/isdk/
|
|
|
482
486
|
|
|
483
487
|
> **action**\<`R`\>(`name`, `params?`, `options?`): `Promise`\<[`FetchActionResult`](FetchActionResult.md)\<`R`\>\>
|
|
484
488
|
|
|
485
|
-
Defined in: [packages/web-fetcher/src/core/context.ts:140](https://github.com/isdk/web-fetcher.js/blob/
|
|
489
|
+
Defined in: [packages/web-fetcher/src/core/context.ts:140](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/core/context.ts#L140)
|
|
486
490
|
|
|
487
491
|
Convenience method to execute an action by its registered name or ID.
|
|
488
492
|
|
|
@@ -524,7 +528,7 @@ A promise that resolves to the action's result.
|
|
|
524
528
|
|
|
525
529
|
> **execute**\<`R`\>(`actionOptions`): `Promise`\<[`FetchActionResult`](FetchActionResult.md)\<`R`\>\>
|
|
526
530
|
|
|
527
|
-
Defined in: [packages/web-fetcher/src/core/context.ts:128](https://github.com/isdk/web-fetcher.js/blob/
|
|
531
|
+
Defined in: [packages/web-fetcher/src/core/context.ts:128](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/core/context.ts#L128)
|
|
528
532
|
|
|
529
533
|
Executes a FetchAction within the current context.
|
|
530
534
|
|