@isdk/web-fetcher 0.2.4 → 0.2.5
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.cn.md +12 -0
- package/README.engine.cn.md +1 -1
- package/README.engine.md +1 -1
- package/README.md +12 -0
- package/dist/index.d.mts +10 -0
- package/dist/index.d.ts +10 -0
- package/dist/index.js +1 -1
- package/dist/index.mjs +1 -1
- package/docs/README.md +12 -0
- package/docs/_media/README.cn.md +12 -0
- package/docs/_media/README.engine.md +1 -1
- package/docs/classes/CheerioFetchEngine.md +76 -57
- 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 +72 -57
- package/docs/classes/FetchSession.md +20 -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 +76 -57
- 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 +22 -22
- 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 +32 -32
- 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 +24 -24
- 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 +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/docs/variables/FetcherOptionKeys.md +1 -1
- package/package.json +1 -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:140](https://github.com/isdk/web-fetcher.js/blob/
|
|
9
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:140](https://github.com/isdk/web-fetcher.js/blob/454450fb9b2c03ba1bee72ac0677a667dd8faece/src/engine/base.ts#L140)
|
|
10
10
|
|
|
11
11
|
## Extended by
|
|
12
12
|
|
|
@@ -43,7 +43,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:140](https://github.com/isd
|
|
|
43
43
|
|
|
44
44
|
> `protected` **actionEmitter**: `EventEmitter`
|
|
45
45
|
|
|
46
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:236](https://github.com/isdk/web-fetcher.js/blob/
|
|
46
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:236](https://github.com/isdk/web-fetcher.js/blob/454450fb9b2c03ba1bee72ac0677a667dd8faece/src/engine/base.ts#L236)
|
|
47
47
|
|
|
48
48
|
***
|
|
49
49
|
|
|
@@ -51,7 +51,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:236](https://github.com/isd
|
|
|
51
51
|
|
|
52
52
|
> `protected` **blockedTypes**: `Set`\<`string`\>
|
|
53
53
|
|
|
54
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:240](https://github.com/isdk/web-fetcher.js/blob/
|
|
54
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:240](https://github.com/isdk/web-fetcher.js/blob/454450fb9b2c03ba1bee72ac0677a667dd8faece/src/engine/base.ts#L240)
|
|
55
55
|
|
|
56
56
|
***
|
|
57
57
|
|
|
@@ -59,7 +59,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:240](https://github.com/isd
|
|
|
59
59
|
|
|
60
60
|
> `protected` `optional` **crawler**: `TCrawler`
|
|
61
61
|
|
|
62
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:228](https://github.com/isdk/web-fetcher.js/blob/
|
|
62
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:228](https://github.com/isdk/web-fetcher.js/blob/454450fb9b2c03ba1bee72ac0677a667dd8faece/src/engine/base.ts#L228)
|
|
63
63
|
|
|
64
64
|
***
|
|
65
65
|
|
|
@@ -67,7 +67,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:228](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:226](https://github.com/isdk/web-fetcher.js/blob/
|
|
70
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:226](https://github.com/isdk/web-fetcher.js/blob/454450fb9b2c03ba1bee72ac0677a667dd8faece/src/engine/base.ts#L226)
|
|
71
71
|
|
|
72
72
|
***
|
|
73
73
|
|
|
@@ -75,7 +75,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:226](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:232](https://github.com/isdk/web-fetcher.js/blob/
|
|
78
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:232](https://github.com/isdk/web-fetcher.js/blob/454450fb9b2c03ba1bee72ac0677a667dd8faece/src/engine/base.ts#L232)
|
|
79
79
|
|
|
80
80
|
***
|
|
81
81
|
|
|
@@ -83,7 +83,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:232](https://github.com/isd
|
|
|
83
83
|
|
|
84
84
|
> `protected` `optional` **isCrawlerReady**: `boolean`
|
|
85
85
|
|
|
86
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:229](https://github.com/isdk/web-fetcher.js/blob/
|
|
86
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:229](https://github.com/isdk/web-fetcher.js/blob/454450fb9b2c03ba1bee72ac0677a667dd8faece/src/engine/base.ts#L229)
|
|
87
87
|
|
|
88
88
|
***
|
|
89
89
|
|
|
@@ -91,7 +91,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:229](https://github.com/isd
|
|
|
91
91
|
|
|
92
92
|
> `protected` **isPageActive**: `boolean` = `false`
|
|
93
93
|
|
|
94
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:237](https://github.com/isdk/web-fetcher.js/blob/
|
|
94
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:237](https://github.com/isdk/web-fetcher.js/blob/454450fb9b2c03ba1bee72ac0677a667dd8faece/src/engine/base.ts#L237)
|
|
95
95
|
|
|
96
96
|
***
|
|
97
97
|
|
|
@@ -99,7 +99,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:237](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:233](https://github.com/isdk/web-fetcher.js/blob/
|
|
102
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:233](https://github.com/isdk/web-fetcher.js/blob/454450fb9b2c03ba1bee72ac0677a667dd8faece/src/engine/base.ts#L233)
|
|
103
103
|
|
|
104
104
|
***
|
|
105
105
|
|
|
@@ -107,7 +107,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:233](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:239](https://github.com/isdk/web-fetcher.js/blob/
|
|
110
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:239](https://github.com/isdk/web-fetcher.js/blob/454450fb9b2c03ba1bee72ac0677a667dd8faece/src/engine/base.ts#L239)
|
|
111
111
|
|
|
112
112
|
***
|
|
113
113
|
|
|
@@ -115,7 +115,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:239](https://github.com/isd
|
|
|
115
115
|
|
|
116
116
|
> `protected` **navigationLock**: `PromiseLock`
|
|
117
117
|
|
|
118
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:238](https://github.com/isdk/web-fetcher.js/blob/
|
|
118
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:238](https://github.com/isdk/web-fetcher.js/blob/454450fb9b2c03ba1bee72ac0677a667dd8faece/src/engine/base.ts#L238)
|
|
119
119
|
|
|
120
120
|
***
|
|
121
121
|
|
|
@@ -123,7 +123,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:238](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:227](https://github.com/isdk/web-fetcher.js/blob/
|
|
126
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:227](https://github.com/isdk/web-fetcher.js/blob/454450fb9b2c03ba1bee72ac0677a667dd8faece/src/engine/base.ts#L227)
|
|
127
127
|
|
|
128
128
|
***
|
|
129
129
|
|
|
@@ -131,7 +131,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:227](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:234](https://github.com/isdk/web-fetcher.js/blob/
|
|
134
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:234](https://github.com/isdk/web-fetcher.js/blob/454450fb9b2c03ba1bee72ac0677a667dd8faece/src/engine/base.ts#L234)
|
|
135
135
|
|
|
136
136
|
***
|
|
137
137
|
|
|
@@ -139,7 +139,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:234](https://github.com/isd
|
|
|
139
139
|
|
|
140
140
|
> `protected` **requestCounter**: `number` = `0`
|
|
141
141
|
|
|
142
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:235](https://github.com/isdk/web-fetcher.js/blob/
|
|
142
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:235](https://github.com/isdk/web-fetcher.js/blob/454450fb9b2c03ba1bee72ac0677a667dd8faece/src/engine/base.ts#L235)
|
|
143
143
|
|
|
144
144
|
***
|
|
145
145
|
|
|
@@ -147,7 +147,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:235](https://github.com/isd
|
|
|
147
147
|
|
|
148
148
|
> `protected` `optional` **requestQueue**: `RequestQueue`
|
|
149
149
|
|
|
150
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:230](https://github.com/isdk/web-fetcher.js/blob/
|
|
150
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:230](https://github.com/isdk/web-fetcher.js/blob/454450fb9b2c03ba1bee72ac0677a667dd8faece/src/engine/base.ts#L230)
|
|
151
151
|
|
|
152
152
|
***
|
|
153
153
|
|
|
@@ -155,7 +155,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:230](https://github.com/isd
|
|
|
155
155
|
|
|
156
156
|
> `readonly` `static` **id**: `string`
|
|
157
157
|
|
|
158
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:216](https://github.com/isdk/web-fetcher.js/blob/
|
|
158
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:216](https://github.com/isdk/web-fetcher.js/blob/454450fb9b2c03ba1bee72ac0677a667dd8faece/src/engine/base.ts#L216)
|
|
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:224](https://github.com/isdk/web-fetcher.js/blob/
|
|
172
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:224](https://github.com/isdk/web-fetcher.js/blob/454450fb9b2c03ba1bee72ac0677a667dd8faece/src/engine/base.ts#L224)
|
|
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:491](https://github.com/isdk/web-fetcher.js/blob/454450fb9b2c03ba1bee72ac0677a667dd8faece/src/engine/base.ts#L491)
|
|
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:467](https://github.com/isdk/web-fetcher.js/blob/
|
|
204
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:467](https://github.com/isdk/web-fetcher.js/blob/454450fb9b2c03ba1bee72ac0677a667dd8faece/src/engine/base.ts#L467)
|
|
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:484](https://github.com/isdk/web-fetcher.js/blob/454450fb9b2c03ba1bee72ac0677a667dd8faece/src/engine/base.ts#L484)
|
|
221
221
|
|
|
222
222
|
Gets the execution mode of this engine (`'http'` or `'browser'`).
|
|
223
223
|
|
|
@@ -231,7 +231,7 @@ Gets the execution mode of this engine (`'http'` or `'browser'`).
|
|
|
231
231
|
|
|
232
232
|
> `abstract` `protected` **\_buildResponse**(`context`): `Promise`\<[`FetchResponse`](../interfaces/FetchResponse.md)\>
|
|
233
233
|
|
|
234
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:315](https://github.com/isdk/web-fetcher.js/blob/
|
|
234
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:315](https://github.com/isdk/web-fetcher.js/blob/454450fb9b2c03ba1bee72ac0677a667dd8faece/src/engine/base.ts#L315)
|
|
235
235
|
|
|
236
236
|
**`Internal`**
|
|
237
237
|
|
|
@@ -261,7 +261,7 @@ Converts implementation-specific context (Playwright `page` or Cheerio `$`) to s
|
|
|
261
261
|
|
|
262
262
|
> `protected` `optional` **\_cleanup**(): `Promise`\<`void`\>
|
|
263
263
|
|
|
264
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:242](https://github.com/isdk/web-fetcher.js/blob/
|
|
264
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:242](https://github.com/isdk/web-fetcher.js/blob/454450fb9b2c03ba1bee72ac0677a667dd8faece/src/engine/base.ts#L242)
|
|
265
265
|
|
|
266
266
|
#### Returns
|
|
267
267
|
|
|
@@ -273,7 +273,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:242](https://github.com/isd
|
|
|
273
273
|
|
|
274
274
|
> `protected` **\_commonCleanup**(): `Promise`\<`void`\>
|
|
275
275
|
|
|
276
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
276
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:675](https://github.com/isdk/web-fetcher.js/blob/454450fb9b2c03ba1bee72ac0677a667dd8faece/src/engine/base.ts#L675)
|
|
277
277
|
|
|
278
278
|
#### Returns
|
|
279
279
|
|
|
@@ -285,7 +285,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:665](https://github.com/isd
|
|
|
285
285
|
|
|
286
286
|
> `abstract` `protected` **\_createCrawler**(`options`): `TCrawler`
|
|
287
287
|
|
|
288
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:297](https://github.com/isdk/web-fetcher.js/blob/
|
|
288
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:297](https://github.com/isdk/web-fetcher.js/blob/454450fb9b2c03ba1bee72ac0677a667dd8faece/src/engine/base.ts#L297)
|
|
289
289
|
|
|
290
290
|
**`Internal`**
|
|
291
291
|
|
|
@@ -309,7 +309,7 @@ The final crawler options.
|
|
|
309
309
|
|
|
310
310
|
> `protected` **\_executePendingActions**(`context`): `Promise`\<`void`\>
|
|
311
311
|
|
|
312
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
312
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:591](https://github.com/isdk/web-fetcher.js/blob/454450fb9b2c03ba1bee72ac0677a667dd8faece/src/engine/base.ts#L591)
|
|
313
313
|
|
|
314
314
|
**`Internal`**
|
|
315
315
|
|
|
@@ -358,7 +358,7 @@ If called outside valid page context window (`!this.isPageActive`)
|
|
|
358
358
|
|
|
359
359
|
> `protected` **\_extract**(`schema`, `context`): `Promise`\<`any`\>
|
|
360
360
|
|
|
361
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:247](https://github.com/isdk/web-fetcher.js/blob/
|
|
361
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:247](https://github.com/isdk/web-fetcher.js/blob/454450fb9b2c03ba1bee72ac0677a667dd8faece/src/engine/base.ts#L247)
|
|
362
362
|
|
|
363
363
|
#### Parameters
|
|
364
364
|
|
|
@@ -380,7 +380,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:247](https://github.com/isd
|
|
|
380
380
|
|
|
381
381
|
> `abstract` `protected` **\_extractValue**(`schema`, `context`): `Promise`\<`any`\>
|
|
382
382
|
|
|
383
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:245](https://github.com/isdk/web-fetcher.js/blob/
|
|
383
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:245](https://github.com/isdk/web-fetcher.js/blob/454450fb9b2c03ba1bee72ac0677a667dd8faece/src/engine/base.ts#L245)
|
|
384
384
|
|
|
385
385
|
#### Parameters
|
|
386
386
|
|
|
@@ -402,7 +402,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:245](https://github.com/isd
|
|
|
402
402
|
|
|
403
403
|
> `abstract` `protected` **\_getSpecificCrawlerOptions**(`ctx`): `Partial`\<`TOptions`\> \| `Promise`\<`Partial`\<`TOptions`\>\>
|
|
404
404
|
|
|
405
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:304](https://github.com/isdk/web-fetcher.js/blob/
|
|
405
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:304](https://github.com/isdk/web-fetcher.js/blob/454450fb9b2c03ba1bee72ac0677a667dd8faece/src/engine/base.ts#L304)
|
|
406
406
|
|
|
407
407
|
**`Internal`**
|
|
408
408
|
|
|
@@ -426,7 +426,7 @@ The fetch engine context.
|
|
|
426
426
|
|
|
427
427
|
> `protected` **\_normalizeSchema**(`schema`): `ExtractSchema`
|
|
428
428
|
|
|
429
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:423](https://github.com/isdk/web-fetcher.js/blob/
|
|
429
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:423](https://github.com/isdk/web-fetcher.js/blob/454450fb9b2c03ba1bee72ac0677a667dd8faece/src/engine/base.ts#L423)
|
|
430
430
|
|
|
431
431
|
#### Parameters
|
|
432
432
|
|
|
@@ -444,7 +444,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:423](https://github.com/isd
|
|
|
444
444
|
|
|
445
445
|
> `abstract` `protected` **\_querySelectorAll**(`context`, `selector`): `Promise`\<`any`[]\>
|
|
446
446
|
|
|
447
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:244](https://github.com/isdk/web-fetcher.js/blob/
|
|
447
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:244](https://github.com/isdk/web-fetcher.js/blob/454450fb9b2c03ba1bee72ac0677a667dd8faece/src/engine/base.ts#L244)
|
|
448
448
|
|
|
449
449
|
#### Parameters
|
|
450
450
|
|
|
@@ -466,7 +466,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:244](https://github.com/isd
|
|
|
466
466
|
|
|
467
467
|
> `protected` **\_sharedFailedRequestHandler**(`context`, `error?`): `Promise`\<`void`\>
|
|
468
468
|
|
|
469
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
469
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:642](https://github.com/isdk/web-fetcher.js/blob/454450fb9b2c03ba1bee72ac0677a667dd8faece/src/engine/base.ts#L642)
|
|
470
470
|
|
|
471
471
|
#### Parameters
|
|
472
472
|
|
|
@@ -488,7 +488,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:632](https://github.com/isd
|
|
|
488
488
|
|
|
489
489
|
> `protected` **\_sharedRequestHandler**(`context`): `Promise`\<`void`\>
|
|
490
490
|
|
|
491
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
491
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:614](https://github.com/isdk/web-fetcher.js/blob/454450fb9b2c03ba1bee72ac0677a667dd8faece/src/engine/base.ts#L614)
|
|
492
492
|
|
|
493
493
|
#### Parameters
|
|
494
494
|
|
|
@@ -506,7 +506,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:604](https://github.com/isd
|
|
|
506
506
|
|
|
507
507
|
> **blockResources**(`types`, `overwrite?`): `Promise`\<`number`\>
|
|
508
508
|
|
|
509
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
509
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:719](https://github.com/isdk/web-fetcher.js/blob/454450fb9b2c03ba1bee72ac0677a667dd8faece/src/engine/base.ts#L719)
|
|
510
510
|
|
|
511
511
|
Blocks specified resource types from loading.
|
|
512
512
|
|
|
@@ -543,7 +543,7 @@ await engine.blockResources(['script'], true); // Replace existing
|
|
|
543
543
|
|
|
544
544
|
> `protected` **buildResponse**(`context`): `Promise`\<[`FetchResponse`](../interfaces/FetchResponse.md)\>
|
|
545
545
|
|
|
546
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:316](https://github.com/isdk/web-fetcher.js/blob/
|
|
546
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:316](https://github.com/isdk/web-fetcher.js/blob/454450fb9b2c03ba1bee72ac0677a667dd8faece/src/engine/base.ts#L316)
|
|
547
547
|
|
|
548
548
|
#### Parameters
|
|
549
549
|
|
|
@@ -561,7 +561,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:316](https://github.com/isd
|
|
|
561
561
|
|
|
562
562
|
> **cleanup**(): `Promise`\<`void`\>
|
|
563
563
|
|
|
564
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
564
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:555](https://github.com/isdk/web-fetcher.js/blob/454450fb9b2c03ba1bee72ac0677a667dd8faece/src/engine/base.ts#L555)
|
|
565
565
|
|
|
566
566
|
#### Returns
|
|
567
567
|
|
|
@@ -573,7 +573,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:545](https://github.com/isd
|
|
|
573
573
|
|
|
574
574
|
> **click**(`selector`): `Promise`\<`void`\>
|
|
575
575
|
|
|
576
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:373](https://github.com/isdk/web-fetcher.js/blob/
|
|
576
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:373](https://github.com/isdk/web-fetcher.js/blob/454450fb9b2c03ba1bee72ac0677a667dd8faece/src/engine/base.ts#L373)
|
|
577
577
|
|
|
578
578
|
Clicks on element matching selector.
|
|
579
579
|
|
|
@@ -603,7 +603,7 @@ When no active page context exists
|
|
|
603
603
|
|
|
604
604
|
> **cookies**(): `Promise`\<[`Cookie`](../interfaces/Cookie.md)[]\>
|
|
605
605
|
|
|
606
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
606
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:830](https://github.com/isdk/web-fetcher.js/blob/454450fb9b2c03ba1bee72ac0677a667dd8faece/src/engine/base.ts#L830)
|
|
607
607
|
|
|
608
608
|
Manages cookies for current session with multiple overloads.
|
|
609
609
|
|
|
@@ -628,7 +628,7 @@ await engine.cookies([{ name: 'session', value: '123' }]);
|
|
|
628
628
|
|
|
629
629
|
> **cookies**(`cookies`): `Promise`\<`boolean`\>
|
|
630
630
|
|
|
631
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
631
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:831](https://github.com/isdk/web-fetcher.js/blob/454450fb9b2c03ba1bee72ac0677a667dd8faece/src/engine/base.ts#L831)
|
|
632
632
|
|
|
633
633
|
Manages cookies for current session with multiple overloads.
|
|
634
634
|
|
|
@@ -663,7 +663,7 @@ await engine.cookies([{ name: 'session', value: '123' }]);
|
|
|
663
663
|
|
|
664
664
|
> `protected` **dispatchAction**\<`T`\>(`action`): `Promise`\<`T`\>
|
|
665
665
|
|
|
666
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
666
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:658](https://github.com/isdk/web-fetcher.js/blob/454450fb9b2c03ba1bee72ac0677a667dd8faece/src/engine/base.ts#L658)
|
|
667
667
|
|
|
668
668
|
#### Type Parameters
|
|
669
669
|
|
|
@@ -687,7 +687,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:648](https://github.com/isd
|
|
|
687
687
|
|
|
688
688
|
> **dispose**(): `Promise`\<`void`\>
|
|
689
689
|
|
|
690
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
690
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:848](https://github.com/isdk/web-fetcher.js/blob/454450fb9b2c03ba1bee72ac0677a667dd8faece/src/engine/base.ts#L848)
|
|
691
691
|
|
|
692
692
|
Disposes of engine, cleaning up all resources.
|
|
693
693
|
|
|
@@ -703,7 +703,7 @@ Promise resolving when disposal completes
|
|
|
703
703
|
|
|
704
704
|
> `abstract` `protected` **executeAction**(`context`, `action`): `Promise`\<`any`\>
|
|
705
705
|
|
|
706
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:334](https://github.com/isdk/web-fetcher.js/blob/
|
|
706
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:334](https://github.com/isdk/web-fetcher.js/blob/454450fb9b2c03ba1bee72ac0677a667dd8faece/src/engine/base.ts#L334)
|
|
707
707
|
|
|
708
708
|
**`Internal`**
|
|
709
709
|
|
|
@@ -739,7 +739,7 @@ Handles specific user interactions using underlying technology (Playwright/Cheer
|
|
|
739
739
|
|
|
740
740
|
> **extract**\<`T`\>(`schema`): `Promise`\<`T`\>
|
|
741
741
|
|
|
742
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:418](https://github.com/isdk/web-fetcher.js/blob/
|
|
742
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:418](https://github.com/isdk/web-fetcher.js/blob/454450fb9b2c03ba1bee72ac0677a667dd8faece/src/engine/base.ts#L418)
|
|
743
743
|
|
|
744
744
|
Extracts structured data from the current page content.
|
|
745
745
|
|
|
@@ -769,7 +769,7 @@ A promise that resolves to an object with the extracted data.
|
|
|
769
769
|
|
|
770
770
|
> **fill**(`selector`, `value`): `Promise`\<`void`\>
|
|
771
771
|
|
|
772
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:385](https://github.com/isdk/web-fetcher.js/blob/
|
|
772
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:385](https://github.com/isdk/web-fetcher.js/blob/454450fb9b2c03ba1bee72ac0677a667dd8faece/src/engine/base.ts#L385)
|
|
773
773
|
|
|
774
774
|
Fills input element with specified value.
|
|
775
775
|
|
|
@@ -803,7 +803,7 @@ When no active page context exists
|
|
|
803
803
|
|
|
804
804
|
> **getContent**(): `Promise`\<[`FetchResponse`](../interfaces/FetchResponse.md)\>
|
|
805
805
|
|
|
806
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
806
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:733](https://github.com/isdk/web-fetcher.js/blob/454450fb9b2c03ba1bee72ac0677a667dd8faece/src/engine/base.ts#L733)
|
|
807
807
|
|
|
808
808
|
Gets content of current page.
|
|
809
809
|
|
|
@@ -819,11 +819,26 @@ When no content has been fetched yet
|
|
|
819
819
|
|
|
820
820
|
***
|
|
821
821
|
|
|
822
|
+
### getState()
|
|
823
|
+
|
|
824
|
+
> **getState**(): `Promise`\<\{ `cookies`: [`Cookie`](../interfaces/Cookie.md)[]; \}\>
|
|
825
|
+
|
|
826
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:475](https://github.com/isdk/web-fetcher.js/blob/454450fb9b2c03ba1bee72ac0677a667dd8faece/src/engine/base.ts#L475)
|
|
827
|
+
|
|
828
|
+
Returns the current state of the engine (cookies)
|
|
829
|
+
that can be used to restore the session later.
|
|
830
|
+
|
|
831
|
+
#### Returns
|
|
832
|
+
|
|
833
|
+
`Promise`\<\{ `cookies`: [`Cookie`](../interfaces/Cookie.md)[]; \}\>
|
|
834
|
+
|
|
835
|
+
***
|
|
836
|
+
|
|
822
837
|
### goto()
|
|
823
838
|
|
|
824
839
|
> `abstract` **goto**(`url`, `params?`): `Promise`\<`void` \| [`FetchResponse`](../interfaces/FetchResponse.md)\>
|
|
825
840
|
|
|
826
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:348](https://github.com/isdk/web-fetcher.js/blob/
|
|
841
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:348](https://github.com/isdk/web-fetcher.js/blob/454450fb9b2c03ba1bee72ac0677a667dd8faece/src/engine/base.ts#L348)
|
|
827
842
|
|
|
828
843
|
Navigates to the specified URL.
|
|
829
844
|
|
|
@@ -861,7 +876,7 @@ await engine.goto('https://example.com');
|
|
|
861
876
|
|
|
862
877
|
> **headers**(): `Promise`\<`Record`\<`string`, `string`\>\>
|
|
863
878
|
|
|
864
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
879
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:772](https://github.com/isdk/web-fetcher.js/blob/454450fb9b2c03ba1bee72ac0677a667dd8faece/src/engine/base.ts#L772)
|
|
865
880
|
|
|
866
881
|
Manages HTTP headers for requests with multiple overloads.
|
|
867
882
|
|
|
@@ -888,7 +903,7 @@ await engine.headers('auth', 'token');
|
|
|
888
903
|
|
|
889
904
|
> **headers**(`name`): `Promise`\<`string`\>
|
|
890
905
|
|
|
891
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
906
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:773](https://github.com/isdk/web-fetcher.js/blob/454450fb9b2c03ba1bee72ac0677a667dd8faece/src/engine/base.ts#L773)
|
|
892
907
|
|
|
893
908
|
Manages HTTP headers for requests with multiple overloads.
|
|
894
909
|
|
|
@@ -923,7 +938,7 @@ await engine.headers('auth', 'token');
|
|
|
923
938
|
|
|
924
939
|
> **headers**(`headers`, `replaced?`): `Promise`\<`boolean`\>
|
|
925
940
|
|
|
926
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
941
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:774](https://github.com/isdk/web-fetcher.js/blob/454450fb9b2c03ba1bee72ac0677a667dd8faece/src/engine/base.ts#L774)
|
|
927
942
|
|
|
928
943
|
Manages HTTP headers for requests with multiple overloads.
|
|
929
944
|
|
|
@@ -964,7 +979,7 @@ await engine.headers('auth', 'token');
|
|
|
964
979
|
|
|
965
980
|
> **headers**(`name`, `value`): `Promise`\<`boolean`\>
|
|
966
981
|
|
|
967
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
982
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:775](https://github.com/isdk/web-fetcher.js/blob/454450fb9b2c03ba1bee72ac0677a667dd8faece/src/engine/base.ts#L775)
|
|
968
983
|
|
|
969
984
|
Manages HTTP headers for requests with multiple overloads.
|
|
970
985
|
|
|
@@ -1007,7 +1022,7 @@ await engine.headers('auth', 'token');
|
|
|
1007
1022
|
|
|
1008
1023
|
> **initialize**(`context`, `options?`): `Promise`\<`void`\>
|
|
1009
1024
|
|
|
1010
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1025
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:506](https://github.com/isdk/web-fetcher.js/blob/454450fb9b2c03ba1bee72ac0677a667dd8faece/src/engine/base.ts#L506)
|
|
1011
1026
|
|
|
1012
1027
|
Initializes the fetch engine with provided context and options.
|
|
1013
1028
|
|
|
@@ -1042,7 +1057,7 @@ Automatically called when creating engine via `FetchEngine.create()`.
|
|
|
1042
1057
|
|
|
1043
1058
|
> **pause**(`message?`): `Promise`\<`void`\>
|
|
1044
1059
|
|
|
1045
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:408](https://github.com/isdk/web-fetcher.js/blob/
|
|
1060
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:408](https://github.com/isdk/web-fetcher.js/blob/454450fb9b2c03ba1bee72ac0677a667dd8faece/src/engine/base.ts#L408)
|
|
1046
1061
|
|
|
1047
1062
|
Pauses execution, allowing for manual intervention or inspection.
|
|
1048
1063
|
|
|
@@ -1070,7 +1085,7 @@ When no active page context exists
|
|
|
1070
1085
|
|
|
1071
1086
|
> **submit**(`selector?`, `options?`): `Promise`\<`void`\>
|
|
1072
1087
|
|
|
1073
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:397](https://github.com/isdk/web-fetcher.js/blob/
|
|
1088
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:397](https://github.com/isdk/web-fetcher.js/blob/454450fb9b2c03ba1bee72ac0677a667dd8faece/src/engine/base.ts#L397)
|
|
1074
1089
|
|
|
1075
1090
|
Submits a form.
|
|
1076
1091
|
|
|
@@ -1104,7 +1119,7 @@ When no active page context exists
|
|
|
1104
1119
|
|
|
1105
1120
|
> **waitFor**(`params?`): `Promise`\<`void`\>
|
|
1106
1121
|
|
|
1107
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:362](https://github.com/isdk/web-fetcher.js/blob/
|
|
1122
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:362](https://github.com/isdk/web-fetcher.js/blob/454450fb9b2c03ba1bee72ac0677a667dd8faece/src/engine/base.ts#L362)
|
|
1108
1123
|
|
|
1109
1124
|
Waits for specified condition before continuing.
|
|
1110
1125
|
|
|
@@ -1135,7 +1150,7 @@ await engine.waitFor({ selector: '#content' }); // Wait for element
|
|
|
1135
1150
|
|
|
1136
1151
|
> `static` **create**(`ctx`, `options?`): `Promise`\<`undefined` \| `AnyFetchEngine`\>
|
|
1137
1152
|
|
|
1138
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:199](https://github.com/isdk/web-fetcher.js/blob/
|
|
1153
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:199](https://github.com/isdk/web-fetcher.js/blob/454450fb9b2c03ba1bee72ac0677a667dd8faece/src/engine/base.ts#L199)
|
|
1139
1154
|
|
|
1140
1155
|
Factory method to create and initialize a fetch engine instance.
|
|
1141
1156
|
|
|
@@ -1173,7 +1188,7 @@ Primary entry point for engine creation. Selects appropriate implementation base
|
|
|
1173
1188
|
|
|
1174
1189
|
> `static` **get**(`id`): `undefined` \| `AnyFetchEngineCtor`
|
|
1175
1190
|
|
|
1176
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:172](https://github.com/isdk/web-fetcher.js/blob/
|
|
1191
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:172](https://github.com/isdk/web-fetcher.js/blob/454450fb9b2c03ba1bee72ac0677a667dd8faece/src/engine/base.ts#L172)
|
|
1177
1192
|
|
|
1178
1193
|
Retrieves a fetch engine implementation by its unique ID.
|
|
1179
1194
|
|
|
@@ -1197,7 +1212,7 @@ Engine class if found, otherwise `undefined`
|
|
|
1197
1212
|
|
|
1198
1213
|
> `static` **getByMode**(`mode`): `undefined` \| `AnyFetchEngineCtor`
|
|
1199
1214
|
|
|
1200
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:182](https://github.com/isdk/web-fetcher.js/blob/
|
|
1215
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:182](https://github.com/isdk/web-fetcher.js/blob/454450fb9b2c03ba1bee72ac0677a667dd8faece/src/engine/base.ts#L182)
|
|
1201
1216
|
|
|
1202
1217
|
Retrieves a fetch engine implementation by execution mode.
|
|
1203
1218
|
|
|
@@ -1221,7 +1236,7 @@ Engine class if found, otherwise `undefined`
|
|
|
1221
1236
|
|
|
1222
1237
|
> `static` **register**(`engineClass`): `void`
|
|
1223
1238
|
|
|
1224
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:159](https://github.com/isdk/web-fetcher.js/blob/
|
|
1239
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:159](https://github.com/isdk/web-fetcher.js/blob/454450fb9b2c03ba1bee72ac0677a667dd8faece/src/engine/base.ts#L159)
|
|
1225
1240
|
|
|
1226
1241
|
Registers a fetch engine implementation with the global registry.
|
|
1227
1242
|
|
|
@@ -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/454450fb9b2c03ba1bee72ac0677a667dd8faece/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/454450fb9b2c03ba1bee72ac0677a667dd8faece/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/454450fb9b2c03ba1bee72ac0677a667dd8faece/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/454450fb9b2c03ba1bee72ac0677a667dd8faece/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:
|
|
51
|
+
Defined in: [packages/web-fetcher/src/core/session.ts:87](https://github.com/isdk/web-fetcher.js/blob/454450fb9b2c03ba1bee72ac0677a667dd8faece/src/core/session.ts#L87)
|
|
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/454450fb9b2c03ba1bee72ac0677a667dd8faece/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/454450fb9b2c03ba1bee72ac0677a667dd8faece/src/core/session.ts#L61)
|
|
90
90
|
|
|
91
91
|
#### Parameters
|
|
92
92
|
|
|
@@ -104,8 +104,20 @@ 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/454450fb9b2c03ba1bee72ac0677a667dd8faece/src/core/session.ts#L79)
|
|
108
108
|
|
|
109
109
|
#### Returns
|
|
110
110
|
|
|
111
111
|
`Record`\<`string`, `any`\>
|
|
112
|
+
|
|
113
|
+
***
|
|
114
|
+
|
|
115
|
+
### getState()
|
|
116
|
+
|
|
117
|
+
> **getState**(): `Promise`\<`undefined` \| \{ `cookies`: [`Cookie`](../interfaces/Cookie.md)[]; \}\>
|
|
118
|
+
|
|
119
|
+
Defined in: [packages/web-fetcher/src/core/session.ts:83](https://github.com/isdk/web-fetcher.js/blob/454450fb9b2c03ba1bee72ac0677a667dd8faece/src/core/session.ts#L83)
|
|
120
|
+
|
|
121
|
+
#### Returns
|
|
122
|
+
|
|
123
|
+
`Promise`\<`undefined` \| \{ `cookies`: [`Cookie`](../interfaces/Cookie.md)[]; \}\>
|