@isdk/web-fetcher 0.2.5 → 0.2.6
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 +6 -4
- package/README.action.md +6 -4
- package/README.cn.md +1 -1
- package/README.md +1 -1
- package/dist/index.d.mts +5 -3
- package/dist/index.d.ts +5 -3
- package/dist/index.js +1 -1
- package/dist/index.mjs +1 -1
- package/docs/README.md +1 -1
- package/docs/_media/README.action.md +6 -4
- package/docs/_media/README.cn.md +1 -1
- package/docs/classes/CheerioFetchEngine.md +58 -58
- package/docs/classes/ClickAction.md +23 -23
- package/docs/classes/ExtractAction.md +23 -23
- package/docs/classes/FetchAction.md +23 -23
- package/docs/classes/FetchEngine.md +58 -58
- package/docs/classes/FetchSession.md +10 -10
- package/docs/classes/FillAction.md +23 -23
- package/docs/classes/GetContentAction.md +23 -23
- package/docs/classes/GotoAction.md +23 -23
- package/docs/classes/PauseAction.md +23 -23
- package/docs/classes/PlaywrightFetchEngine.md +58 -58
- package/docs/classes/SubmitAction.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/interfaces/BaseFetchActionProperties.md +25 -9
- package/docs/interfaces/BaseFetchCollectorActionProperties.md +37 -13
- package/docs/interfaces/BaseFetcherProperties.md +22 -22
- package/docs/interfaces/DispatchedEngineAction.md +4 -4
- package/docs/interfaces/ExtractActionProperties.md +33 -9
- package/docs/interfaces/FetchActionInContext.md +38 -14
- package/docs/interfaces/FetchActionProperties.md +35 -11
- package/docs/interfaces/FetchActionResult.md +6 -6
- package/docs/interfaces/FetchContext.md +33 -33
- package/docs/interfaces/FetchEngineContext.md +27 -27
- package/docs/interfaces/FetchMetadata.md +5 -5
- package/docs/interfaces/FetchResponse.md +13 -13
- package/docs/interfaces/FetchReturnTypeRegistry.md +7 -7
- package/docs/interfaces/FetchSite.md +25 -25
- package/docs/interfaces/FetcherOptions.md +25 -25
- package/docs/interfaces/GotoActionOptions.md +6 -6
- package/docs/interfaces/PendingEngineRequest.md +3 -3
- package/docs/interfaces/SubmitActionOptions.md +2 -2
- package/docs/interfaces/WaitForActionOptions.md +5 -5
- package/docs/type-aliases/BaseFetchActionOptions.md +2 -2
- package/docs/type-aliases/BaseFetchCollectorOptions.md +2 -2
- 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 +2 -2
- package/docs/type-aliases/FetchEngineAction.md +1 -1
- package/docs/type-aliases/FetchEngineType.md +1 -1
- package/docs/type-aliases/FetchReturnType.md +1 -1
- package/docs/type-aliases/FetchReturnTypeFor.md +1 -1
- package/docs/type-aliases/OnFetchPauseCallback.md +1 -1
- package/docs/type-aliases/ResourceType.md +1 -1
- package/docs/variables/DefaultFetcherProperties.md +1 -1
- package/docs/variables/FetcherOptionKeys.md +1 -1
- package/package.json +1 -1
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: FetchActionProperties
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/web-fetcher/src/action/fetch-action.ts:
|
|
9
|
+
Defined in: [packages/web-fetcher/src/action/fetch-action.ts:76](https://github.com/isdk/web-fetcher.js/blob/d7b505cc39fc821039fb79f641e2e590d2fc028d/src/action/fetch-action.ts#L76)
|
|
10
10
|
|
|
11
11
|
## Extends
|
|
12
12
|
|
|
@@ -22,11 +22,35 @@ Defined in: [packages/web-fetcher/src/action/fetch-action.ts:74](https://github.
|
|
|
22
22
|
|
|
23
23
|
## Properties
|
|
24
24
|
|
|
25
|
+
### action?
|
|
26
|
+
|
|
27
|
+
> `optional` **action**: `string` \| [`FetchAction`](../classes/FetchAction.md)
|
|
28
|
+
|
|
29
|
+
Defined in: [packages/web-fetcher/src/action/fetch-action.ts:47](https://github.com/isdk/web-fetcher.js/blob/d7b505cc39fc821039fb79f641e2e590d2fc028d/src/action/fetch-action.ts#L47)
|
|
30
|
+
|
|
31
|
+
#### Inherited from
|
|
32
|
+
|
|
33
|
+
[`BaseFetchActionProperties`](BaseFetchActionProperties.md).[`action`](BaseFetchActionProperties.md#action)
|
|
34
|
+
|
|
35
|
+
***
|
|
36
|
+
|
|
37
|
+
### args?
|
|
38
|
+
|
|
39
|
+
> `optional` **args**: `any`
|
|
40
|
+
|
|
41
|
+
Defined in: [packages/web-fetcher/src/action/fetch-action.ts:49](https://github.com/isdk/web-fetcher.js/blob/d7b505cc39fc821039fb79f641e2e590d2fc028d/src/action/fetch-action.ts#L49)
|
|
42
|
+
|
|
43
|
+
#### Inherited from
|
|
44
|
+
|
|
45
|
+
[`BaseFetchActionProperties`](BaseFetchActionProperties.md).[`args`](BaseFetchActionProperties.md#args)
|
|
46
|
+
|
|
47
|
+
***
|
|
48
|
+
|
|
25
49
|
### collectors?
|
|
26
50
|
|
|
27
|
-
> `optional` **collectors**: `_RequireAtLeastOne`\<[`BaseFetchCollectorActionProperties`](BaseFetchCollectorActionProperties.md), `"name"` \| `"id"`\>[]
|
|
51
|
+
> `optional` **collectors**: `_RequireAtLeastOne`\<[`BaseFetchCollectorActionProperties`](BaseFetchCollectorActionProperties.md), `"name"` \| `"id"` \| `"action"`\>[]
|
|
28
52
|
|
|
29
|
-
Defined in: [packages/web-fetcher/src/action/fetch-action.ts:
|
|
53
|
+
Defined in: [packages/web-fetcher/src/action/fetch-action.ts:77](https://github.com/isdk/web-fetcher.js/blob/d7b505cc39fc821039fb79f641e2e590d2fc028d/src/action/fetch-action.ts#L77)
|
|
30
54
|
|
|
31
55
|
***
|
|
32
56
|
|
|
@@ -34,7 +58,7 @@ Defined in: [packages/web-fetcher/src/action/fetch-action.ts:75](https://github.
|
|
|
34
58
|
|
|
35
59
|
> `optional` **failOnError**: `boolean`
|
|
36
60
|
|
|
37
|
-
Defined in: [packages/web-fetcher/src/action/fetch-action.ts:
|
|
61
|
+
Defined in: [packages/web-fetcher/src/action/fetch-action.ts:54](https://github.com/isdk/web-fetcher.js/blob/d7b505cc39fc821039fb79f641e2e590d2fc028d/src/action/fetch-action.ts#L54)
|
|
38
62
|
|
|
39
63
|
#### Inherited from
|
|
40
64
|
|
|
@@ -46,7 +70,7 @@ Defined in: [packages/web-fetcher/src/action/fetch-action.ts:52](https://github.
|
|
|
46
70
|
|
|
47
71
|
> `optional` **failOnTimeout**: `boolean`
|
|
48
72
|
|
|
49
|
-
Defined in: [packages/web-fetcher/src/action/fetch-action.ts:
|
|
73
|
+
Defined in: [packages/web-fetcher/src/action/fetch-action.ts:56](https://github.com/isdk/web-fetcher.js/blob/d7b505cc39fc821039fb79f641e2e590d2fc028d/src/action/fetch-action.ts#L56)
|
|
50
74
|
|
|
51
75
|
#### Inherited from
|
|
52
76
|
|
|
@@ -58,7 +82,7 @@ Defined in: [packages/web-fetcher/src/action/fetch-action.ts:54](https://github.
|
|
|
58
82
|
|
|
59
83
|
> `optional` **id**: `string`
|
|
60
84
|
|
|
61
|
-
Defined in: [packages/web-fetcher/src/action/fetch-action.ts:45](https://github.com/isdk/web-fetcher.js/blob/
|
|
85
|
+
Defined in: [packages/web-fetcher/src/action/fetch-action.ts:45](https://github.com/isdk/web-fetcher.js/blob/d7b505cc39fc821039fb79f641e2e590d2fc028d/src/action/fetch-action.ts#L45)
|
|
62
86
|
|
|
63
87
|
#### Inherited from
|
|
64
88
|
|
|
@@ -70,7 +94,7 @@ Defined in: [packages/web-fetcher/src/action/fetch-action.ts:45](https://github.
|
|
|
70
94
|
|
|
71
95
|
> `optional` **maxRetries**: `number`
|
|
72
96
|
|
|
73
|
-
Defined in: [packages/web-fetcher/src/action/fetch-action.ts:
|
|
97
|
+
Defined in: [packages/web-fetcher/src/action/fetch-action.ts:58](https://github.com/isdk/web-fetcher.js/blob/d7b505cc39fc821039fb79f641e2e590d2fc028d/src/action/fetch-action.ts#L58)
|
|
74
98
|
|
|
75
99
|
#### Inherited from
|
|
76
100
|
|
|
@@ -82,7 +106,7 @@ Defined in: [packages/web-fetcher/src/action/fetch-action.ts:56](https://github.
|
|
|
82
106
|
|
|
83
107
|
> `optional` **name**: `string`
|
|
84
108
|
|
|
85
|
-
Defined in: [packages/web-fetcher/src/action/fetch-action.ts:46](https://github.com/isdk/web-fetcher.js/blob/
|
|
109
|
+
Defined in: [packages/web-fetcher/src/action/fetch-action.ts:46](https://github.com/isdk/web-fetcher.js/blob/d7b505cc39fc821039fb79f641e2e590d2fc028d/src/action/fetch-action.ts#L46)
|
|
86
110
|
|
|
87
111
|
#### Inherited from
|
|
88
112
|
|
|
@@ -94,7 +118,7 @@ Defined in: [packages/web-fetcher/src/action/fetch-action.ts:46](https://github.
|
|
|
94
118
|
|
|
95
119
|
> `optional` **params**: `any`
|
|
96
120
|
|
|
97
|
-
Defined in: [packages/web-fetcher/src/action/fetch-action.ts:
|
|
121
|
+
Defined in: [packages/web-fetcher/src/action/fetch-action.ts:48](https://github.com/isdk/web-fetcher.js/blob/d7b505cc39fc821039fb79f641e2e590d2fc028d/src/action/fetch-action.ts#L48)
|
|
98
122
|
|
|
99
123
|
#### Inherited from
|
|
100
124
|
|
|
@@ -106,7 +130,7 @@ Defined in: [packages/web-fetcher/src/action/fetch-action.ts:47](https://github.
|
|
|
106
130
|
|
|
107
131
|
> `optional` **storeAs**: `string`
|
|
108
132
|
|
|
109
|
-
Defined in: [packages/web-fetcher/src/action/fetch-action.ts:
|
|
133
|
+
Defined in: [packages/web-fetcher/src/action/fetch-action.ts:51](https://github.com/isdk/web-fetcher.js/blob/d7b505cc39fc821039fb79f641e2e590d2fc028d/src/action/fetch-action.ts#L51)
|
|
110
134
|
|
|
111
135
|
#### Inherited from
|
|
112
136
|
|
|
@@ -118,7 +142,7 @@ Defined in: [packages/web-fetcher/src/action/fetch-action.ts:49](https://github.
|
|
|
118
142
|
|
|
119
143
|
> `optional` **timeoutMs**: `number`
|
|
120
144
|
|
|
121
|
-
Defined in: [packages/web-fetcher/src/action/fetch-action.ts:
|
|
145
|
+
Defined in: [packages/web-fetcher/src/action/fetch-action.ts:57](https://github.com/isdk/web-fetcher.js/blob/d7b505cc39fc821039fb79f641e2e590d2fc028d/src/action/fetch-action.ts#L57)
|
|
122
146
|
|
|
123
147
|
#### Inherited from
|
|
124
148
|
|
|
@@ -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/d7b505cc39fc821039fb79f641e2e590d2fc028d/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:40](https://github.com/isdk/web-fetcher.js/blob/
|
|
23
|
+
Defined in: [packages/web-fetcher/src/action/fetch-action.ts:40](https://github.com/isdk/web-fetcher.js/blob/d7b505cc39fc821039fb79f641e2e590d2fc028d/src/action/fetch-action.ts#L40)
|
|
24
24
|
|
|
25
25
|
***
|
|
26
26
|
|
|
@@ -28,7 +28,7 @@ Defined in: [packages/web-fetcher/src/action/fetch-action.ts:40](https://github.
|
|
|
28
28
|
|
|
29
29
|
> `optional` **meta**: `FetchActionMeta`
|
|
30
30
|
|
|
31
|
-
Defined in: [packages/web-fetcher/src/action/fetch-action.ts:41](https://github.com/isdk/web-fetcher.js/blob/
|
|
31
|
+
Defined in: [packages/web-fetcher/src/action/fetch-action.ts:41](https://github.com/isdk/web-fetcher.js/blob/d7b505cc39fc821039fb79f641e2e590d2fc028d/src/action/fetch-action.ts#L41)
|
|
32
32
|
|
|
33
33
|
***
|
|
34
34
|
|
|
@@ -36,7 +36,7 @@ Defined in: [packages/web-fetcher/src/action/fetch-action.ts:41](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:39](https://github.com/isdk/web-fetcher.js/blob/
|
|
39
|
+
Defined in: [packages/web-fetcher/src/action/fetch-action.ts:39](https://github.com/isdk/web-fetcher.js/blob/d7b505cc39fc821039fb79f641e2e590d2fc028d/src/action/fetch-action.ts#L39)
|
|
40
40
|
|
|
41
41
|
***
|
|
42
42
|
|
|
@@ -44,7 +44,7 @@ Defined in: [packages/web-fetcher/src/action/fetch-action.ts:39](https://github.
|
|
|
44
44
|
|
|
45
45
|
> `optional` **returnType**: `R`
|
|
46
46
|
|
|
47
|
-
Defined in: [packages/web-fetcher/src/action/fetch-action.ts:38](https://github.com/isdk/web-fetcher.js/blob/
|
|
47
|
+
Defined in: [packages/web-fetcher/src/action/fetch-action.ts:38](https://github.com/isdk/web-fetcher.js/blob/d7b505cc39fc821039fb79f641e2e590d2fc028d/src/action/fetch-action.ts#L38)
|
|
48
48
|
|
|
49
49
|
***
|
|
50
50
|
|
|
@@ -52,4 +52,4 @@ Defined in: [packages/web-fetcher/src/action/fetch-action.ts:38](https://github.
|
|
|
52
52
|
|
|
53
53
|
> **status**: [`FetchActionResultStatus`](../enumerations/FetchActionResultStatus.md)
|
|
54
54
|
|
|
55
|
-
Defined in: [packages/web-fetcher/src/action/fetch-action.ts:37](https://github.com/isdk/web-fetcher.js/blob/
|
|
55
|
+
Defined in: [packages/web-fetcher/src/action/fetch-action.ts:37](https://github.com/isdk/web-fetcher.js/blob/d7b505cc39fc821039fb79f641e2e590d2fc028d/src/action/fetch-action.ts#L37)
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: FetchContext
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/web-fetcher/src/core/context.ts:35](https://github.com/isdk/web-fetcher.js/blob/
|
|
9
|
+
Defined in: [packages/web-fetcher/src/core/context.ts:35](https://github.com/isdk/web-fetcher.js/blob/d7b505cc39fc821039fb79f641e2e590d2fc028d/src/core/context.ts#L35)
|
|
10
10
|
|
|
11
11
|
## Extends
|
|
12
12
|
|
|
@@ -18,7 +18,7 @@ Defined in: [packages/web-fetcher/src/core/context.ts:35](https://github.com/isd
|
|
|
18
18
|
|
|
19
19
|
> `optional` **antibot**: `boolean`
|
|
20
20
|
|
|
21
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:37](https://github.com/isdk/web-fetcher.js/blob/
|
|
21
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:37](https://github.com/isdk/web-fetcher.js/blob/d7b505cc39fc821039fb79f641e2e590d2fc028d/src/core/types.ts#L37)
|
|
22
22
|
|
|
23
23
|
#### Inherited from
|
|
24
24
|
|
|
@@ -30,7 +30,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:37](https://github.com/isdk/
|
|
|
30
30
|
|
|
31
31
|
> `optional` **blockResources**: `string`[]
|
|
32
32
|
|
|
33
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:46](https://github.com/isdk/web-fetcher.js/blob/
|
|
33
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:46](https://github.com/isdk/web-fetcher.js/blob/d7b505cc39fc821039fb79f641e2e590d2fc028d/src/core/types.ts#L46)
|
|
34
34
|
|
|
35
35
|
#### Inherited from
|
|
36
36
|
|
|
@@ -42,7 +42,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:46](https://github.com/isdk/
|
|
|
42
42
|
|
|
43
43
|
> `optional` **browser**: `object`
|
|
44
44
|
|
|
45
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:52](https://github.com/isdk/web-fetcher.js/blob/
|
|
45
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:52](https://github.com/isdk/web-fetcher.js/blob/d7b505cc39fc821039fb79f641e2e590d2fc028d/src/core/types.ts#L52)
|
|
46
46
|
|
|
47
47
|
#### engine?
|
|
48
48
|
|
|
@@ -71,7 +71,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:52](https://github.com/isdk/
|
|
|
71
71
|
|
|
72
72
|
> `optional` **cookies**: [`Cookie`](Cookie.md)[]
|
|
73
73
|
|
|
74
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:40](https://github.com/isdk/web-fetcher.js/blob/
|
|
74
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:40](https://github.com/isdk/web-fetcher.js/blob/d7b505cc39fc821039fb79f641e2e590d2fc028d/src/core/types.ts#L40)
|
|
75
75
|
|
|
76
76
|
#### Inherited from
|
|
77
77
|
|
|
@@ -83,7 +83,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:40](https://github.com/isdk/
|
|
|
83
83
|
|
|
84
84
|
> `optional` **currentAction**: [`FetchActionInContext`](FetchActionInContext.md)
|
|
85
85
|
|
|
86
|
-
Defined in: [packages/web-fetcher/src/core/context.ts:36](https://github.com/isdk/web-fetcher.js/blob/
|
|
86
|
+
Defined in: [packages/web-fetcher/src/core/context.ts:36](https://github.com/isdk/web-fetcher.js/blob/d7b505cc39fc821039fb79f641e2e590d2fc028d/src/core/context.ts#L36)
|
|
87
87
|
|
|
88
88
|
***
|
|
89
89
|
|
|
@@ -91,7 +91,7 @@ Defined in: [packages/web-fetcher/src/core/context.ts:36](https://github.com/isd
|
|
|
91
91
|
|
|
92
92
|
> `optional` **delayBetweenRequestsMs**: `number`
|
|
93
93
|
|
|
94
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:73](https://github.com/isdk/web-fetcher.js/blob/
|
|
94
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:73](https://github.com/isdk/web-fetcher.js/blob/d7b505cc39fc821039fb79f641e2e590d2fc028d/src/core/types.ts#L73)
|
|
95
95
|
|
|
96
96
|
#### Inherited from
|
|
97
97
|
|
|
@@ -103,7 +103,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:73](https://github.com/isdk/
|
|
|
103
103
|
|
|
104
104
|
> `optional` **enableSmart**: `boolean`
|
|
105
105
|
|
|
106
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:35](https://github.com/isdk/web-fetcher.js/blob/
|
|
106
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:35](https://github.com/isdk/web-fetcher.js/blob/d7b505cc39fc821039fb79f641e2e590d2fc028d/src/core/types.ts#L35)
|
|
107
107
|
|
|
108
108
|
#### Inherited from
|
|
109
109
|
|
|
@@ -115,7 +115,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:35](https://github.com/isdk/
|
|
|
115
115
|
|
|
116
116
|
> `optional` **engine**: `string`
|
|
117
117
|
|
|
118
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:34](https://github.com/isdk/web-fetcher.js/blob/
|
|
118
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:34](https://github.com/isdk/web-fetcher.js/blob/d7b505cc39fc821039fb79f641e2e590d2fc028d/src/core/types.ts#L34)
|
|
119
119
|
|
|
120
120
|
抓取模式
|
|
121
121
|
|
|
@@ -133,7 +133,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:34](https://github.com/isdk/
|
|
|
133
133
|
|
|
134
134
|
> **eventBus**: `EventEmitter`
|
|
135
135
|
|
|
136
|
-
Defined in: [packages/web-fetcher/src/core/context.ts:48](https://github.com/isdk/web-fetcher.js/blob/
|
|
136
|
+
Defined in: [packages/web-fetcher/src/core/context.ts:48](https://github.com/isdk/web-fetcher.js/blob/d7b505cc39fc821039fb79f641e2e590d2fc028d/src/core/context.ts#L48)
|
|
137
137
|
|
|
138
138
|
***
|
|
139
139
|
|
|
@@ -141,7 +141,7 @@ Defined in: [packages/web-fetcher/src/core/context.ts:48](https://github.com/isd
|
|
|
141
141
|
|
|
142
142
|
> `optional` **finalUrl**: `string`
|
|
143
143
|
|
|
144
|
-
Defined in: [packages/web-fetcher/src/core/context.ts:27](https://github.com/isdk/web-fetcher.js/blob/
|
|
144
|
+
Defined in: [packages/web-fetcher/src/core/context.ts:27](https://github.com/isdk/web-fetcher.js/blob/d7b505cc39fc821039fb79f641e2e590d2fc028d/src/core/context.ts#L27)
|
|
145
145
|
|
|
146
146
|
#### Inherited from
|
|
147
147
|
|
|
@@ -153,7 +153,7 @@ Defined in: [packages/web-fetcher/src/core/context.ts:27](https://github.com/isd
|
|
|
153
153
|
|
|
154
154
|
> `optional` **headers**: `Record`\<`string`, `string`\>
|
|
155
155
|
|
|
156
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:39](https://github.com/isdk/web-fetcher.js/blob/
|
|
156
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:39](https://github.com/isdk/web-fetcher.js/blob/d7b505cc39fc821039fb79f641e2e590d2fc028d/src/core/types.ts#L39)
|
|
157
157
|
|
|
158
158
|
#### Inherited from
|
|
159
159
|
|
|
@@ -165,7 +165,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:39](https://github.com/isdk/
|
|
|
165
165
|
|
|
166
166
|
> `optional` **http**: `object`
|
|
167
167
|
|
|
168
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:64](https://github.com/isdk/web-fetcher.js/blob/
|
|
168
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:64](https://github.com/isdk/web-fetcher.js/blob/d7b505cc39fc821039fb79f641e2e590d2fc028d/src/core/types.ts#L64)
|
|
169
169
|
|
|
170
170
|
#### body?
|
|
171
171
|
|
|
@@ -185,7 +185,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:64](https://github.com/isdk/
|
|
|
185
185
|
|
|
186
186
|
> **id**: `string`
|
|
187
187
|
|
|
188
|
-
Defined in: [packages/web-fetcher/src/core/context.ts:25](https://github.com/isdk/web-fetcher.js/blob/
|
|
188
|
+
Defined in: [packages/web-fetcher/src/core/context.ts:25](https://github.com/isdk/web-fetcher.js/blob/d7b505cc39fc821039fb79f641e2e590d2fc028d/src/core/context.ts#L25)
|
|
189
189
|
|
|
190
190
|
#### Inherited from
|
|
191
191
|
|
|
@@ -197,7 +197,7 @@ Defined in: [packages/web-fetcher/src/core/context.ts:25](https://github.com/isd
|
|
|
197
197
|
|
|
198
198
|
> `optional` **ignoreSslErrors**: `boolean`
|
|
199
199
|
|
|
200
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:50](https://github.com/isdk/web-fetcher.js/blob/
|
|
200
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:50](https://github.com/isdk/web-fetcher.js/blob/d7b505cc39fc821039fb79f641e2e590d2fc028d/src/core/types.ts#L50)
|
|
201
201
|
|
|
202
202
|
#### Inherited from
|
|
203
203
|
|
|
@@ -209,7 +209,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:50](https://github.com/isdk/
|
|
|
209
209
|
|
|
210
210
|
> **internal**: `FetchContextInteralState`
|
|
211
211
|
|
|
212
|
-
Defined in: [packages/web-fetcher/src/core/context.ts:46](https://github.com/isdk/web-fetcher.js/blob/
|
|
212
|
+
Defined in: [packages/web-fetcher/src/core/context.ts:46](https://github.com/isdk/web-fetcher.js/blob/d7b505cc39fc821039fb79f641e2e590d2fc028d/src/core/context.ts#L46)
|
|
213
213
|
|
|
214
214
|
#### Overrides
|
|
215
215
|
|
|
@@ -221,7 +221,7 @@ Defined in: [packages/web-fetcher/src/core/context.ts:46](https://github.com/isd
|
|
|
221
221
|
|
|
222
222
|
> `optional` **lastResponse**: [`FetchResponse`](FetchResponse.md)
|
|
223
223
|
|
|
224
|
-
Defined in: [packages/web-fetcher/src/core/context.ts:29](https://github.com/isdk/web-fetcher.js/blob/
|
|
224
|
+
Defined in: [packages/web-fetcher/src/core/context.ts:29](https://github.com/isdk/web-fetcher.js/blob/d7b505cc39fc821039fb79f641e2e590d2fc028d/src/core/context.ts#L29)
|
|
225
225
|
|
|
226
226
|
#### Inherited from
|
|
227
227
|
|
|
@@ -233,7 +233,7 @@ Defined in: [packages/web-fetcher/src/core/context.ts:29](https://github.com/isd
|
|
|
233
233
|
|
|
234
234
|
> `optional` **lastResult**: [`FetchActionResult`](FetchActionResult.md)\<[`FetchReturnType`](../type-aliases/FetchReturnType.md)\>
|
|
235
235
|
|
|
236
|
-
Defined in: [packages/web-fetcher/src/core/context.ts:30](https://github.com/isdk/web-fetcher.js/blob/
|
|
236
|
+
Defined in: [packages/web-fetcher/src/core/context.ts:30](https://github.com/isdk/web-fetcher.js/blob/d7b505cc39fc821039fb79f641e2e590d2fc028d/src/core/context.ts#L30)
|
|
237
237
|
|
|
238
238
|
#### Inherited from
|
|
239
239
|
|
|
@@ -245,7 +245,7 @@ Defined in: [packages/web-fetcher/src/core/context.ts:30](https://github.com/isd
|
|
|
245
245
|
|
|
246
246
|
> `optional` **maxConcurrency**: `number`
|
|
247
247
|
|
|
248
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:71](https://github.com/isdk/web-fetcher.js/blob/
|
|
248
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:71](https://github.com/isdk/web-fetcher.js/blob/d7b505cc39fc821039fb79f641e2e590d2fc028d/src/core/types.ts#L71)
|
|
249
249
|
|
|
250
250
|
#### Inherited from
|
|
251
251
|
|
|
@@ -257,7 +257,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:71](https://github.com/isdk/
|
|
|
257
257
|
|
|
258
258
|
> `optional` **maxRequestsPerMinute**: `number`
|
|
259
259
|
|
|
260
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:72](https://github.com/isdk/web-fetcher.js/blob/
|
|
260
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:72](https://github.com/isdk/web-fetcher.js/blob/d7b505cc39fc821039fb79f641e2e590d2fc028d/src/core/types.ts#L72)
|
|
261
261
|
|
|
262
262
|
#### Inherited from
|
|
263
263
|
|
|
@@ -269,7 +269,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:72](https://github.com/isdk/
|
|
|
269
269
|
|
|
270
270
|
> **outputs**: `Record`\<`string`, `any`\>
|
|
271
271
|
|
|
272
|
-
Defined in: [packages/web-fetcher/src/core/context.ts:38](https://github.com/isdk/web-fetcher.js/blob/
|
|
272
|
+
Defined in: [packages/web-fetcher/src/core/context.ts:38](https://github.com/isdk/web-fetcher.js/blob/d7b505cc39fc821039fb79f641e2e590d2fc028d/src/core/context.ts#L38)
|
|
273
273
|
|
|
274
274
|
***
|
|
275
275
|
|
|
@@ -277,7 +277,7 @@ Defined in: [packages/web-fetcher/src/core/context.ts:38](https://github.com/isd
|
|
|
277
277
|
|
|
278
278
|
> `optional` **proxy**: `string` \| `string`[]
|
|
279
279
|
|
|
280
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:44](https://github.com/isdk/web-fetcher.js/blob/
|
|
280
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:44](https://github.com/isdk/web-fetcher.js/blob/d7b505cc39fc821039fb79f641e2e590d2fc028d/src/core/types.ts#L44)
|
|
281
281
|
|
|
282
282
|
#### Inherited from
|
|
283
283
|
|
|
@@ -289,7 +289,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:44](https://github.com/isdk/
|
|
|
289
289
|
|
|
290
290
|
> `optional` **requestHandlerTimeoutSecs**: `number`
|
|
291
291
|
|
|
292
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:70](https://github.com/isdk/web-fetcher.js/blob/
|
|
292
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:70](https://github.com/isdk/web-fetcher.js/blob/d7b505cc39fc821039fb79f641e2e590d2fc028d/src/core/types.ts#L70)
|
|
293
293
|
|
|
294
294
|
#### Inherited from
|
|
295
295
|
|
|
@@ -301,7 +301,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:70](https://github.com/isdk/
|
|
|
301
301
|
|
|
302
302
|
> `optional` **retries**: `number`
|
|
303
303
|
|
|
304
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:74](https://github.com/isdk/web-fetcher.js/blob/
|
|
304
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:74](https://github.com/isdk/web-fetcher.js/blob/d7b505cc39fc821039fb79f641e2e590d2fc028d/src/core/types.ts#L74)
|
|
305
305
|
|
|
306
306
|
#### Inherited from
|
|
307
307
|
|
|
@@ -313,7 +313,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:74](https://github.com/isdk/
|
|
|
313
313
|
|
|
314
314
|
> `optional` **reuseCookies**: `boolean`
|
|
315
315
|
|
|
316
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:41](https://github.com/isdk/web-fetcher.js/blob/
|
|
316
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:41](https://github.com/isdk/web-fetcher.js/blob/d7b505cc39fc821039fb79f641e2e590d2fc028d/src/core/types.ts#L41)
|
|
317
317
|
|
|
318
318
|
#### Inherited from
|
|
319
319
|
|
|
@@ -325,7 +325,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:41](https://github.com/isdk/
|
|
|
325
325
|
|
|
326
326
|
> `optional` **sites**: [`FetchSite`](FetchSite.md)[]
|
|
327
327
|
|
|
328
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:76](https://github.com/isdk/web-fetcher.js/blob/
|
|
328
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:76](https://github.com/isdk/web-fetcher.js/blob/d7b505cc39fc821039fb79f641e2e590d2fc028d/src/core/types.ts#L76)
|
|
329
329
|
|
|
330
330
|
#### Inherited from
|
|
331
331
|
|
|
@@ -337,7 +337,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:76](https://github.com/isdk/
|
|
|
337
337
|
|
|
338
338
|
> `optional` **throwHttpErrors**: `boolean`
|
|
339
339
|
|
|
340
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:42](https://github.com/isdk/web-fetcher.js/blob/
|
|
340
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:42](https://github.com/isdk/web-fetcher.js/blob/d7b505cc39fc821039fb79f641e2e590d2fc028d/src/core/types.ts#L42)
|
|
341
341
|
|
|
342
342
|
#### Inherited from
|
|
343
343
|
|
|
@@ -349,7 +349,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:42](https://github.com/isdk/
|
|
|
349
349
|
|
|
350
350
|
> `optional` **timeoutMs**: `number`
|
|
351
351
|
|
|
352
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:69](https://github.com/isdk/web-fetcher.js/blob/
|
|
352
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:69](https://github.com/isdk/web-fetcher.js/blob/d7b505cc39fc821039fb79f641e2e590d2fc028d/src/core/types.ts#L69)
|
|
353
353
|
|
|
354
354
|
#### Inherited from
|
|
355
355
|
|
|
@@ -361,7 +361,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:69](https://github.com/isdk/
|
|
|
361
361
|
|
|
362
362
|
> `optional` **url**: `string`
|
|
363
363
|
|
|
364
|
-
Defined in: [packages/web-fetcher/src/core/context.ts:26](https://github.com/isdk/web-fetcher.js/blob/
|
|
364
|
+
Defined in: [packages/web-fetcher/src/core/context.ts:26](https://github.com/isdk/web-fetcher.js/blob/d7b505cc39fc821039fb79f641e2e590d2fc028d/src/core/context.ts#L26)
|
|
365
365
|
|
|
366
366
|
#### Inherited from
|
|
367
367
|
|
|
@@ -373,7 +373,7 @@ Defined in: [packages/web-fetcher/src/core/context.ts:26](https://github.com/isd
|
|
|
373
373
|
|
|
374
374
|
> `optional` **useSiteRegistry**: `boolean`
|
|
375
375
|
|
|
376
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:36](https://github.com/isdk/web-fetcher.js/blob/
|
|
376
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:36](https://github.com/isdk/web-fetcher.js/blob/d7b505cc39fc821039fb79f641e2e590d2fc028d/src/core/types.ts#L36)
|
|
377
377
|
|
|
378
378
|
#### Inherited from
|
|
379
379
|
|
|
@@ -385,7 +385,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:36](https://github.com/isdk/
|
|
|
385
385
|
|
|
386
386
|
> **action**\<`R`\>(`name`, `params?`, `options?`): `Promise`\<[`FetchActionResult`](FetchActionResult.md)\<`R`\>\>
|
|
387
387
|
|
|
388
|
-
Defined in: [packages/web-fetcher/src/core/context.ts:43](https://github.com/isdk/web-fetcher.js/blob/
|
|
388
|
+
Defined in: [packages/web-fetcher/src/core/context.ts:43](https://github.com/isdk/web-fetcher.js/blob/d7b505cc39fc821039fb79f641e2e590d2fc028d/src/core/context.ts#L43)
|
|
389
389
|
|
|
390
390
|
#### Type Parameters
|
|
391
391
|
|
|
@@ -405,7 +405,7 @@ Defined in: [packages/web-fetcher/src/core/context.ts:43](https://github.com/isd
|
|
|
405
405
|
|
|
406
406
|
##### options?
|
|
407
407
|
|
|
408
|
-
`Partial`\<`_RequireAtLeastOne`\<[`FetchActionProperties`](FetchActionProperties.md), `"name"` \| `"id"`\>\>
|
|
408
|
+
`Partial`\<`_RequireAtLeastOne`\<[`FetchActionProperties`](FetchActionProperties.md), `"name"` \| `"id"` \| `"action"`\>\>
|
|
409
409
|
|
|
410
410
|
#### Returns
|
|
411
411
|
|
|
@@ -417,7 +417,7 @@ Defined in: [packages/web-fetcher/src/core/context.ts:43](https://github.com/isd
|
|
|
417
417
|
|
|
418
418
|
> **execute**\<`R`\>(`actionOptions`): `Promise`\<[`FetchActionResult`](FetchActionResult.md)\<`R`\>\>
|
|
419
419
|
|
|
420
|
-
Defined in: [packages/web-fetcher/src/core/context.ts:41](https://github.com/isdk/web-fetcher.js/blob/
|
|
420
|
+
Defined in: [packages/web-fetcher/src/core/context.ts:41](https://github.com/isdk/web-fetcher.js/blob/d7b505cc39fc821039fb79f641e2e590d2fc028d/src/core/context.ts#L41)
|
|
421
421
|
|
|
422
422
|
#### Type Parameters
|
|
423
423
|
|