@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
|
@@ -0,0 +1,73 @@
|
|
|
1
|
+
[**@isdk/web-fetcher**](../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@isdk/web-fetcher](../globals.md) / FetchActionMeta
|
|
6
|
+
|
|
7
|
+
# Interface: FetchActionMeta
|
|
8
|
+
|
|
9
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:26](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L26)
|
|
10
|
+
|
|
11
|
+
## Properties
|
|
12
|
+
|
|
13
|
+
### capability?
|
|
14
|
+
|
|
15
|
+
> `optional` **capability**: [`FetchActionCapabilityMode`](../type-aliases/FetchActionCapabilityMode.md)
|
|
16
|
+
|
|
17
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:30](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L30)
|
|
18
|
+
|
|
19
|
+
***
|
|
20
|
+
|
|
21
|
+
### engineType?
|
|
22
|
+
|
|
23
|
+
> `optional` **engineType**: [`FetchEngineType`](../type-aliases/FetchEngineType.md)
|
|
24
|
+
|
|
25
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:29](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L29)
|
|
26
|
+
|
|
27
|
+
***
|
|
28
|
+
|
|
29
|
+
### id
|
|
30
|
+
|
|
31
|
+
> **id**: `string`
|
|
32
|
+
|
|
33
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:27](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L27)
|
|
34
|
+
|
|
35
|
+
***
|
|
36
|
+
|
|
37
|
+
### index?
|
|
38
|
+
|
|
39
|
+
> `optional` **index**: `number`
|
|
40
|
+
|
|
41
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:28](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L28)
|
|
42
|
+
|
|
43
|
+
***
|
|
44
|
+
|
|
45
|
+
### response?
|
|
46
|
+
|
|
47
|
+
> `optional` **response**: [`FetchResponse`](FetchResponse.md)
|
|
48
|
+
|
|
49
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:31](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L31)
|
|
50
|
+
|
|
51
|
+
***
|
|
52
|
+
|
|
53
|
+
### retries?
|
|
54
|
+
|
|
55
|
+
> `optional` **retries**: `number`
|
|
56
|
+
|
|
57
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:33](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L33)
|
|
58
|
+
|
|
59
|
+
***
|
|
60
|
+
|
|
61
|
+
### timings?
|
|
62
|
+
|
|
63
|
+
> `optional` **timings**: `object`
|
|
64
|
+
|
|
65
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:32](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L32)
|
|
66
|
+
|
|
67
|
+
#### start
|
|
68
|
+
|
|
69
|
+
> **start**: `number`
|
|
70
|
+
|
|
71
|
+
#### total
|
|
72
|
+
|
|
73
|
+
> **total**: `number`
|
|
@@ -6,16 +6,12 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: FetchActionProperties
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/web-fetcher/src/
|
|
9
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:86](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L86)
|
|
10
10
|
|
|
11
11
|
## Extends
|
|
12
12
|
|
|
13
13
|
- [`BaseFetchActionProperties`](BaseFetchActionProperties.md)
|
|
14
14
|
|
|
15
|
-
## Extended by
|
|
16
|
-
|
|
17
|
-
- [`FetchActionInContext`](FetchActionInContext.md)
|
|
18
|
-
|
|
19
15
|
## Indexable
|
|
20
16
|
|
|
21
17
|
\[`key`: `string`\]: `any`
|
|
@@ -24,9 +20,9 @@ Defined in: [packages/web-fetcher/src/action/fetch-action.ts:86](https://github.
|
|
|
24
20
|
|
|
25
21
|
### action?
|
|
26
22
|
|
|
27
|
-
> `optional` **action**: `
|
|
23
|
+
> `optional` **action**: `any`
|
|
28
24
|
|
|
29
|
-
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)
|
|
30
26
|
|
|
31
27
|
#### Inherited from
|
|
32
28
|
|
|
@@ -38,7 +34,7 @@ Defined in: [packages/web-fetcher/src/action/fetch-action.ts:49](https://github.
|
|
|
38
34
|
|
|
39
35
|
> `optional` **args**: `any`
|
|
40
36
|
|
|
41
|
-
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)
|
|
42
38
|
|
|
43
39
|
#### Inherited from
|
|
44
40
|
|
|
@@ -48,9 +44,9 @@ Defined in: [packages/web-fetcher/src/action/fetch-action.ts:52](https://github.
|
|
|
48
44
|
|
|
49
45
|
### collectors?
|
|
50
46
|
|
|
51
|
-
> `optional` **collectors**: `_RequireAtLeastOne`\<[`BaseFetchCollectorActionProperties`](BaseFetchCollectorActionProperties.md), `"
|
|
47
|
+
> `optional` **collectors**: `_RequireAtLeastOne`\<[`BaseFetchCollectorActionProperties`](BaseFetchCollectorActionProperties.md), `"id"` \| `"name"` \| `"action"`\>[]
|
|
52
48
|
|
|
53
|
-
Defined in: [packages/web-fetcher/src/
|
|
49
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:87](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L87)
|
|
54
50
|
|
|
55
51
|
***
|
|
56
52
|
|
|
@@ -58,7 +54,7 @@ Defined in: [packages/web-fetcher/src/action/fetch-action.ts:87](https://github.
|
|
|
58
54
|
|
|
59
55
|
> `optional` **failOnError**: `boolean`
|
|
60
56
|
|
|
61
|
-
Defined in: [packages/web-fetcher/src/
|
|
57
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:57](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L57)
|
|
62
58
|
|
|
63
59
|
#### Inherited from
|
|
64
60
|
|
|
@@ -70,7 +66,7 @@ Defined in: [packages/web-fetcher/src/action/fetch-action.ts:57](https://github.
|
|
|
70
66
|
|
|
71
67
|
> `optional` **failOnTimeout**: `boolean`
|
|
72
68
|
|
|
73
|
-
Defined in: [packages/web-fetcher/src/
|
|
69
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:59](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L59)
|
|
74
70
|
|
|
75
71
|
#### Inherited from
|
|
76
72
|
|
|
@@ -82,7 +78,7 @@ Defined in: [packages/web-fetcher/src/action/fetch-action.ts:59](https://github.
|
|
|
82
78
|
|
|
83
79
|
> `optional` **id**: `string`
|
|
84
80
|
|
|
85
|
-
Defined in: [packages/web-fetcher/src/
|
|
81
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:47](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L47)
|
|
86
82
|
|
|
87
83
|
#### Inherited from
|
|
88
84
|
|
|
@@ -94,7 +90,7 @@ Defined in: [packages/web-fetcher/src/action/fetch-action.ts:47](https://github.
|
|
|
94
90
|
|
|
95
91
|
> `optional` **index**: `number`
|
|
96
92
|
|
|
97
|
-
Defined in: [packages/web-fetcher/src/
|
|
93
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:50](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L50)
|
|
98
94
|
|
|
99
95
|
#### Inherited from
|
|
100
96
|
|
|
@@ -106,7 +102,7 @@ Defined in: [packages/web-fetcher/src/action/fetch-action.ts:50](https://github.
|
|
|
106
102
|
|
|
107
103
|
> `optional` **maxRetries**: `number`
|
|
108
104
|
|
|
109
|
-
Defined in: [packages/web-fetcher/src/
|
|
105
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:61](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L61)
|
|
110
106
|
|
|
111
107
|
#### Inherited from
|
|
112
108
|
|
|
@@ -118,7 +114,7 @@ Defined in: [packages/web-fetcher/src/action/fetch-action.ts:61](https://github.
|
|
|
118
114
|
|
|
119
115
|
> `optional` **name**: `string`
|
|
120
116
|
|
|
121
|
-
Defined in: [packages/web-fetcher/src/
|
|
117
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:48](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L48)
|
|
122
118
|
|
|
123
119
|
#### Inherited from
|
|
124
120
|
|
|
@@ -130,7 +126,7 @@ Defined in: [packages/web-fetcher/src/action/fetch-action.ts:48](https://github.
|
|
|
130
126
|
|
|
131
127
|
> `optional` **params**: `any`
|
|
132
128
|
|
|
133
|
-
Defined in: [packages/web-fetcher/src/
|
|
129
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:51](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L51)
|
|
134
130
|
|
|
135
131
|
#### Inherited from
|
|
136
132
|
|
|
@@ -142,7 +138,7 @@ Defined in: [packages/web-fetcher/src/action/fetch-action.ts:51](https://github.
|
|
|
142
138
|
|
|
143
139
|
> `optional` **storeAs**: `string`
|
|
144
140
|
|
|
145
|
-
Defined in: [packages/web-fetcher/src/
|
|
141
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:54](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L54)
|
|
146
142
|
|
|
147
143
|
#### Inherited from
|
|
148
144
|
|
|
@@ -154,7 +150,7 @@ Defined in: [packages/web-fetcher/src/action/fetch-action.ts:54](https://github.
|
|
|
154
150
|
|
|
155
151
|
> `optional` **timeoutMs**: `number`
|
|
156
152
|
|
|
157
|
-
Defined in: [packages/web-fetcher/src/
|
|
153
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:60](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L60)
|
|
158
154
|
|
|
159
155
|
#### Inherited from
|
|
160
156
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: FetchActionResult\<R\>
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/web-fetcher/src/
|
|
9
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:36](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L36)
|
|
10
10
|
|
|
11
11
|
## Type Parameters
|
|
12
12
|
|
|
@@ -20,15 +20,15 @@ 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/
|
|
23
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:42](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L42)
|
|
24
24
|
|
|
25
25
|
***
|
|
26
26
|
|
|
27
27
|
### meta?
|
|
28
28
|
|
|
29
|
-
> `optional` **meta**: `FetchActionMeta`
|
|
29
|
+
> `optional` **meta**: [`FetchActionMeta`](FetchActionMeta.md)
|
|
30
30
|
|
|
31
|
-
Defined in: [packages/web-fetcher/src/
|
|
31
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:43](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.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/
|
|
39
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:41](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.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/
|
|
47
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:40](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.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/
|
|
55
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:39](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L39)
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: FetchContext
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/web-fetcher/src/core/context.ts:
|
|
9
|
+
Defined in: [packages/web-fetcher/src/core/context.ts:109](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/context.ts#L109)
|
|
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:
|
|
29
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:159](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L159)
|
|
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:
|
|
41
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:176](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L176)
|
|
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:
|
|
53
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:186](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L186)
|
|
54
54
|
|
|
55
55
|
#### engine?
|
|
56
56
|
|
|
@@ -83,7 +83,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:101](https://github.com/isdk
|
|
|
83
83
|
|
|
84
84
|
> `optional` **cookies**: [`Cookie`](Cookie.md)[]
|
|
85
85
|
|
|
86
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
86
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:163](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L163)
|
|
87
87
|
|
|
88
88
|
#### Inherited from
|
|
89
89
|
|
|
@@ -93,9 +93,9 @@ Defined in: [packages/web-fetcher/src/core/types.ts:78](https://github.com/isdk/
|
|
|
93
93
|
|
|
94
94
|
### currentAction?
|
|
95
95
|
|
|
96
|
-
> `optional` **currentAction**: [`FetchActionInContext`](FetchActionInContext.md)
|
|
96
|
+
> `optional` **currentAction**: [`FetchActionInContext`](../type-aliases/FetchActionInContext.md)
|
|
97
97
|
|
|
98
|
-
Defined in: [packages/web-fetcher/src/core/context.ts:
|
|
98
|
+
Defined in: [packages/web-fetcher/src/core/context.ts:113](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/context.ts#L113)
|
|
99
99
|
|
|
100
100
|
Metadata about the action currently being executed.
|
|
101
101
|
|
|
@@ -105,7 +105,7 @@ Metadata about the action currently being executed.
|
|
|
105
105
|
|
|
106
106
|
> `optional` **debug**: `string` \| `boolean` \| `string`[]
|
|
107
107
|
|
|
108
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
108
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:160](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L160)
|
|
109
109
|
|
|
110
110
|
#### Inherited from
|
|
111
111
|
|
|
@@ -117,7 +117,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:75](https://github.com/isdk/
|
|
|
117
117
|
|
|
118
118
|
> `optional` **delayBetweenRequestsMs**: `number`
|
|
119
119
|
|
|
120
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
120
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:208](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L208)
|
|
121
121
|
|
|
122
122
|
#### Inherited from
|
|
123
123
|
|
|
@@ -129,7 +129,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:123](https://github.com/isdk
|
|
|
129
129
|
|
|
130
130
|
> `optional` **enableSmart**: `boolean`
|
|
131
131
|
|
|
132
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
132
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:155](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L155)
|
|
133
133
|
|
|
134
134
|
#### Inherited from
|
|
135
135
|
|
|
@@ -141,7 +141,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:72](https://github.com/isdk/
|
|
|
141
141
|
|
|
142
142
|
> `optional` **engine**: `string`
|
|
143
143
|
|
|
144
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
144
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:154](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L154)
|
|
145
145
|
|
|
146
146
|
抓取模式
|
|
147
147
|
|
|
@@ -159,7 +159,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:71](https://github.com/isdk/
|
|
|
159
159
|
|
|
160
160
|
> **eventBus**: `EventEmitter`
|
|
161
161
|
|
|
162
|
-
Defined in: [packages/web-fetcher/src/core/context.ts:
|
|
162
|
+
Defined in: [packages/web-fetcher/src/core/context.ts:153](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/context.ts#L153)
|
|
163
163
|
|
|
164
164
|
The central event bus for publishing and subscribing to session and action events.
|
|
165
165
|
|
|
@@ -169,7 +169,7 @@ The central event bus for publishing and subscribing to session and action event
|
|
|
169
169
|
|
|
170
170
|
> `optional` **finalUrl**: `string`
|
|
171
171
|
|
|
172
|
-
Defined in: [packages/web-fetcher/src/core/context.ts:
|
|
172
|
+
Defined in: [packages/web-fetcher/src/core/context.ts:84](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/context.ts#L84)
|
|
173
173
|
|
|
174
174
|
The final URL after all redirects have been followed.
|
|
175
175
|
|
|
@@ -183,7 +183,7 @@ The final URL after all redirects have been followed.
|
|
|
183
183
|
|
|
184
184
|
> `optional` **headers**: `Record`\<`string`, `string`\>
|
|
185
185
|
|
|
186
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
186
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:162](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L162)
|
|
187
187
|
|
|
188
188
|
#### Inherited from
|
|
189
189
|
|
|
@@ -195,7 +195,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:77](https://github.com/isdk/
|
|
|
195
195
|
|
|
196
196
|
> `optional` **http**: `object`
|
|
197
197
|
|
|
198
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
198
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:199](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L199)
|
|
199
199
|
|
|
200
200
|
#### body?
|
|
201
201
|
|
|
@@ -203,7 +203,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:114](https://github.com/isdk
|
|
|
203
203
|
|
|
204
204
|
#### method?
|
|
205
205
|
|
|
206
|
-
> `optional` **method**: `"GET"` \| `"POST"` \| `"PUT"` \| `"
|
|
206
|
+
> `optional` **method**: `"GET"` \| `"POST"` \| `"PUT"` \| `"PATCH"` \| `"DELETE"`
|
|
207
207
|
|
|
208
208
|
#### Inherited from
|
|
209
209
|
|
|
@@ -215,7 +215,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:114](https://github.com/isdk
|
|
|
215
215
|
|
|
216
216
|
> **id**: `string`
|
|
217
217
|
|
|
218
|
-
Defined in: [packages/web-fetcher/src/core/context.ts:
|
|
218
|
+
Defined in: [packages/web-fetcher/src/core/context.ts:76](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/context.ts#L76)
|
|
219
219
|
|
|
220
220
|
Unique identifier for the session or request batch.
|
|
221
221
|
|
|
@@ -229,7 +229,7 @@ Unique identifier for the session or request batch.
|
|
|
229
229
|
|
|
230
230
|
> `optional` **ignoreSslErrors**: `boolean`
|
|
231
231
|
|
|
232
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
232
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:184](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L184)
|
|
233
233
|
|
|
234
234
|
#### Inherited from
|
|
235
235
|
|
|
@@ -241,7 +241,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:99](https://github.com/isdk/
|
|
|
241
241
|
|
|
242
242
|
> **internal**: `FetchContextInteralState`
|
|
243
243
|
|
|
244
|
-
Defined in: [packages/web-fetcher/src/core/context.ts:
|
|
244
|
+
Defined in: [packages/web-fetcher/src/core/context.ts:148](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/context.ts#L148)
|
|
245
245
|
|
|
246
246
|
Internal state for engine and lifecycle management.
|
|
247
247
|
|
|
@@ -255,7 +255,7 @@ Internal state for engine and lifecycle management.
|
|
|
255
255
|
|
|
256
256
|
> `optional` **lastResponse**: [`FetchResponse`](FetchResponse.md)
|
|
257
257
|
|
|
258
|
-
Defined in: [packages/web-fetcher/src/core/context.ts:
|
|
258
|
+
Defined in: [packages/web-fetcher/src/core/context.ts:89](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/context.ts#L89)
|
|
259
259
|
|
|
260
260
|
The standardized response object from the most recent navigation.
|
|
261
261
|
|
|
@@ -269,7 +269,7 @@ The standardized response object from the most recent navigation.
|
|
|
269
269
|
|
|
270
270
|
> `optional` **lastResult**: [`FetchActionResult`](FetchActionResult.md)\<[`FetchReturnType`](../type-aliases/FetchReturnType.md)\>
|
|
271
271
|
|
|
272
|
-
Defined in: [packages/web-fetcher/src/core/context.ts:
|
|
272
|
+
Defined in: [packages/web-fetcher/src/core/context.ts:93](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/context.ts#L93)
|
|
273
273
|
|
|
274
274
|
The result object from the most recent action execution.
|
|
275
275
|
|
|
@@ -283,7 +283,7 @@ The result object from the most recent action execution.
|
|
|
283
283
|
|
|
284
284
|
> `optional` **maxConcurrency**: `number`
|
|
285
285
|
|
|
286
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
286
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:206](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L206)
|
|
287
287
|
|
|
288
288
|
#### Inherited from
|
|
289
289
|
|
|
@@ -295,7 +295,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:121](https://github.com/isdk
|
|
|
295
295
|
|
|
296
296
|
> `optional` **maxRequestsPerMinute**: `number`
|
|
297
297
|
|
|
298
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
298
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:207](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L207)
|
|
299
299
|
|
|
300
300
|
#### Inherited from
|
|
301
301
|
|
|
@@ -307,7 +307,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:122](https://github.com/isdk
|
|
|
307
307
|
|
|
308
308
|
> `optional` **output**: `object`
|
|
309
309
|
|
|
310
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
310
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:169](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L169)
|
|
311
311
|
|
|
312
312
|
#### cookies?
|
|
313
313
|
|
|
@@ -327,7 +327,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:84](https://github.com/isdk/
|
|
|
327
327
|
|
|
328
328
|
> **outputs**: `Record`\<`string`, `any`\>
|
|
329
329
|
|
|
330
|
-
Defined in: [packages/web-fetcher/src/core/context.ts:
|
|
330
|
+
Defined in: [packages/web-fetcher/src/core/context.ts:119](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/context.ts#L119)
|
|
331
331
|
|
|
332
332
|
A shared key-value store for storing data extracted from pages or
|
|
333
333
|
metadata generated during action execution.
|
|
@@ -338,7 +338,7 @@ metadata generated during action execution.
|
|
|
338
338
|
|
|
339
339
|
> `optional` **overrideSessionState**: `boolean`
|
|
340
340
|
|
|
341
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
341
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:166](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L166)
|
|
342
342
|
|
|
343
343
|
#### Inherited from
|
|
344
344
|
|
|
@@ -350,7 +350,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:81](https://github.com/isdk/
|
|
|
350
350
|
|
|
351
351
|
> `optional` **proxy**: `string` \| `string`[]
|
|
352
352
|
|
|
353
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
353
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:174](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L174)
|
|
354
354
|
|
|
355
355
|
#### Inherited from
|
|
356
356
|
|
|
@@ -362,7 +362,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:89](https://github.com/isdk/
|
|
|
362
362
|
|
|
363
363
|
> `optional` **requestHandlerTimeoutSecs**: `number`
|
|
364
364
|
|
|
365
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
365
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:205](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L205)
|
|
366
366
|
|
|
367
367
|
#### Inherited from
|
|
368
368
|
|
|
@@ -374,7 +374,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:120](https://github.com/isdk
|
|
|
374
374
|
|
|
375
375
|
> `optional` **retries**: `number`
|
|
376
376
|
|
|
377
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
377
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:209](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L209)
|
|
378
378
|
|
|
379
379
|
#### Inherited from
|
|
380
380
|
|
|
@@ -386,7 +386,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:124](https://github.com/isdk
|
|
|
386
386
|
|
|
387
387
|
> `optional` **sessionPoolOptions**: `SessionPoolOptions`
|
|
388
388
|
|
|
389
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
389
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:165](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L165)
|
|
390
390
|
|
|
391
391
|
#### Inherited from
|
|
392
392
|
|
|
@@ -398,7 +398,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:80](https://github.com/isdk/
|
|
|
398
398
|
|
|
399
399
|
> `optional` **sessionState**: `any`
|
|
400
400
|
|
|
401
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
401
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:164](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L164)
|
|
402
402
|
|
|
403
403
|
#### Inherited from
|
|
404
404
|
|
|
@@ -410,7 +410,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:79](https://github.com/isdk/
|
|
|
410
410
|
|
|
411
411
|
> `optional` **sites**: [`FetchSite`](FetchSite.md)[]
|
|
412
412
|
|
|
413
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
413
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:211](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L211)
|
|
414
414
|
|
|
415
415
|
#### Inherited from
|
|
416
416
|
|
|
@@ -422,7 +422,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:126](https://github.com/isdk
|
|
|
422
422
|
|
|
423
423
|
> `optional` **storage**: [`StorageOptions`](StorageOptions.md)
|
|
424
424
|
|
|
425
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
425
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:181](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L181)
|
|
426
426
|
|
|
427
427
|
Storage configuration for session isolation and persistence.
|
|
428
428
|
|
|
@@ -432,11 +432,23 @@ Storage configuration for session isolation and persistence.
|
|
|
432
432
|
|
|
433
433
|
***
|
|
434
434
|
|
|
435
|
+
### syncStateOnUpgrade?
|
|
436
|
+
|
|
437
|
+
> `optional` **syncStateOnUpgrade**: `boolean`
|
|
438
|
+
|
|
439
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:156](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L156)
|
|
440
|
+
|
|
441
|
+
#### Inherited from
|
|
442
|
+
|
|
443
|
+
[`FetchEngineContext`](FetchEngineContext.md).[`syncStateOnUpgrade`](FetchEngineContext.md#syncstateonupgrade)
|
|
444
|
+
|
|
445
|
+
***
|
|
446
|
+
|
|
435
447
|
### throwHttpErrors?
|
|
436
448
|
|
|
437
449
|
> `optional` **throwHttpErrors**: `boolean`
|
|
438
450
|
|
|
439
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
451
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:167](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L167)
|
|
440
452
|
|
|
441
453
|
#### Inherited from
|
|
442
454
|
|
|
@@ -448,7 +460,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:82](https://github.com/isdk/
|
|
|
448
460
|
|
|
449
461
|
> `optional` **timeoutMs**: `number`
|
|
450
462
|
|
|
451
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
463
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:204](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L204)
|
|
452
464
|
|
|
453
465
|
#### Inherited from
|
|
454
466
|
|
|
@@ -456,11 +468,23 @@ Defined in: [packages/web-fetcher/src/core/types.ts:119](https://github.com/isdk
|
|
|
456
468
|
|
|
457
469
|
***
|
|
458
470
|
|
|
471
|
+
### upgradeThresholdMs?
|
|
472
|
+
|
|
473
|
+
> `optional` **upgradeThresholdMs**: `number`
|
|
474
|
+
|
|
475
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:157](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L157)
|
|
476
|
+
|
|
477
|
+
#### Inherited from
|
|
478
|
+
|
|
479
|
+
[`FetchEngineContext`](FetchEngineContext.md).[`upgradeThresholdMs`](FetchEngineContext.md#upgradethresholdms)
|
|
480
|
+
|
|
481
|
+
***
|
|
482
|
+
|
|
459
483
|
### url?
|
|
460
484
|
|
|
461
485
|
> `optional` **url**: `string`
|
|
462
486
|
|
|
463
|
-
Defined in: [packages/web-fetcher/src/core/context.ts:
|
|
487
|
+
Defined in: [packages/web-fetcher/src/core/context.ts:80](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/context.ts#L80)
|
|
464
488
|
|
|
465
489
|
The target URL for the next navigation, if specified.
|
|
466
490
|
|
|
@@ -474,7 +498,7 @@ The target URL for the next navigation, if specified.
|
|
|
474
498
|
|
|
475
499
|
> `optional` **useSiteRegistry**: `boolean`
|
|
476
500
|
|
|
477
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
501
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:158](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L158)
|
|
478
502
|
|
|
479
503
|
#### Inherited from
|
|
480
504
|
|
|
@@ -486,7 +510,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:73](https://github.com/isdk/
|
|
|
486
510
|
|
|
487
511
|
> **action**\<`R`\>(`name`, `params?`, `options?`): `Promise`\<[`FetchActionResult`](FetchActionResult.md)\<`R`\>\>
|
|
488
512
|
|
|
489
|
-
Defined in: [packages/web-fetcher/src/core/context.ts:
|
|
513
|
+
Defined in: [packages/web-fetcher/src/core/context.ts:139](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/context.ts#L139)
|
|
490
514
|
|
|
491
515
|
Convenience method to execute an action by its registered name or ID.
|
|
492
516
|
|
|
@@ -512,7 +536,7 @@ Parameters specific to the action type.
|
|
|
512
536
|
|
|
513
537
|
##### options?
|
|
514
538
|
|
|
515
|
-
`Partial`\<`_RequireAtLeastOne`\<[`FetchActionProperties`](FetchActionProperties.md), `"
|
|
539
|
+
`Partial`\<`_RequireAtLeastOne`\<[`FetchActionProperties`](FetchActionProperties.md), `"id"` \| `"name"` \| `"action"`\>\>
|
|
516
540
|
|
|
517
541
|
Additional execution options (e.g., storeAs, failOnError).
|
|
518
542
|
|
|
@@ -520,7 +544,7 @@ Additional execution options (e.g., storeAs, failOnError).
|
|
|
520
544
|
|
|
521
545
|
`Promise`\<[`FetchActionResult`](FetchActionResult.md)\<`R`\>\>
|
|
522
546
|
|
|
523
|
-
A promise that resolves to
|
|
547
|
+
A promise that resolves to a result.
|
|
524
548
|
|
|
525
549
|
***
|
|
526
550
|
|
|
@@ -528,7 +552,7 @@ A promise that resolves to the action's result.
|
|
|
528
552
|
|
|
529
553
|
> **execute**\<`R`\>(`actionOptions`): `Promise`\<[`FetchActionResult`](FetchActionResult.md)\<`R`\>\>
|
|
530
554
|
|
|
531
|
-
Defined in: [packages/web-fetcher/src/core/context.ts:
|
|
555
|
+
Defined in: [packages/web-fetcher/src/core/context.ts:127](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/context.ts#L127)
|
|
532
556
|
|
|
533
557
|
Executes a FetchAction within the current context.
|
|
534
558
|
|