@isdk/web-fetcher 0.2.0 → 0.2.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.action.cn.md +32 -24
- package/README.action.md +14 -4
- package/README.cn.md +10 -2
- package/README.hackernews.md +52 -0
- package/README.md +10 -2
- package/README.reddit.md +248 -0
- package/README.v2ex.md +109 -0
- 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 +10 -2
- package/docs/_media/README.action.md +14 -4
- package/docs/_media/README.cn.md +10 -2
- package/docs/classes/CheerioFetchEngine.md +91 -69
- 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 +87 -69
- package/docs/classes/FetchSession.md +8 -8
- 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 +91 -69
- 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 +9 -9
- package/docs/interfaces/BaseFetchCollectorActionProperties.md +13 -13
- package/docs/interfaces/BaseFetcherProperties.md +29 -21
- package/docs/interfaces/DispatchedEngineAction.md +4 -4
- package/docs/interfaces/ExtractActionProperties.md +9 -9
- package/docs/interfaces/FetchActionInContext.md +13 -13
- package/docs/interfaces/FetchActionProperties.md +10 -10
- package/docs/interfaces/FetchActionResult.md +6 -6
- package/docs/interfaces/FetchContext.md +43 -31
- package/docs/interfaces/FetchEngineContext.md +38 -26
- 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 +36 -24
- package/docs/interfaces/FetcherOptions.md +35 -23
- 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 +4 -4
- package/docs/type-aliases/BaseFetchActionOptions.md +1 -1
- package/docs/type-aliases/BaseFetchCollectorOptions.md +1 -1
- package/docs/type-aliases/BrowserEngine.md +1 -1
- package/docs/type-aliases/FetchActionCapabilities.md +1 -1
- package/docs/type-aliases/FetchActionCapabilityMode.md +1 -1
- package/docs/type-aliases/FetchActionOptions.md +1 -1
- package/docs/type-aliases/FetchEngineAction.md +1 -1
- package/docs/type-aliases/FetchEngineType.md +1 -1
- package/docs/type-aliases/FetchReturnType.md +1 -1
- package/docs/type-aliases/FetchReturnTypeFor.md +1 -1
- package/docs/type-aliases/OnFetchPauseCallback.md +1 -1
- package/docs/type-aliases/ResourceType.md +1 -1
- package/docs/variables/DefaultFetcherProperties.md +1 -1
- package/package.json +2 -1
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Abstract Class: FetchEngine\<TContext, TCrawler, TOptions\>
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:139](https://github.com/isdk/web-fetcher.js/blob/
|
|
9
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:139](https://github.com/isdk/web-fetcher.js/blob/9d976e330f39f712a4e409b1bd1bd44a5fb476bf/src/engine/base.ts#L139)
|
|
10
10
|
|
|
11
11
|
## Extended by
|
|
12
12
|
|
|
@@ -43,7 +43,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:139](https://github.com/isd
|
|
|
43
43
|
|
|
44
44
|
> `protected` **actionEmitter**: `EventEmitter`
|
|
45
45
|
|
|
46
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:235](https://github.com/isdk/web-fetcher.js/blob/
|
|
46
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:235](https://github.com/isdk/web-fetcher.js/blob/9d976e330f39f712a4e409b1bd1bd44a5fb476bf/src/engine/base.ts#L235)
|
|
47
47
|
|
|
48
48
|
***
|
|
49
49
|
|
|
@@ -51,7 +51,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:235](https://github.com/isd
|
|
|
51
51
|
|
|
52
52
|
> `protected` **blockedTypes**: `Set`\<`string`\>
|
|
53
53
|
|
|
54
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:239](https://github.com/isdk/web-fetcher.js/blob/
|
|
54
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:239](https://github.com/isdk/web-fetcher.js/blob/9d976e330f39f712a4e409b1bd1bd44a5fb476bf/src/engine/base.ts#L239)
|
|
55
55
|
|
|
56
56
|
***
|
|
57
57
|
|
|
@@ -59,7 +59,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:239](https://github.com/isd
|
|
|
59
59
|
|
|
60
60
|
> `protected` `optional` **crawler**: `TCrawler`
|
|
61
61
|
|
|
62
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:227](https://github.com/isdk/web-fetcher.js/blob/
|
|
62
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:227](https://github.com/isdk/web-fetcher.js/blob/9d976e330f39f712a4e409b1bd1bd44a5fb476bf/src/engine/base.ts#L227)
|
|
63
63
|
|
|
64
64
|
***
|
|
65
65
|
|
|
@@ -67,7 +67,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:227](https://github.com/isd
|
|
|
67
67
|
|
|
68
68
|
> `protected` `optional` **ctx**: [`FetchEngineContext`](../interfaces/FetchEngineContext.md)
|
|
69
69
|
|
|
70
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:225](https://github.com/isdk/web-fetcher.js/blob/
|
|
70
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:225](https://github.com/isdk/web-fetcher.js/blob/9d976e330f39f712a4e409b1bd1bd44a5fb476bf/src/engine/base.ts#L225)
|
|
71
71
|
|
|
72
72
|
***
|
|
73
73
|
|
|
@@ -75,7 +75,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:225](https://github.com/isd
|
|
|
75
75
|
|
|
76
76
|
> `protected` **hdrs**: `Record`\<`string`, `string`\> = `{}`
|
|
77
77
|
|
|
78
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:231](https://github.com/isdk/web-fetcher.js/blob/
|
|
78
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:231](https://github.com/isdk/web-fetcher.js/blob/9d976e330f39f712a4e409b1bd1bd44a5fb476bf/src/engine/base.ts#L231)
|
|
79
79
|
|
|
80
80
|
***
|
|
81
81
|
|
|
@@ -83,7 +83,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:231](https://github.com/isd
|
|
|
83
83
|
|
|
84
84
|
> `protected` `optional` **isCrawlerReady**: `boolean`
|
|
85
85
|
|
|
86
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:228](https://github.com/isdk/web-fetcher.js/blob/
|
|
86
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:228](https://github.com/isdk/web-fetcher.js/blob/9d976e330f39f712a4e409b1bd1bd44a5fb476bf/src/engine/base.ts#L228)
|
|
87
87
|
|
|
88
88
|
***
|
|
89
89
|
|
|
@@ -91,7 +91,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:228](https://github.com/isd
|
|
|
91
91
|
|
|
92
92
|
> `protected` **isPageActive**: `boolean` = `false`
|
|
93
93
|
|
|
94
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:236](https://github.com/isdk/web-fetcher.js/blob/
|
|
94
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:236](https://github.com/isdk/web-fetcher.js/blob/9d976e330f39f712a4e409b1bd1bd44a5fb476bf/src/engine/base.ts#L236)
|
|
95
95
|
|
|
96
96
|
***
|
|
97
97
|
|
|
@@ -99,7 +99,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:236](https://github.com/isd
|
|
|
99
99
|
|
|
100
100
|
> `protected` **jar**: [`Cookie`](../interfaces/Cookie.md)[] = `[]`
|
|
101
101
|
|
|
102
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:232](https://github.com/isdk/web-fetcher.js/blob/
|
|
102
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:232](https://github.com/isdk/web-fetcher.js/blob/9d976e330f39f712a4e409b1bd1bd44a5fb476bf/src/engine/base.ts#L232)
|
|
103
103
|
|
|
104
104
|
***
|
|
105
105
|
|
|
@@ -107,7 +107,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:232](https://github.com/isd
|
|
|
107
107
|
|
|
108
108
|
> `protected` `optional` **lastResponse**: [`FetchResponse`](../interfaces/FetchResponse.md)
|
|
109
109
|
|
|
110
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:238](https://github.com/isdk/web-fetcher.js/blob/
|
|
110
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:238](https://github.com/isdk/web-fetcher.js/blob/9d976e330f39f712a4e409b1bd1bd44a5fb476bf/src/engine/base.ts#L238)
|
|
111
111
|
|
|
112
112
|
***
|
|
113
113
|
|
|
@@ -115,7 +115,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:238](https://github.com/isd
|
|
|
115
115
|
|
|
116
116
|
> `protected` **navigationLock**: `PromiseLock`
|
|
117
117
|
|
|
118
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:237](https://github.com/isdk/web-fetcher.js/blob/
|
|
118
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:237](https://github.com/isdk/web-fetcher.js/blob/9d976e330f39f712a4e409b1bd1bd44a5fb476bf/src/engine/base.ts#L237)
|
|
119
119
|
|
|
120
120
|
***
|
|
121
121
|
|
|
@@ -123,7 +123,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:237](https://github.com/isd
|
|
|
123
123
|
|
|
124
124
|
> `protected` `optional` **opts**: [`BaseFetcherProperties`](../interfaces/BaseFetcherProperties.md)
|
|
125
125
|
|
|
126
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:226](https://github.com/isdk/web-fetcher.js/blob/
|
|
126
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:226](https://github.com/isdk/web-fetcher.js/blob/9d976e330f39f712a4e409b1bd1bd44a5fb476bf/src/engine/base.ts#L226)
|
|
127
127
|
|
|
128
128
|
***
|
|
129
129
|
|
|
@@ -131,7 +131,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:226](https://github.com/isd
|
|
|
131
131
|
|
|
132
132
|
> `protected` **pendingRequests**: `Map`\<`string`, [`PendingEngineRequest`](../interfaces/PendingEngineRequest.md)\>
|
|
133
133
|
|
|
134
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:233](https://github.com/isdk/web-fetcher.js/blob/
|
|
134
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:233](https://github.com/isdk/web-fetcher.js/blob/9d976e330f39f712a4e409b1bd1bd44a5fb476bf/src/engine/base.ts#L233)
|
|
135
135
|
|
|
136
136
|
***
|
|
137
137
|
|
|
@@ -139,7 +139,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:233](https://github.com/isd
|
|
|
139
139
|
|
|
140
140
|
> `protected` **requestCounter**: `number` = `0`
|
|
141
141
|
|
|
142
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:234](https://github.com/isdk/web-fetcher.js/blob/
|
|
142
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:234](https://github.com/isdk/web-fetcher.js/blob/9d976e330f39f712a4e409b1bd1bd44a5fb476bf/src/engine/base.ts#L234)
|
|
143
143
|
|
|
144
144
|
***
|
|
145
145
|
|
|
@@ -147,7 +147,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:234](https://github.com/isd
|
|
|
147
147
|
|
|
148
148
|
> `protected` `optional` **requestQueue**: `RequestQueue`
|
|
149
149
|
|
|
150
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:229](https://github.com/isdk/web-fetcher.js/blob/
|
|
150
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:229](https://github.com/isdk/web-fetcher.js/blob/9d976e330f39f712a4e409b1bd1bd44a5fb476bf/src/engine/base.ts#L229)
|
|
151
151
|
|
|
152
152
|
***
|
|
153
153
|
|
|
@@ -155,7 +155,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:229](https://github.com/isd
|
|
|
155
155
|
|
|
156
156
|
> `readonly` `static` **id**: `string`
|
|
157
157
|
|
|
158
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:215](https://github.com/isdk/web-fetcher.js/blob/
|
|
158
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:215](https://github.com/isdk/web-fetcher.js/blob/9d976e330f39f712a4e409b1bd1bd44a5fb476bf/src/engine/base.ts#L215)
|
|
159
159
|
|
|
160
160
|
Unique identifier for the engine implementation.
|
|
161
161
|
|
|
@@ -169,7 +169,7 @@ Must be defined by concrete implementations. Used for registration and lookup in
|
|
|
169
169
|
|
|
170
170
|
> `readonly` `static` **mode**: [`FetchEngineType`](../type-aliases/FetchEngineType.md)
|
|
171
171
|
|
|
172
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:223](https://github.com/isdk/web-fetcher.js/blob/
|
|
172
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:223](https://github.com/isdk/web-fetcher.js/blob/9d976e330f39f712a4e409b1bd1bd44a5fb476bf/src/engine/base.ts#L223)
|
|
173
173
|
|
|
174
174
|
Execution mode of the engine (`'http'` or `'browser'`).
|
|
175
175
|
|
|
@@ -185,7 +185,7 @@ Must be defined by concrete implementations. Indicates whether engine operates a
|
|
|
185
185
|
|
|
186
186
|
> **get** **context**(): `undefined` \| [`FetchEngineContext`](../interfaces/FetchEngineContext.md)
|
|
187
187
|
|
|
188
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
188
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:480](https://github.com/isdk/web-fetcher.js/blob/9d976e330f39f712a4e409b1bd1bd44a5fb476bf/src/engine/base.ts#L480)
|
|
189
189
|
|
|
190
190
|
Gets the fetch engine context associated with this instance.
|
|
191
191
|
|
|
@@ -201,7 +201,7 @@ Gets the fetch engine context associated with this instance.
|
|
|
201
201
|
|
|
202
202
|
> **get** **id**(): `string`
|
|
203
203
|
|
|
204
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
204
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:466](https://github.com/isdk/web-fetcher.js/blob/9d976e330f39f712a4e409b1bd1bd44a5fb476bf/src/engine/base.ts#L466)
|
|
205
205
|
|
|
206
206
|
Gets the unique identifier of this engine implementation.
|
|
207
207
|
|
|
@@ -217,7 +217,7 @@ Gets the unique identifier of this engine implementation.
|
|
|
217
217
|
|
|
218
218
|
> **get** **mode**(): [`FetchEngineType`](../type-aliases/FetchEngineType.md)
|
|
219
219
|
|
|
220
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
220
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:473](https://github.com/isdk/web-fetcher.js/blob/9d976e330f39f712a4e409b1bd1bd44a5fb476bf/src/engine/base.ts#L473)
|
|
221
221
|
|
|
222
222
|
Gets the execution mode of this engine (`'http'` or `'browser'`).
|
|
223
223
|
|
|
@@ -227,11 +227,41 @@ Gets the execution mode of this engine (`'http'` or `'browser'`).
|
|
|
227
227
|
|
|
228
228
|
## Methods
|
|
229
229
|
|
|
230
|
+
### \_buildResponse()
|
|
231
|
+
|
|
232
|
+
> `abstract` `protected` **\_buildResponse**(`context`): `Promise`\<[`FetchResponse`](../interfaces/FetchResponse.md)\>
|
|
233
|
+
|
|
234
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:314](https://github.com/isdk/web-fetcher.js/blob/9d976e330f39f712a4e409b1bd1bd44a5fb476bf/src/engine/base.ts#L314)
|
|
235
|
+
|
|
236
|
+
**`Internal`**
|
|
237
|
+
|
|
238
|
+
Abstract method for building standard [FetchResponse] from Crawlee context.
|
|
239
|
+
|
|
240
|
+
#### Parameters
|
|
241
|
+
|
|
242
|
+
##### context
|
|
243
|
+
|
|
244
|
+
`TContext`
|
|
245
|
+
|
|
246
|
+
Crawlee crawling context
|
|
247
|
+
|
|
248
|
+
#### Returns
|
|
249
|
+
|
|
250
|
+
`Promise`\<[`FetchResponse`](../interfaces/FetchResponse.md)\>
|
|
251
|
+
|
|
252
|
+
Promise resolving to [FetchResponse] object
|
|
253
|
+
|
|
254
|
+
#### Remarks
|
|
255
|
+
|
|
256
|
+
Converts implementation-specific context (Playwright `page` or Cheerio `$`) to standardized response.
|
|
257
|
+
|
|
258
|
+
***
|
|
259
|
+
|
|
230
260
|
### \_cleanup()?
|
|
231
261
|
|
|
232
262
|
> `protected` `optional` **\_cleanup**(): `Promise`\<`void`\>
|
|
233
263
|
|
|
234
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:241](https://github.com/isdk/web-fetcher.js/blob/
|
|
264
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:241](https://github.com/isdk/web-fetcher.js/blob/9d976e330f39f712a4e409b1bd1bd44a5fb476bf/src/engine/base.ts#L241)
|
|
235
265
|
|
|
236
266
|
#### Returns
|
|
237
267
|
|
|
@@ -243,7 +273,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:241](https://github.com/isd
|
|
|
243
273
|
|
|
244
274
|
> `protected` **\_commonCleanup**(): `Promise`\<`void`\>
|
|
245
275
|
|
|
246
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
276
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:664](https://github.com/isdk/web-fetcher.js/blob/9d976e330f39f712a4e409b1bd1bd44a5fb476bf/src/engine/base.ts#L664)
|
|
247
277
|
|
|
248
278
|
#### Returns
|
|
249
279
|
|
|
@@ -255,7 +285,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:656](https://github.com/isd
|
|
|
255
285
|
|
|
256
286
|
> `abstract` `protected` **\_createCrawler**(`options`): `TCrawler`
|
|
257
287
|
|
|
258
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:296](https://github.com/isdk/web-fetcher.js/blob/
|
|
288
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:296](https://github.com/isdk/web-fetcher.js/blob/9d976e330f39f712a4e409b1bd1bd44a5fb476bf/src/engine/base.ts#L296)
|
|
259
289
|
|
|
260
290
|
**`Internal`**
|
|
261
291
|
|
|
@@ -279,7 +309,7 @@ The final crawler options.
|
|
|
279
309
|
|
|
280
310
|
> `protected` **\_executePendingActions**(`context`): `Promise`\<`void`\>
|
|
281
311
|
|
|
282
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
312
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:580](https://github.com/isdk/web-fetcher.js/blob/9d976e330f39f712a4e409b1bd1bd44a5fb476bf/src/engine/base.ts#L580)
|
|
283
313
|
|
|
284
314
|
**`Internal`**
|
|
285
315
|
|
|
@@ -328,7 +358,7 @@ If called outside valid page context window (`!this.isPageActive`)
|
|
|
328
358
|
|
|
329
359
|
> `protected` **\_extract**(`schema`, `context`): `Promise`\<`any`\>
|
|
330
360
|
|
|
331
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:246](https://github.com/isdk/web-fetcher.js/blob/
|
|
361
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:246](https://github.com/isdk/web-fetcher.js/blob/9d976e330f39f712a4e409b1bd1bd44a5fb476bf/src/engine/base.ts#L246)
|
|
332
362
|
|
|
333
363
|
#### Parameters
|
|
334
364
|
|
|
@@ -350,7 +380,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:246](https://github.com/isd
|
|
|
350
380
|
|
|
351
381
|
> `abstract` `protected` **\_extractValue**(`schema`, `context`): `Promise`\<`any`\>
|
|
352
382
|
|
|
353
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:244](https://github.com/isdk/web-fetcher.js/blob/
|
|
383
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:244](https://github.com/isdk/web-fetcher.js/blob/9d976e330f39f712a4e409b1bd1bd44a5fb476bf/src/engine/base.ts#L244)
|
|
354
384
|
|
|
355
385
|
#### Parameters
|
|
356
386
|
|
|
@@ -372,7 +402,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:244](https://github.com/isd
|
|
|
372
402
|
|
|
373
403
|
> `abstract` `protected` **\_getSpecificCrawlerOptions**(`ctx`): `Partial`\<`TOptions`\> \| `Promise`\<`Partial`\<`TOptions`\>\>
|
|
374
404
|
|
|
375
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:303](https://github.com/isdk/web-fetcher.js/blob/
|
|
405
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:303](https://github.com/isdk/web-fetcher.js/blob/9d976e330f39f712a4e409b1bd1bd44a5fb476bf/src/engine/base.ts#L303)
|
|
376
406
|
|
|
377
407
|
**`Internal`**
|
|
378
408
|
|
|
@@ -396,7 +426,7 @@ The fetch engine context.
|
|
|
396
426
|
|
|
397
427
|
> `protected` **\_normalizeSchema**(`schema`): `ExtractSchema`
|
|
398
428
|
|
|
399
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
429
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:422](https://github.com/isdk/web-fetcher.js/blob/9d976e330f39f712a4e409b1bd1bd44a5fb476bf/src/engine/base.ts#L422)
|
|
400
430
|
|
|
401
431
|
#### Parameters
|
|
402
432
|
|
|
@@ -414,7 +444,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:415](https://github.com/isd
|
|
|
414
444
|
|
|
415
445
|
> `abstract` `protected` **\_querySelectorAll**(`context`, `selector`): `Promise`\<`any`[]\>
|
|
416
446
|
|
|
417
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:243](https://github.com/isdk/web-fetcher.js/blob/
|
|
447
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:243](https://github.com/isdk/web-fetcher.js/blob/9d976e330f39f712a4e409b1bd1bd44a5fb476bf/src/engine/base.ts#L243)
|
|
418
448
|
|
|
419
449
|
#### Parameters
|
|
420
450
|
|
|
@@ -436,7 +466,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:243](https://github.com/isd
|
|
|
436
466
|
|
|
437
467
|
> `protected` **\_sharedFailedRequestHandler**(`context`, `error?`): `Promise`\<`void`\>
|
|
438
468
|
|
|
439
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
469
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:631](https://github.com/isdk/web-fetcher.js/blob/9d976e330f39f712a4e409b1bd1bd44a5fb476bf/src/engine/base.ts#L631)
|
|
440
470
|
|
|
441
471
|
#### Parameters
|
|
442
472
|
|
|
@@ -458,7 +488,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:623](https://github.com/isd
|
|
|
458
488
|
|
|
459
489
|
> `protected` **\_sharedRequestHandler**(`context`): `Promise`\<`void`\>
|
|
460
490
|
|
|
461
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
491
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:603](https://github.com/isdk/web-fetcher.js/blob/9d976e330f39f712a4e409b1bd1bd44a5fb476bf/src/engine/base.ts#L603)
|
|
462
492
|
|
|
463
493
|
#### Parameters
|
|
464
494
|
|
|
@@ -476,7 +506,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:595](https://github.com/isd
|
|
|
476
506
|
|
|
477
507
|
> **blockResources**(`types`, `overwrite?`): `Promise`\<`number`\>
|
|
478
508
|
|
|
479
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
509
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:708](https://github.com/isdk/web-fetcher.js/blob/9d976e330f39f712a4e409b1bd1bd44a5fb476bf/src/engine/base.ts#L708)
|
|
480
510
|
|
|
481
511
|
Blocks specified resource types from loading.
|
|
482
512
|
|
|
@@ -511,13 +541,9 @@ await engine.blockResources(['script'], true); // Replace existing
|
|
|
511
541
|
|
|
512
542
|
### buildResponse()
|
|
513
543
|
|
|
514
|
-
> `
|
|
544
|
+
> `protected` **buildResponse**(`context`): `Promise`\<[`FetchResponse`](../interfaces/FetchResponse.md)\>
|
|
515
545
|
|
|
516
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
517
|
-
|
|
518
|
-
**`Internal`**
|
|
519
|
-
|
|
520
|
-
Abstract method for building standard [FetchResponse] from Crawlee context.
|
|
546
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:315](https://github.com/isdk/web-fetcher.js/blob/9d976e330f39f712a4e409b1bd1bd44a5fb476bf/src/engine/base.ts#L315)
|
|
521
547
|
|
|
522
548
|
#### Parameters
|
|
523
549
|
|
|
@@ -525,25 +551,17 @@ Abstract method for building standard [FetchResponse] from Crawlee context.
|
|
|
525
551
|
|
|
526
552
|
`TContext`
|
|
527
553
|
|
|
528
|
-
Crawlee crawling context
|
|
529
|
-
|
|
530
554
|
#### Returns
|
|
531
555
|
|
|
532
556
|
`Promise`\<[`FetchResponse`](../interfaces/FetchResponse.md)\>
|
|
533
557
|
|
|
534
|
-
Promise resolving to [FetchResponse] object
|
|
535
|
-
|
|
536
|
-
#### Remarks
|
|
537
|
-
|
|
538
|
-
Converts implementation-specific context (Playwright `page` or Cheerio `$`) to standardized response.
|
|
539
|
-
|
|
540
558
|
***
|
|
541
559
|
|
|
542
560
|
### cleanup()
|
|
543
561
|
|
|
544
562
|
> **cleanup**(): `Promise`\<`void`\>
|
|
545
563
|
|
|
546
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
564
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:544](https://github.com/isdk/web-fetcher.js/blob/9d976e330f39f712a4e409b1bd1bd44a5fb476bf/src/engine/base.ts#L544)
|
|
547
565
|
|
|
548
566
|
#### Returns
|
|
549
567
|
|
|
@@ -555,7 +573,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:536](https://github.com/isd
|
|
|
555
573
|
|
|
556
574
|
> **click**(`selector`): `Promise`\<`void`\>
|
|
557
575
|
|
|
558
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
576
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:372](https://github.com/isdk/web-fetcher.js/blob/9d976e330f39f712a4e409b1bd1bd44a5fb476bf/src/engine/base.ts#L372)
|
|
559
577
|
|
|
560
578
|
Clicks on element matching selector.
|
|
561
579
|
|
|
@@ -585,7 +603,7 @@ When no active page context exists
|
|
|
585
603
|
|
|
586
604
|
> **cookies**(): `Promise`\<[`Cookie`](../interfaces/Cookie.md)[]\>
|
|
587
605
|
|
|
588
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
606
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:819](https://github.com/isdk/web-fetcher.js/blob/9d976e330f39f712a4e409b1bd1bd44a5fb476bf/src/engine/base.ts#L819)
|
|
589
607
|
|
|
590
608
|
Manages cookies for current session with multiple overloads.
|
|
591
609
|
|
|
@@ -610,7 +628,7 @@ await engine.cookies([{ name: 'session', value: '123' }]);
|
|
|
610
628
|
|
|
611
629
|
> **cookies**(`cookies`): `Promise`\<`boolean`\>
|
|
612
630
|
|
|
613
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
631
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:820](https://github.com/isdk/web-fetcher.js/blob/9d976e330f39f712a4e409b1bd1bd44a5fb476bf/src/engine/base.ts#L820)
|
|
614
632
|
|
|
615
633
|
Manages cookies for current session with multiple overloads.
|
|
616
634
|
|
|
@@ -645,7 +663,7 @@ await engine.cookies([{ name: 'session', value: '123' }]);
|
|
|
645
663
|
|
|
646
664
|
> `protected` **dispatchAction**\<`T`\>(`action`): `Promise`\<`T`\>
|
|
647
665
|
|
|
648
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
666
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:647](https://github.com/isdk/web-fetcher.js/blob/9d976e330f39f712a4e409b1bd1bd44a5fb476bf/src/engine/base.ts#L647)
|
|
649
667
|
|
|
650
668
|
#### Type Parameters
|
|
651
669
|
|
|
@@ -669,7 +687,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:639](https://github.com/isd
|
|
|
669
687
|
|
|
670
688
|
> **dispose**(): `Promise`\<`void`\>
|
|
671
689
|
|
|
672
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
690
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:837](https://github.com/isdk/web-fetcher.js/blob/9d976e330f39f712a4e409b1bd1bd44a5fb476bf/src/engine/base.ts#L837)
|
|
673
691
|
|
|
674
692
|
Disposes of engine, cleaning up all resources.
|
|
675
693
|
|
|
@@ -685,7 +703,7 @@ Promise resolving when disposal completes
|
|
|
685
703
|
|
|
686
704
|
> `abstract` `protected` **executeAction**(`context`, `action`): `Promise`\<`any`\>
|
|
687
705
|
|
|
688
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
706
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:333](https://github.com/isdk/web-fetcher.js/blob/9d976e330f39f712a4e409b1bd1bd44a5fb476bf/src/engine/base.ts#L333)
|
|
689
707
|
|
|
690
708
|
**`Internal`**
|
|
691
709
|
|
|
@@ -721,7 +739,7 @@ Handles specific user interactions using underlying technology (Playwright/Cheer
|
|
|
721
739
|
|
|
722
740
|
> **extract**\<`T`\>(`schema`): `Promise`\<`T`\>
|
|
723
741
|
|
|
724
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
742
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:417](https://github.com/isdk/web-fetcher.js/blob/9d976e330f39f712a4e409b1bd1bd44a5fb476bf/src/engine/base.ts#L417)
|
|
725
743
|
|
|
726
744
|
Extracts structured data from the current page content.
|
|
727
745
|
|
|
@@ -751,7 +769,7 @@ A promise that resolves to an object with the extracted data.
|
|
|
751
769
|
|
|
752
770
|
> **fill**(`selector`, `value`): `Promise`\<`void`\>
|
|
753
771
|
|
|
754
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
772
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:384](https://github.com/isdk/web-fetcher.js/blob/9d976e330f39f712a4e409b1bd1bd44a5fb476bf/src/engine/base.ts#L384)
|
|
755
773
|
|
|
756
774
|
Fills input element with specified value.
|
|
757
775
|
|
|
@@ -785,7 +803,7 @@ When no active page context exists
|
|
|
785
803
|
|
|
786
804
|
> **getContent**(): `Promise`\<[`FetchResponse`](../interfaces/FetchResponse.md)\>
|
|
787
805
|
|
|
788
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
806
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:722](https://github.com/isdk/web-fetcher.js/blob/9d976e330f39f712a4e409b1bd1bd44a5fb476bf/src/engine/base.ts#L722)
|
|
789
807
|
|
|
790
808
|
Gets content of current page.
|
|
791
809
|
|
|
@@ -805,7 +823,7 @@ When no content has been fetched yet
|
|
|
805
823
|
|
|
806
824
|
> `abstract` **goto**(`url`, `params?`): `Promise`\<`void` \| [`FetchResponse`](../interfaces/FetchResponse.md)\>
|
|
807
825
|
|
|
808
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
826
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:347](https://github.com/isdk/web-fetcher.js/blob/9d976e330f39f712a4e409b1bd1bd44a5fb476bf/src/engine/base.ts#L347)
|
|
809
827
|
|
|
810
828
|
Navigates to the specified URL.
|
|
811
829
|
|
|
@@ -843,7 +861,7 @@ await engine.goto('https://example.com');
|
|
|
843
861
|
|
|
844
862
|
> **headers**(): `Promise`\<`Record`\<`string`, `string`\>\>
|
|
845
863
|
|
|
846
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
864
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:761](https://github.com/isdk/web-fetcher.js/blob/9d976e330f39f712a4e409b1bd1bd44a5fb476bf/src/engine/base.ts#L761)
|
|
847
865
|
|
|
848
866
|
Manages HTTP headers for requests with multiple overloads.
|
|
849
867
|
|
|
@@ -870,7 +888,7 @@ await engine.headers('auth', 'token');
|
|
|
870
888
|
|
|
871
889
|
> **headers**(`name`): `Promise`\<`string`\>
|
|
872
890
|
|
|
873
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
891
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:762](https://github.com/isdk/web-fetcher.js/blob/9d976e330f39f712a4e409b1bd1bd44a5fb476bf/src/engine/base.ts#L762)
|
|
874
892
|
|
|
875
893
|
Manages HTTP headers for requests with multiple overloads.
|
|
876
894
|
|
|
@@ -905,7 +923,7 @@ await engine.headers('auth', 'token');
|
|
|
905
923
|
|
|
906
924
|
> **headers**(`headers`, `replaced?`): `Promise`\<`boolean`\>
|
|
907
925
|
|
|
908
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
926
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:763](https://github.com/isdk/web-fetcher.js/blob/9d976e330f39f712a4e409b1bd1bd44a5fb476bf/src/engine/base.ts#L763)
|
|
909
927
|
|
|
910
928
|
Manages HTTP headers for requests with multiple overloads.
|
|
911
929
|
|
|
@@ -946,7 +964,7 @@ await engine.headers('auth', 'token');
|
|
|
946
964
|
|
|
947
965
|
> **headers**(`name`, `value`): `Promise`\<`boolean`\>
|
|
948
966
|
|
|
949
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
967
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:764](https://github.com/isdk/web-fetcher.js/blob/9d976e330f39f712a4e409b1bd1bd44a5fb476bf/src/engine/base.ts#L764)
|
|
950
968
|
|
|
951
969
|
Manages HTTP headers for requests with multiple overloads.
|
|
952
970
|
|
|
@@ -989,7 +1007,7 @@ await engine.headers('auth', 'token');
|
|
|
989
1007
|
|
|
990
1008
|
> **initialize**(`context`, `options?`): `Promise`\<`void`\>
|
|
991
1009
|
|
|
992
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1010
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:495](https://github.com/isdk/web-fetcher.js/blob/9d976e330f39f712a4e409b1bd1bd44a5fb476bf/src/engine/base.ts#L495)
|
|
993
1011
|
|
|
994
1012
|
Initializes the fetch engine with provided context and options.
|
|
995
1013
|
|
|
@@ -1024,7 +1042,7 @@ Automatically called when creating engine via `FetchEngine.create()`.
|
|
|
1024
1042
|
|
|
1025
1043
|
> **pause**(`message?`): `Promise`\<`void`\>
|
|
1026
1044
|
|
|
1027
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1045
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:407](https://github.com/isdk/web-fetcher.js/blob/9d976e330f39f712a4e409b1bd1bd44a5fb476bf/src/engine/base.ts#L407)
|
|
1028
1046
|
|
|
1029
1047
|
Pauses execution, allowing for manual intervention or inspection.
|
|
1030
1048
|
|
|
@@ -1052,7 +1070,7 @@ When no active page context exists
|
|
|
1052
1070
|
|
|
1053
1071
|
> **submit**(`selector?`, `options?`): `Promise`\<`void`\>
|
|
1054
1072
|
|
|
1055
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1073
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:396](https://github.com/isdk/web-fetcher.js/blob/9d976e330f39f712a4e409b1bd1bd44a5fb476bf/src/engine/base.ts#L396)
|
|
1056
1074
|
|
|
1057
1075
|
Submits a form.
|
|
1058
1076
|
|
|
@@ -1086,7 +1104,7 @@ When no active page context exists
|
|
|
1086
1104
|
|
|
1087
1105
|
> **waitFor**(`params?`): `Promise`\<`void`\>
|
|
1088
1106
|
|
|
1089
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1107
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:361](https://github.com/isdk/web-fetcher.js/blob/9d976e330f39f712a4e409b1bd1bd44a5fb476bf/src/engine/base.ts#L361)
|
|
1090
1108
|
|
|
1091
1109
|
Waits for specified condition before continuing.
|
|
1092
1110
|
|
|
@@ -1117,7 +1135,7 @@ await engine.waitFor({ selector: '#content' }); // Wait for element
|
|
|
1117
1135
|
|
|
1118
1136
|
> `static` **create**(`ctx`, `options?`): `Promise`\<`undefined` \| `AnyFetchEngine`\>
|
|
1119
1137
|
|
|
1120
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:198](https://github.com/isdk/web-fetcher.js/blob/
|
|
1138
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:198](https://github.com/isdk/web-fetcher.js/blob/9d976e330f39f712a4e409b1bd1bd44a5fb476bf/src/engine/base.ts#L198)
|
|
1121
1139
|
|
|
1122
1140
|
Factory method to create and initialize a fetch engine instance.
|
|
1123
1141
|
|
|
@@ -1155,7 +1173,7 @@ Primary entry point for engine creation. Selects appropriate implementation base
|
|
|
1155
1173
|
|
|
1156
1174
|
> `static` **get**(`id`): `undefined` \| `AnyFetchEngineCtor`
|
|
1157
1175
|
|
|
1158
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:171](https://github.com/isdk/web-fetcher.js/blob/
|
|
1176
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:171](https://github.com/isdk/web-fetcher.js/blob/9d976e330f39f712a4e409b1bd1bd44a5fb476bf/src/engine/base.ts#L171)
|
|
1159
1177
|
|
|
1160
1178
|
Retrieves a fetch engine implementation by its unique ID.
|
|
1161
1179
|
|
|
@@ -1179,7 +1197,7 @@ Engine class if found, otherwise `undefined`
|
|
|
1179
1197
|
|
|
1180
1198
|
> `static` **getByMode**(`mode`): `undefined` \| `AnyFetchEngineCtor`
|
|
1181
1199
|
|
|
1182
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:181](https://github.com/isdk/web-fetcher.js/blob/
|
|
1200
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:181](https://github.com/isdk/web-fetcher.js/blob/9d976e330f39f712a4e409b1bd1bd44a5fb476bf/src/engine/base.ts#L181)
|
|
1183
1201
|
|
|
1184
1202
|
Retrieves a fetch engine implementation by execution mode.
|
|
1185
1203
|
|
|
@@ -1203,7 +1221,7 @@ Engine class if found, otherwise `undefined`
|
|
|
1203
1221
|
|
|
1204
1222
|
> `static` **register**(`engineClass`): `void`
|
|
1205
1223
|
|
|
1206
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:158](https://github.com/isdk/web-fetcher.js/blob/
|
|
1224
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:158](https://github.com/isdk/web-fetcher.js/blob/9d976e330f39f712a4e409b1bd1bd44a5fb476bf/src/engine/base.ts#L158)
|
|
1207
1225
|
|
|
1208
1226
|
Registers a fetch engine implementation with the global registry.
|
|
1209
1227
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Class: FetchSession
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/web-fetcher/src/core/session.ts:11](https://github.com/isdk/web-fetcher.js/blob/
|
|
9
|
+
Defined in: [packages/web-fetcher/src/core/session.ts:11](https://github.com/isdk/web-fetcher.js/blob/9d976e330f39f712a4e409b1bd1bd44a5fb476bf/src/core/session.ts#L11)
|
|
10
10
|
|
|
11
11
|
## Constructors
|
|
12
12
|
|
|
@@ -14,7 +14,7 @@ Defined in: [packages/web-fetcher/src/core/session.ts:11](https://github.com/isd
|
|
|
14
14
|
|
|
15
15
|
> **new FetchSession**(`options`): `FetchSession`
|
|
16
16
|
|
|
17
|
-
Defined in: [packages/web-fetcher/src/core/session.ts:18](https://github.com/isdk/web-fetcher.js/blob/
|
|
17
|
+
Defined in: [packages/web-fetcher/src/core/session.ts:18](https://github.com/isdk/web-fetcher.js/blob/9d976e330f39f712a4e409b1bd1bd44a5fb476bf/src/core/session.ts#L18)
|
|
18
18
|
|
|
19
19
|
#### Parameters
|
|
20
20
|
|
|
@@ -32,7 +32,7 @@ Defined in: [packages/web-fetcher/src/core/session.ts:18](https://github.com/isd
|
|
|
32
32
|
|
|
33
33
|
> `readonly` **context**: [`FetchContext`](../interfaces/FetchContext.md)
|
|
34
34
|
|
|
35
|
-
Defined in: [packages/web-fetcher/src/core/session.ts:13](https://github.com/isdk/web-fetcher.js/blob/
|
|
35
|
+
Defined in: [packages/web-fetcher/src/core/session.ts:13](https://github.com/isdk/web-fetcher.js/blob/9d976e330f39f712a4e409b1bd1bd44a5fb476bf/src/core/session.ts#L13)
|
|
36
36
|
|
|
37
37
|
***
|
|
38
38
|
|
|
@@ -40,7 +40,7 @@ Defined in: [packages/web-fetcher/src/core/session.ts:13](https://github.com/isd
|
|
|
40
40
|
|
|
41
41
|
> `readonly` **id**: `string`
|
|
42
42
|
|
|
43
|
-
Defined in: [packages/web-fetcher/src/core/session.ts:12](https://github.com/isdk/web-fetcher.js/blob/
|
|
43
|
+
Defined in: [packages/web-fetcher/src/core/session.ts:12](https://github.com/isdk/web-fetcher.js/blob/9d976e330f39f712a4e409b1bd1bd44a5fb476bf/src/core/session.ts#L12)
|
|
44
44
|
|
|
45
45
|
## Methods
|
|
46
46
|
|
|
@@ -48,7 +48,7 @@ Defined in: [packages/web-fetcher/src/core/session.ts:12](https://github.com/isd
|
|
|
48
48
|
|
|
49
49
|
> **dispose**(): `Promise`\<`void`\>
|
|
50
50
|
|
|
51
|
-
Defined in: [packages/web-fetcher/src/core/session.ts:83](https://github.com/isdk/web-fetcher.js/blob/
|
|
51
|
+
Defined in: [packages/web-fetcher/src/core/session.ts:83](https://github.com/isdk/web-fetcher.js/blob/9d976e330f39f712a4e409b1bd1bd44a5fb476bf/src/core/session.ts#L83)
|
|
52
52
|
|
|
53
53
|
#### Returns
|
|
54
54
|
|
|
@@ -60,7 +60,7 @@ Defined in: [packages/web-fetcher/src/core/session.ts:83](https://github.com/isd
|
|
|
60
60
|
|
|
61
61
|
> **execute**\<`R`\>(`actionOptions`): `Promise`\<[`FetchActionResult`](../interfaces/FetchActionResult.md)\<`R`\>\>
|
|
62
62
|
|
|
63
|
-
Defined in: [packages/web-fetcher/src/core/session.ts:27](https://github.com/isdk/web-fetcher.js/blob/
|
|
63
|
+
Defined in: [packages/web-fetcher/src/core/session.ts:27](https://github.com/isdk/web-fetcher.js/blob/9d976e330f39f712a4e409b1bd1bd44a5fb476bf/src/core/session.ts#L27)
|
|
64
64
|
|
|
65
65
|
执行单个动作
|
|
66
66
|
|
|
@@ -86,7 +86,7 @@ Defined in: [packages/web-fetcher/src/core/session.ts:27](https://github.com/isd
|
|
|
86
86
|
|
|
87
87
|
> **executeAll**(`actions`): `Promise`\<\{ `outputs`: `Record`\<`string`, `any`\>; `result`: `undefined` \| [`FetchResponse`](../interfaces/FetchResponse.md); \}\>
|
|
88
88
|
|
|
89
|
-
Defined in: [packages/web-fetcher/src/core/session.ts:61](https://github.com/isdk/web-fetcher.js/blob/
|
|
89
|
+
Defined in: [packages/web-fetcher/src/core/session.ts:61](https://github.com/isdk/web-fetcher.js/blob/9d976e330f39f712a4e409b1bd1bd44a5fb476bf/src/core/session.ts#L61)
|
|
90
90
|
|
|
91
91
|
#### Parameters
|
|
92
92
|
|
|
@@ -104,7 +104,7 @@ Defined in: [packages/web-fetcher/src/core/session.ts:61](https://github.com/isd
|
|
|
104
104
|
|
|
105
105
|
> **getOutputs**(): `Record`\<`string`, `any`\>
|
|
106
106
|
|
|
107
|
-
Defined in: [packages/web-fetcher/src/core/session.ts:79](https://github.com/isdk/web-fetcher.js/blob/
|
|
107
|
+
Defined in: [packages/web-fetcher/src/core/session.ts:79](https://github.com/isdk/web-fetcher.js/blob/9d976e330f39f712a4e409b1bd1bd44a5fb476bf/src/core/session.ts#L79)
|
|
108
108
|
|
|
109
109
|
#### Returns
|
|
110
110
|
|