@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: BaseFetchCollectorActionProperties
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/web-fetcher/src/
|
|
9
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:69](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L69)
|
|
10
10
|
|
|
11
11
|
## Extends
|
|
12
12
|
|
|
@@ -20,9 +20,9 @@ Defined in: [packages/web-fetcher/src/action/fetch-action.ts:69](https://github.
|
|
|
20
20
|
|
|
21
21
|
### action?
|
|
22
22
|
|
|
23
|
-
> `optional` **action**: `
|
|
23
|
+
> `optional` **action**: `any`
|
|
24
24
|
|
|
25
|
-
Defined in: [packages/web-fetcher/src/
|
|
25
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:49](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L49)
|
|
26
26
|
|
|
27
27
|
#### Inherited from
|
|
28
28
|
|
|
@@ -34,7 +34,7 @@ Defined in: [packages/web-fetcher/src/action/fetch-action.ts:49](https://github.
|
|
|
34
34
|
|
|
35
35
|
> `optional` **activateOn**: `string` \| `RegExp` \| (`string` \| `RegExp`)[]
|
|
36
36
|
|
|
37
|
-
Defined in: [packages/web-fetcher/src/
|
|
37
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:72](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L72)
|
|
38
38
|
|
|
39
39
|
***
|
|
40
40
|
|
|
@@ -42,7 +42,7 @@ Defined in: [packages/web-fetcher/src/action/fetch-action.ts:72](https://github.
|
|
|
42
42
|
|
|
43
43
|
> `optional` **args**: `any`
|
|
44
44
|
|
|
45
|
-
Defined in: [packages/web-fetcher/src/
|
|
45
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:52](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L52)
|
|
46
46
|
|
|
47
47
|
#### Inherited from
|
|
48
48
|
|
|
@@ -54,7 +54,7 @@ Defined in: [packages/web-fetcher/src/action/fetch-action.ts:52](https://github.
|
|
|
54
54
|
|
|
55
55
|
> `optional` **background**: `boolean`
|
|
56
56
|
|
|
57
|
-
Defined in: [packages/web-fetcher/src/
|
|
57
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:78](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L78)
|
|
58
58
|
|
|
59
59
|
***
|
|
60
60
|
|
|
@@ -62,7 +62,7 @@ Defined in: [packages/web-fetcher/src/action/fetch-action.ts:78](https://github.
|
|
|
62
62
|
|
|
63
63
|
> `optional` **collectOn**: `string` \| `RegExp` \| (`string` \| `RegExp`)[]
|
|
64
64
|
|
|
65
|
-
Defined in: [packages/web-fetcher/src/
|
|
65
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:76](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L76)
|
|
66
66
|
|
|
67
67
|
***
|
|
68
68
|
|
|
@@ -70,7 +70,7 @@ Defined in: [packages/web-fetcher/src/action/fetch-action.ts:76](https://github.
|
|
|
70
70
|
|
|
71
71
|
> `optional` **deactivateOn**: `string` \| `RegExp` \| (`string` \| `RegExp`)[]
|
|
72
72
|
|
|
73
|
-
Defined in: [packages/web-fetcher/src/
|
|
73
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:74](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L74)
|
|
74
74
|
|
|
75
75
|
***
|
|
76
76
|
|
|
@@ -78,7 +78,7 @@ Defined in: [packages/web-fetcher/src/action/fetch-action.ts:74](https://github.
|
|
|
78
78
|
|
|
79
79
|
> `optional` **failOnError**: `boolean`
|
|
80
80
|
|
|
81
|
-
Defined in: [packages/web-fetcher/src/
|
|
81
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:57](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L57)
|
|
82
82
|
|
|
83
83
|
#### Inherited from
|
|
84
84
|
|
|
@@ -90,7 +90,7 @@ Defined in: [packages/web-fetcher/src/action/fetch-action.ts:57](https://github.
|
|
|
90
90
|
|
|
91
91
|
> `optional` **failOnTimeout**: `boolean`
|
|
92
92
|
|
|
93
|
-
Defined in: [packages/web-fetcher/src/
|
|
93
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:59](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L59)
|
|
94
94
|
|
|
95
95
|
#### Inherited from
|
|
96
96
|
|
|
@@ -102,7 +102,7 @@ Defined in: [packages/web-fetcher/src/action/fetch-action.ts:59](https://github.
|
|
|
102
102
|
|
|
103
103
|
> `optional` **id**: `string`
|
|
104
104
|
|
|
105
|
-
Defined in: [packages/web-fetcher/src/
|
|
105
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:47](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L47)
|
|
106
106
|
|
|
107
107
|
#### Inherited from
|
|
108
108
|
|
|
@@ -114,7 +114,7 @@ Defined in: [packages/web-fetcher/src/action/fetch-action.ts:47](https://github.
|
|
|
114
114
|
|
|
115
115
|
> `optional` **index**: `number`
|
|
116
116
|
|
|
117
|
-
Defined in: [packages/web-fetcher/src/
|
|
117
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:50](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L50)
|
|
118
118
|
|
|
119
119
|
#### Inherited from
|
|
120
120
|
|
|
@@ -126,7 +126,7 @@ Defined in: [packages/web-fetcher/src/action/fetch-action.ts:50](https://github.
|
|
|
126
126
|
|
|
127
127
|
> `optional` **maxRetries**: `number`
|
|
128
128
|
|
|
129
|
-
Defined in: [packages/web-fetcher/src/
|
|
129
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:61](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L61)
|
|
130
130
|
|
|
131
131
|
#### Inherited from
|
|
132
132
|
|
|
@@ -138,7 +138,7 @@ Defined in: [packages/web-fetcher/src/action/fetch-action.ts:61](https://github.
|
|
|
138
138
|
|
|
139
139
|
> `optional` **name**: `string`
|
|
140
140
|
|
|
141
|
-
Defined in: [packages/web-fetcher/src/
|
|
141
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:48](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L48)
|
|
142
142
|
|
|
143
143
|
#### Inherited from
|
|
144
144
|
|
|
@@ -150,7 +150,7 @@ Defined in: [packages/web-fetcher/src/action/fetch-action.ts:48](https://github.
|
|
|
150
150
|
|
|
151
151
|
> `optional` **params**: `any`
|
|
152
152
|
|
|
153
|
-
Defined in: [packages/web-fetcher/src/
|
|
153
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:51](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L51)
|
|
154
154
|
|
|
155
155
|
#### Inherited from
|
|
156
156
|
|
|
@@ -162,7 +162,7 @@ Defined in: [packages/web-fetcher/src/action/fetch-action.ts:51](https://github.
|
|
|
162
162
|
|
|
163
163
|
> `optional` **storeAs**: `string`
|
|
164
164
|
|
|
165
|
-
Defined in: [packages/web-fetcher/src/
|
|
165
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:54](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L54)
|
|
166
166
|
|
|
167
167
|
#### Inherited from
|
|
168
168
|
|
|
@@ -174,7 +174,7 @@ Defined in: [packages/web-fetcher/src/action/fetch-action.ts:54](https://github.
|
|
|
174
174
|
|
|
175
175
|
> `optional` **timeoutMs**: `number`
|
|
176
176
|
|
|
177
|
-
Defined in: [packages/web-fetcher/src/
|
|
177
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:60](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L60)
|
|
178
178
|
|
|
179
179
|
#### Inherited from
|
|
180
180
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: BaseFetcherProperties
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
9
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:146](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L146)
|
|
10
10
|
|
|
11
11
|
## Extended by
|
|
12
12
|
|
|
@@ -20,7 +20,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:63](https://github.com/isdk/
|
|
|
20
20
|
|
|
21
21
|
> `optional` **antibot**: `boolean`
|
|
22
22
|
|
|
23
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
23
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:159](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L159)
|
|
24
24
|
|
|
25
25
|
***
|
|
26
26
|
|
|
@@ -28,7 +28,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:74](https://github.com/isdk/
|
|
|
28
28
|
|
|
29
29
|
> `optional` **blockResources**: `string`[]
|
|
30
30
|
|
|
31
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
31
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:176](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L176)
|
|
32
32
|
|
|
33
33
|
***
|
|
34
34
|
|
|
@@ -36,7 +36,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:91](https://github.com/isdk/
|
|
|
36
36
|
|
|
37
37
|
> `optional` **browser**: `object`
|
|
38
38
|
|
|
39
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
39
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:186](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L186)
|
|
40
40
|
|
|
41
41
|
#### engine?
|
|
42
42
|
|
|
@@ -65,7 +65,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:101](https://github.com/isdk
|
|
|
65
65
|
|
|
66
66
|
> `optional` **cookies**: [`Cookie`](Cookie.md)[]
|
|
67
67
|
|
|
68
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
68
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:163](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L163)
|
|
69
69
|
|
|
70
70
|
***
|
|
71
71
|
|
|
@@ -73,7 +73,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:78](https://github.com/isdk/
|
|
|
73
73
|
|
|
74
74
|
> `optional` **debug**: `string` \| `boolean` \| `string`[]
|
|
75
75
|
|
|
76
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
76
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:160](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L160)
|
|
77
77
|
|
|
78
78
|
***
|
|
79
79
|
|
|
@@ -81,7 +81,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:75](https://github.com/isdk/
|
|
|
81
81
|
|
|
82
82
|
> `optional` **delayBetweenRequestsMs**: `number`
|
|
83
83
|
|
|
84
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
84
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:208](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L208)
|
|
85
85
|
|
|
86
86
|
***
|
|
87
87
|
|
|
@@ -89,7 +89,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:123](https://github.com/isdk
|
|
|
89
89
|
|
|
90
90
|
> `optional` **enableSmart**: `boolean`
|
|
91
91
|
|
|
92
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
92
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:155](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L155)
|
|
93
93
|
|
|
94
94
|
***
|
|
95
95
|
|
|
@@ -97,7 +97,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:72](https://github.com/isdk/
|
|
|
97
97
|
|
|
98
98
|
> `optional` **engine**: `string`
|
|
99
99
|
|
|
100
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
100
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:154](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L154)
|
|
101
101
|
|
|
102
102
|
抓取模式
|
|
103
103
|
|
|
@@ -111,7 +111,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:71](https://github.com/isdk/
|
|
|
111
111
|
|
|
112
112
|
> `optional` **headers**: `Record`\<`string`, `string`\>
|
|
113
113
|
|
|
114
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
114
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:162](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L162)
|
|
115
115
|
|
|
116
116
|
***
|
|
117
117
|
|
|
@@ -119,7 +119,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:77](https://github.com/isdk/
|
|
|
119
119
|
|
|
120
120
|
> `optional` **http**: `object`
|
|
121
121
|
|
|
122
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
122
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:199](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L199)
|
|
123
123
|
|
|
124
124
|
#### body?
|
|
125
125
|
|
|
@@ -127,7 +127,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:114](https://github.com/isdk
|
|
|
127
127
|
|
|
128
128
|
#### method?
|
|
129
129
|
|
|
130
|
-
> `optional` **method**: `"GET"` \| `"POST"` \| `"PUT"` \| `"
|
|
130
|
+
> `optional` **method**: `"GET"` \| `"POST"` \| `"PUT"` \| `"PATCH"` \| `"DELETE"`
|
|
131
131
|
|
|
132
132
|
***
|
|
133
133
|
|
|
@@ -135,7 +135,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:114](https://github.com/isdk
|
|
|
135
135
|
|
|
136
136
|
> `optional` **ignoreSslErrors**: `boolean`
|
|
137
137
|
|
|
138
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
138
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:184](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L184)
|
|
139
139
|
|
|
140
140
|
***
|
|
141
141
|
|
|
@@ -143,7 +143,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:99](https://github.com/isdk/
|
|
|
143
143
|
|
|
144
144
|
> `optional` **maxConcurrency**: `number`
|
|
145
145
|
|
|
146
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
146
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:206](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L206)
|
|
147
147
|
|
|
148
148
|
***
|
|
149
149
|
|
|
@@ -151,7 +151,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:121](https://github.com/isdk
|
|
|
151
151
|
|
|
152
152
|
> `optional` **maxRequestsPerMinute**: `number`
|
|
153
153
|
|
|
154
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
154
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:207](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L207)
|
|
155
155
|
|
|
156
156
|
***
|
|
157
157
|
|
|
@@ -159,7 +159,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:122](https://github.com/isdk
|
|
|
159
159
|
|
|
160
160
|
> `optional` **output**: `object`
|
|
161
161
|
|
|
162
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
162
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:169](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L169)
|
|
163
163
|
|
|
164
164
|
#### cookies?
|
|
165
165
|
|
|
@@ -175,7 +175,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:84](https://github.com/isdk/
|
|
|
175
175
|
|
|
176
176
|
> `optional` **overrideSessionState**: `boolean`
|
|
177
177
|
|
|
178
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
178
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:166](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L166)
|
|
179
179
|
|
|
180
180
|
***
|
|
181
181
|
|
|
@@ -183,7 +183,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:81](https://github.com/isdk/
|
|
|
183
183
|
|
|
184
184
|
> `optional` **proxy**: `string` \| `string`[]
|
|
185
185
|
|
|
186
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
186
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:174](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L174)
|
|
187
187
|
|
|
188
188
|
***
|
|
189
189
|
|
|
@@ -191,7 +191,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:89](https://github.com/isdk/
|
|
|
191
191
|
|
|
192
192
|
> `optional` **requestHandlerTimeoutSecs**: `number`
|
|
193
193
|
|
|
194
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
194
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:205](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L205)
|
|
195
195
|
|
|
196
196
|
***
|
|
197
197
|
|
|
@@ -199,7 +199,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:120](https://github.com/isdk
|
|
|
199
199
|
|
|
200
200
|
> `optional` **retries**: `number`
|
|
201
201
|
|
|
202
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
202
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:209](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L209)
|
|
203
203
|
|
|
204
204
|
***
|
|
205
205
|
|
|
@@ -207,7 +207,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:124](https://github.com/isdk
|
|
|
207
207
|
|
|
208
208
|
> `optional` **sessionPoolOptions**: `SessionPoolOptions`
|
|
209
209
|
|
|
210
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
210
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:165](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L165)
|
|
211
211
|
|
|
212
212
|
***
|
|
213
213
|
|
|
@@ -215,7 +215,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:80](https://github.com/isdk/
|
|
|
215
215
|
|
|
216
216
|
> `optional` **sessionState**: `any`
|
|
217
217
|
|
|
218
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
218
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:164](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L164)
|
|
219
219
|
|
|
220
220
|
***
|
|
221
221
|
|
|
@@ -223,7 +223,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:79](https://github.com/isdk/
|
|
|
223
223
|
|
|
224
224
|
> `optional` **sites**: [`FetchSite`](FetchSite.md)[]
|
|
225
225
|
|
|
226
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
226
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:211](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L211)
|
|
227
227
|
|
|
228
228
|
***
|
|
229
229
|
|
|
@@ -231,17 +231,25 @@ Defined in: [packages/web-fetcher/src/core/types.ts:126](https://github.com/isdk
|
|
|
231
231
|
|
|
232
232
|
> `optional` **storage**: [`StorageOptions`](StorageOptions.md)
|
|
233
233
|
|
|
234
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
234
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:181](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L181)
|
|
235
235
|
|
|
236
236
|
Storage configuration for session isolation and persistence.
|
|
237
237
|
|
|
238
238
|
***
|
|
239
239
|
|
|
240
|
+
### syncStateOnUpgrade?
|
|
241
|
+
|
|
242
|
+
> `optional` **syncStateOnUpgrade**: `boolean`
|
|
243
|
+
|
|
244
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:156](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L156)
|
|
245
|
+
|
|
246
|
+
***
|
|
247
|
+
|
|
240
248
|
### throwHttpErrors?
|
|
241
249
|
|
|
242
250
|
> `optional` **throwHttpErrors**: `boolean`
|
|
243
251
|
|
|
244
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
252
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:167](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L167)
|
|
245
253
|
|
|
246
254
|
***
|
|
247
255
|
|
|
@@ -249,7 +257,15 @@ Defined in: [packages/web-fetcher/src/core/types.ts:82](https://github.com/isdk/
|
|
|
249
257
|
|
|
250
258
|
> `optional` **timeoutMs**: `number`
|
|
251
259
|
|
|
252
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
260
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:204](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L204)
|
|
261
|
+
|
|
262
|
+
***
|
|
263
|
+
|
|
264
|
+
### upgradeThresholdMs?
|
|
265
|
+
|
|
266
|
+
> `optional` **upgradeThresholdMs**: `number`
|
|
267
|
+
|
|
268
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:157](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L157)
|
|
253
269
|
|
|
254
270
|
***
|
|
255
271
|
|
|
@@ -257,7 +273,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:119](https://github.com/isdk
|
|
|
257
273
|
|
|
258
274
|
> `optional` **url**: `string`
|
|
259
275
|
|
|
260
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
276
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:212](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L212)
|
|
261
277
|
|
|
262
278
|
***
|
|
263
279
|
|
|
@@ -265,4 +281,4 @@ Defined in: [packages/web-fetcher/src/core/types.ts:127](https://github.com/isdk
|
|
|
265
281
|
|
|
266
282
|
> `optional` **useSiteRegistry**: `boolean`
|
|
267
283
|
|
|
268
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
284
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:158](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L158)
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: DispatchedEngineAction
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
9
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:259](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/engine/base.ts#L259)
|
|
10
10
|
|
|
11
11
|
Represents an action that has been dispatched and is awaiting execution in the active page context.
|
|
12
12
|
|
|
@@ -21,7 +21,7 @@ to handle promises while maintaining the page context validity window.
|
|
|
21
21
|
|
|
22
22
|
> **action**: [`FetchEngineAction`](../type-aliases/FetchEngineAction.md)
|
|
23
23
|
|
|
24
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
24
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:260](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/engine/base.ts#L260)
|
|
25
25
|
|
|
26
26
|
***
|
|
27
27
|
|
|
@@ -29,7 +29,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:247](https://github.com/isd
|
|
|
29
29
|
|
|
30
30
|
> **reject**: (`reason?`) => `void`
|
|
31
31
|
|
|
32
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
32
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:262](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/engine/base.ts#L262)
|
|
33
33
|
|
|
34
34
|
#### Parameters
|
|
35
35
|
|
|
@@ -47,7 +47,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:249](https://github.com/isd
|
|
|
47
47
|
|
|
48
48
|
> **resolve**: (`value?`) => `void`
|
|
49
49
|
|
|
50
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
50
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:261](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/engine/base.ts#L261)
|
|
51
51
|
|
|
52
52
|
#### Parameters
|
|
53
53
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: EvaluateActionOptions
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:179](https://github.com/isdk/web-fetcher.js/blob/
|
|
9
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:179](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/engine/base.ts#L179)
|
|
10
10
|
|
|
11
11
|
Options for the [FetchEngine.evaluate](../classes/FetchEngine.md#evaluate) action, specifying the function to execute and its arguments.
|
|
12
12
|
|
|
@@ -51,7 +51,7 @@ automatically detect the change, trigger a navigation, and wait for the new page
|
|
|
51
51
|
|
|
52
52
|
> `optional` **args**: `any`
|
|
53
53
|
|
|
54
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:200](https://github.com/isdk/web-fetcher.js/blob/
|
|
54
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:200](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/engine/base.ts#L200)
|
|
55
55
|
|
|
56
56
|
Data to pass to the function.
|
|
57
57
|
|
|
@@ -66,7 +66,7 @@ Recommended to use an array or object for multiple values.
|
|
|
66
66
|
|
|
67
67
|
> **fn**: `string` \| (...`args`) => `any`
|
|
68
68
|
|
|
69
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:192](https://github.com/isdk/web-fetcher.js/blob/
|
|
69
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:192](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/engine/base.ts#L192)
|
|
70
70
|
|
|
71
71
|
The function or expression to execute.
|
|
72
72
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: ExtractActionProperties
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/web-fetcher/src/action/definitions/extract.ts:5](https://github.com/isdk/web-fetcher.js/blob/
|
|
9
|
+
Defined in: [packages/web-fetcher/src/action/definitions/extract.ts:5](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/action/definitions/extract.ts#L5)
|
|
10
10
|
|
|
11
11
|
## Extends
|
|
12
12
|
|
|
@@ -20,9 +20,9 @@ Defined in: [packages/web-fetcher/src/action/definitions/extract.ts:5](https://g
|
|
|
20
20
|
|
|
21
21
|
### action?
|
|
22
22
|
|
|
23
|
-
> `optional` **action**: `
|
|
23
|
+
> `optional` **action**: `any`
|
|
24
24
|
|
|
25
|
-
Defined in: [packages/web-fetcher/src/
|
|
25
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:49](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L49)
|
|
26
26
|
|
|
27
27
|
#### Inherited from
|
|
28
28
|
|
|
@@ -34,7 +34,7 @@ Defined in: [packages/web-fetcher/src/action/fetch-action.ts:49](https://github.
|
|
|
34
34
|
|
|
35
35
|
> `optional` **args**: `any`
|
|
36
36
|
|
|
37
|
-
Defined in: [packages/web-fetcher/src/
|
|
37
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:52](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L52)
|
|
38
38
|
|
|
39
39
|
#### Inherited from
|
|
40
40
|
|
|
@@ -46,7 +46,7 @@ Defined in: [packages/web-fetcher/src/action/fetch-action.ts:52](https://github.
|
|
|
46
46
|
|
|
47
47
|
> `optional` **failOnError**: `boolean`
|
|
48
48
|
|
|
49
|
-
Defined in: [packages/web-fetcher/src/
|
|
49
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:57](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L57)
|
|
50
50
|
|
|
51
51
|
#### Inherited from
|
|
52
52
|
|
|
@@ -58,7 +58,7 @@ Defined in: [packages/web-fetcher/src/action/fetch-action.ts:57](https://github.
|
|
|
58
58
|
|
|
59
59
|
> `optional` **failOnTimeout**: `boolean`
|
|
60
60
|
|
|
61
|
-
Defined in: [packages/web-fetcher/src/
|
|
61
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:59](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L59)
|
|
62
62
|
|
|
63
63
|
#### Inherited from
|
|
64
64
|
|
|
@@ -70,7 +70,7 @@ Defined in: [packages/web-fetcher/src/action/fetch-action.ts:59](https://github.
|
|
|
70
70
|
|
|
71
71
|
> `optional` **id**: `string`
|
|
72
72
|
|
|
73
|
-
Defined in: [packages/web-fetcher/src/
|
|
73
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:47](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L47)
|
|
74
74
|
|
|
75
75
|
#### Inherited from
|
|
76
76
|
|
|
@@ -82,7 +82,7 @@ Defined in: [packages/web-fetcher/src/action/fetch-action.ts:47](https://github.
|
|
|
82
82
|
|
|
83
83
|
> `optional` **index**: `number`
|
|
84
84
|
|
|
85
|
-
Defined in: [packages/web-fetcher/src/
|
|
85
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:50](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L50)
|
|
86
86
|
|
|
87
87
|
#### Inherited from
|
|
88
88
|
|
|
@@ -94,7 +94,7 @@ Defined in: [packages/web-fetcher/src/action/fetch-action.ts:50](https://github.
|
|
|
94
94
|
|
|
95
95
|
> `optional` **maxRetries**: `number`
|
|
96
96
|
|
|
97
|
-
Defined in: [packages/web-fetcher/src/
|
|
97
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:61](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L61)
|
|
98
98
|
|
|
99
99
|
#### Inherited from
|
|
100
100
|
|
|
@@ -106,7 +106,7 @@ Defined in: [packages/web-fetcher/src/action/fetch-action.ts:61](https://github.
|
|
|
106
106
|
|
|
107
107
|
> `optional` **name**: `string`
|
|
108
108
|
|
|
109
|
-
Defined in: [packages/web-fetcher/src/
|
|
109
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:48](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L48)
|
|
110
110
|
|
|
111
111
|
#### Inherited from
|
|
112
112
|
|
|
@@ -118,7 +118,7 @@ Defined in: [packages/web-fetcher/src/action/fetch-action.ts:48](https://github.
|
|
|
118
118
|
|
|
119
119
|
> **params**: `ExtractSchema`
|
|
120
120
|
|
|
121
|
-
Defined in: [packages/web-fetcher/src/action/definitions/extract.ts:6](https://github.com/isdk/web-fetcher.js/blob/
|
|
121
|
+
Defined in: [packages/web-fetcher/src/action/definitions/extract.ts:6](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/action/definitions/extract.ts#L6)
|
|
122
122
|
|
|
123
123
|
#### Overrides
|
|
124
124
|
|
|
@@ -130,7 +130,7 @@ Defined in: [packages/web-fetcher/src/action/definitions/extract.ts:6](https://g
|
|
|
130
130
|
|
|
131
131
|
> `optional` **storeAs**: `string`
|
|
132
132
|
|
|
133
|
-
Defined in: [packages/web-fetcher/src/
|
|
133
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:54](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L54)
|
|
134
134
|
|
|
135
135
|
#### Inherited from
|
|
136
136
|
|
|
@@ -142,7 +142,7 @@ Defined in: [packages/web-fetcher/src/action/fetch-action.ts:54](https://github.
|
|
|
142
142
|
|
|
143
143
|
> `optional` **timeoutMs**: `number`
|
|
144
144
|
|
|
145
|
-
Defined in: [packages/web-fetcher/src/
|
|
145
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:60](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L60)
|
|
146
146
|
|
|
147
147
|
#### Inherited from
|
|
148
148
|
|