@isdk/web-fetcher 0.2.11 → 0.2.12
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 +81 -20
- package/README.action.md +81 -4
- package/README.engine.cn.md +28 -8
- package/README.engine.md +28 -8
- package/dist/index.d.mts +405 -10
- package/dist/index.d.ts +405 -10
- package/dist/index.js +1 -1
- package/dist/index.mjs +1 -1
- package/docs/_media/README.action.md +81 -4
- package/docs/_media/README.engine.md +28 -8
- package/docs/classes/CheerioFetchEngine.md +354 -67
- 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 +314 -65
- package/docs/classes/FetchSession.md +118 -21
- 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 +339 -66
- package/docs/classes/SubmitAction.md +23 -23
- package/docs/classes/WaitForAction.md +23 -23
- package/docs/classes/WebFetcher.md +53 -5
- package/docs/enumerations/FetchActionResultStatus.md +4 -4
- package/docs/functions/fetchWeb.md +2 -2
- package/docs/interfaces/BaseFetchActionProperties.md +19 -11
- package/docs/interfaces/BaseFetchCollectorActionProperties.md +27 -15
- package/docs/interfaces/BaseFetcherProperties.md +27 -27
- package/docs/interfaces/DispatchedEngineAction.md +4 -4
- package/docs/interfaces/ExtractActionProperties.md +23 -11
- package/docs/interfaces/FetchActionInContext.md +32 -15
- package/docs/interfaces/FetchActionProperties.md +24 -12
- package/docs/interfaces/FetchActionResult.md +6 -6
- package/docs/interfaces/FetchContext.md +80 -37
- package/docs/interfaces/FetchEngineContext.md +51 -32
- package/docs/interfaces/FetchMetadata.md +5 -5
- package/docs/interfaces/FetchResponse.md +14 -14
- package/docs/interfaces/FetchReturnTypeRegistry.md +7 -7
- package/docs/interfaces/FetchSite.md +30 -30
- package/docs/interfaces/FetcherOptions.md +29 -29
- package/docs/interfaces/GotoActionOptions.md +6 -6
- package/docs/interfaces/PendingEngineRequest.md +3 -3
- package/docs/interfaces/StorageOptions.md +5 -5
- 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 +7 -4
|
@@ -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:
|
|
9
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:172](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/engine/base.ts#L172)
|
|
10
10
|
|
|
11
11
|
## Extended by
|
|
12
12
|
|
|
@@ -43,7 +43,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:144](https://github.com/isd
|
|
|
43
43
|
|
|
44
44
|
> `protected` `optional` **\_initialCookies**: [`Cookie`](../interfaces/Cookie.md)[]
|
|
45
45
|
|
|
46
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
46
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:278](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/engine/base.ts#L278)
|
|
47
47
|
|
|
48
48
|
***
|
|
49
49
|
|
|
@@ -51,7 +51,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:241](https://github.com/isd
|
|
|
51
51
|
|
|
52
52
|
> `protected` **\_initializedSessions**: `Set`\<`string`\>
|
|
53
53
|
|
|
54
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
54
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:279](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/engine/base.ts#L279)
|
|
55
55
|
|
|
56
56
|
***
|
|
57
57
|
|
|
@@ -59,7 +59,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:242](https://github.com/isd
|
|
|
59
59
|
|
|
60
60
|
> `protected` **actionEmitter**: `EventEmitter`
|
|
61
61
|
|
|
62
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
62
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:283](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/engine/base.ts#L283)
|
|
63
63
|
|
|
64
64
|
***
|
|
65
65
|
|
|
@@ -67,7 +67,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:246](https://github.com/isd
|
|
|
67
67
|
|
|
68
68
|
> `protected` **blockedTypes**: `Set`\<`string`\>
|
|
69
69
|
|
|
70
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
70
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:288](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/engine/base.ts#L288)
|
|
71
71
|
|
|
72
72
|
***
|
|
73
73
|
|
|
@@ -75,7 +75,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:251](https://github.com/isd
|
|
|
75
75
|
|
|
76
76
|
> `protected` `optional` **config**: `Configuration`
|
|
77
77
|
|
|
78
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
78
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:272](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/engine/base.ts#L272)
|
|
79
79
|
|
|
80
80
|
***
|
|
81
81
|
|
|
@@ -83,7 +83,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:235](https://github.com/isd
|
|
|
83
83
|
|
|
84
84
|
> `protected` `optional` **crawler**: `TCrawler`
|
|
85
85
|
|
|
86
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
86
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:269](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/engine/base.ts#L269)
|
|
87
87
|
|
|
88
88
|
***
|
|
89
89
|
|
|
@@ -91,7 +91,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:232](https://github.com/isd
|
|
|
91
91
|
|
|
92
92
|
> `protected` `optional` **crawlerRunPromise**: `Promise`\<`FinalStatistics`\>
|
|
93
93
|
|
|
94
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
94
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:271](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/engine/base.ts#L271)
|
|
95
95
|
|
|
96
96
|
***
|
|
97
97
|
|
|
@@ -99,7 +99,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:234](https://github.com/isd
|
|
|
99
99
|
|
|
100
100
|
> `protected` `optional` **ctx**: [`FetchEngineContext`](../interfaces/FetchEngineContext.md)
|
|
101
101
|
|
|
102
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
102
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:267](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/engine/base.ts#L267)
|
|
103
103
|
|
|
104
104
|
***
|
|
105
105
|
|
|
@@ -107,7 +107,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:230](https://github.com/isd
|
|
|
107
107
|
|
|
108
108
|
> `protected` `optional` **currentSession**: `Session`
|
|
109
109
|
|
|
110
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
110
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:280](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/engine/base.ts#L280)
|
|
111
111
|
|
|
112
112
|
***
|
|
113
113
|
|
|
@@ -115,7 +115,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:243](https://github.com/isd
|
|
|
115
115
|
|
|
116
116
|
> `protected` **hdrs**: `Record`\<`string`, `string`\> = `{}`
|
|
117
117
|
|
|
118
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
118
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:277](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/engine/base.ts#L277)
|
|
119
119
|
|
|
120
120
|
***
|
|
121
121
|
|
|
@@ -123,7 +123,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:240](https://github.com/isd
|
|
|
123
123
|
|
|
124
124
|
> `protected` `optional` **isCrawlerReady**: `boolean`
|
|
125
125
|
|
|
126
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
126
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:270](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/engine/base.ts#L270)
|
|
127
127
|
|
|
128
128
|
***
|
|
129
129
|
|
|
@@ -131,7 +131,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:233](https://github.com/isd
|
|
|
131
131
|
|
|
132
132
|
> `protected` **isEngineDisposed**: `boolean` = `false`
|
|
133
133
|
|
|
134
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
134
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:285](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/engine/base.ts#L285)
|
|
135
135
|
|
|
136
136
|
***
|
|
137
137
|
|
|
@@ -139,7 +139,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:248](https://github.com/isd
|
|
|
139
139
|
|
|
140
140
|
> `protected` **isPageActive**: `boolean` = `false`
|
|
141
141
|
|
|
142
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
142
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:284](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/engine/base.ts#L284)
|
|
143
143
|
|
|
144
144
|
***
|
|
145
145
|
|
|
@@ -147,7 +147,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:247](https://github.com/isd
|
|
|
147
147
|
|
|
148
148
|
> `protected` `optional` **kvStore**: `KeyValueStore`
|
|
149
149
|
|
|
150
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
150
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:274](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/engine/base.ts#L274)
|
|
151
151
|
|
|
152
152
|
***
|
|
153
153
|
|
|
@@ -155,7 +155,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:237](https://github.com/isd
|
|
|
155
155
|
|
|
156
156
|
> `protected` `optional` **lastResponse**: [`FetchResponse`](../interfaces/FetchResponse.md)
|
|
157
157
|
|
|
158
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
158
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:287](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/engine/base.ts#L287)
|
|
159
159
|
|
|
160
160
|
***
|
|
161
161
|
|
|
@@ -163,7 +163,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:250](https://github.com/isd
|
|
|
163
163
|
|
|
164
164
|
> `protected` **navigationLock**: `PromiseLock`
|
|
165
165
|
|
|
166
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
166
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:286](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/engine/base.ts#L286)
|
|
167
167
|
|
|
168
168
|
***
|
|
169
169
|
|
|
@@ -171,7 +171,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:249](https://github.com/isd
|
|
|
171
171
|
|
|
172
172
|
> `protected` `optional` **opts**: [`BaseFetcherProperties`](../interfaces/BaseFetcherProperties.md)
|
|
173
173
|
|
|
174
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
174
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:268](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/engine/base.ts#L268)
|
|
175
175
|
|
|
176
176
|
***
|
|
177
177
|
|
|
@@ -179,7 +179,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:231](https://github.com/isd
|
|
|
179
179
|
|
|
180
180
|
> `protected` **pendingRequests**: `Map`\<`string`, [`PendingEngineRequest`](../interfaces/PendingEngineRequest.md)\>
|
|
181
181
|
|
|
182
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
182
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:281](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/engine/base.ts#L281)
|
|
183
183
|
|
|
184
184
|
***
|
|
185
185
|
|
|
@@ -187,7 +187,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:244](https://github.com/isd
|
|
|
187
187
|
|
|
188
188
|
> `protected` `optional` **proxyConfiguration**: `ProxyConfiguration`
|
|
189
189
|
|
|
190
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
190
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:275](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/engine/base.ts#L275)
|
|
191
191
|
|
|
192
192
|
***
|
|
193
193
|
|
|
@@ -195,7 +195,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:238](https://github.com/isd
|
|
|
195
195
|
|
|
196
196
|
> `protected` **requestCounter**: `number` = `0`
|
|
197
197
|
|
|
198
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
198
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:282](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/engine/base.ts#L282)
|
|
199
199
|
|
|
200
200
|
***
|
|
201
201
|
|
|
@@ -203,7 +203,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:245](https://github.com/isd
|
|
|
203
203
|
|
|
204
204
|
> `protected` `optional` **requestQueue**: `RequestQueue`
|
|
205
205
|
|
|
206
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
206
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:273](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/engine/base.ts#L273)
|
|
207
207
|
|
|
208
208
|
***
|
|
209
209
|
|
|
@@ -211,7 +211,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:236](https://github.com/isd
|
|
|
211
211
|
|
|
212
212
|
> `readonly` `static` **id**: `string`
|
|
213
213
|
|
|
214
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
214
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:257](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/engine/base.ts#L257)
|
|
215
215
|
|
|
216
216
|
Unique identifier for the engine implementation.
|
|
217
217
|
|
|
@@ -225,7 +225,7 @@ Must be defined by concrete implementations. Used for registration and lookup in
|
|
|
225
225
|
|
|
226
226
|
> `readonly` `static` **mode**: [`FetchEngineType`](../type-aliases/FetchEngineType.md)
|
|
227
227
|
|
|
228
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
228
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:265](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/engine/base.ts#L265)
|
|
229
229
|
|
|
230
230
|
Execution mode of the engine (`'http'` or `'browser'`).
|
|
231
231
|
|
|
@@ -241,7 +241,7 @@ Must be defined by concrete implementations. Indicates whether engine operates a
|
|
|
241
241
|
|
|
242
242
|
> **get** **context**(): `undefined` \| [`FetchEngineContext`](../interfaces/FetchEngineContext.md)
|
|
243
243
|
|
|
244
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
244
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:938](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/engine/base.ts#L938)
|
|
245
245
|
|
|
246
246
|
Gets the fetch engine context associated with this instance.
|
|
247
247
|
|
|
@@ -257,7 +257,7 @@ Gets the fetch engine context associated with this instance.
|
|
|
257
257
|
|
|
258
258
|
> **get** **id**(): `string`
|
|
259
259
|
|
|
260
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
260
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:913](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/engine/base.ts#L913)
|
|
261
261
|
|
|
262
262
|
Gets the unique identifier of this engine implementation.
|
|
263
263
|
|
|
@@ -273,7 +273,7 @@ Gets the unique identifier of this engine implementation.
|
|
|
273
273
|
|
|
274
274
|
> **get** **mode**(): [`FetchEngineType`](../type-aliases/FetchEngineType.md)
|
|
275
275
|
|
|
276
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
276
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:931](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/engine/base.ts#L931)
|
|
277
277
|
|
|
278
278
|
Gets the execution mode of this engine (`'http'` or `'browser'`).
|
|
279
279
|
|
|
@@ -287,7 +287,7 @@ Gets the execution mode of this engine (`'http'` or `'browser'`).
|
|
|
287
287
|
|
|
288
288
|
> `abstract` `protected` **\_buildResponse**(`context`): `Promise`\<[`FetchResponse`](../interfaces/FetchResponse.md)\>
|
|
289
289
|
|
|
290
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
290
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:722](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/engine/base.ts#L722)
|
|
291
291
|
|
|
292
292
|
**`Internal`**
|
|
293
293
|
|
|
@@ -317,7 +317,7 @@ Converts implementation-specific context (Playwright `page` or Cheerio `$`) to s
|
|
|
317
317
|
|
|
318
318
|
> `protected` `optional` **\_cleanup**(): `Promise`\<`void`\>
|
|
319
319
|
|
|
320
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
320
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:290](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/engine/base.ts#L290)
|
|
321
321
|
|
|
322
322
|
#### Returns
|
|
323
323
|
|
|
@@ -329,7 +329,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:253](https://github.com/isd
|
|
|
329
329
|
|
|
330
330
|
> `protected` **\_commonCleanup**(): `Promise`\<`void`\>
|
|
331
331
|
|
|
332
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
332
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:1239](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/engine/base.ts#L1239)
|
|
333
333
|
|
|
334
334
|
#### Returns
|
|
335
335
|
|
|
@@ -341,7 +341,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:781](https://github.com/isd
|
|
|
341
341
|
|
|
342
342
|
> `abstract` `protected` **\_createCrawler**(`options`, `config?`): `TCrawler`
|
|
343
343
|
|
|
344
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
344
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:699](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/engine/base.ts#L699)
|
|
345
345
|
|
|
346
346
|
**`Internal`**
|
|
347
347
|
|
|
@@ -369,7 +369,7 @@ The final crawler options.
|
|
|
369
369
|
|
|
370
370
|
> `protected` **\_executePendingActions**(`context`): `Promise`\<`void`\>
|
|
371
371
|
|
|
372
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
372
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:1120](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/engine/base.ts#L1120)
|
|
373
373
|
|
|
374
374
|
**`Internal`**
|
|
375
375
|
|
|
@@ -418,7 +418,7 @@ If called outside valid page context window (`!this.isPageActive`)
|
|
|
418
418
|
|
|
419
419
|
> `protected` **\_extract**(`schema`, `context`): `Promise`\<`any`\>
|
|
420
420
|
|
|
421
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
421
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:365](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/engine/base.ts#L365)
|
|
422
422
|
|
|
423
423
|
#### Parameters
|
|
424
424
|
|
|
@@ -436,11 +436,121 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:258](https://github.com/isd
|
|
|
436
436
|
|
|
437
437
|
***
|
|
438
438
|
|
|
439
|
+
### \_extractColumnar()
|
|
440
|
+
|
|
441
|
+
> `protected` **\_extractColumnar**(`schema`, `container`, `opts?`): `Promise`\<`null` \| `any`[]\>
|
|
442
|
+
|
|
443
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:489](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/engine/base.ts#L489)
|
|
444
|
+
|
|
445
|
+
**`Internal`**
|
|
446
|
+
|
|
447
|
+
Performs columnar extraction (Column Alignment Mode).
|
|
448
|
+
|
|
449
|
+
#### Parameters
|
|
450
|
+
|
|
451
|
+
##### schema
|
|
452
|
+
|
|
453
|
+
`ExtractSchema`
|
|
454
|
+
|
|
455
|
+
The schema for a single item (must be an object or implicit object).
|
|
456
|
+
|
|
457
|
+
##### container
|
|
458
|
+
|
|
459
|
+
`any`
|
|
460
|
+
|
|
461
|
+
The container element to search within.
|
|
462
|
+
|
|
463
|
+
##### opts?
|
|
464
|
+
|
|
465
|
+
`ColumnarOptions`
|
|
466
|
+
|
|
467
|
+
Columnar extraction options (strict, inference).
|
|
468
|
+
|
|
469
|
+
#### Returns
|
|
470
|
+
|
|
471
|
+
`Promise`\<`null` \| `any`[]\>
|
|
472
|
+
|
|
473
|
+
An array of extracted items, or null if requirements aren't met.
|
|
474
|
+
|
|
475
|
+
***
|
|
476
|
+
|
|
477
|
+
### \_extractNested()
|
|
478
|
+
|
|
479
|
+
> `protected` **\_extractNested**(`items`, `elements`): `Promise`\<`any`[]\>
|
|
480
|
+
|
|
481
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:469](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/engine/base.ts#L469)
|
|
482
|
+
|
|
483
|
+
**`Internal`**
|
|
484
|
+
|
|
485
|
+
Performs standard nested array extraction.
|
|
486
|
+
|
|
487
|
+
#### Parameters
|
|
488
|
+
|
|
489
|
+
##### items
|
|
490
|
+
|
|
491
|
+
`ExtractSchema`
|
|
492
|
+
|
|
493
|
+
The schema for each item.
|
|
494
|
+
|
|
495
|
+
##### elements
|
|
496
|
+
|
|
497
|
+
`any`[]
|
|
498
|
+
|
|
499
|
+
The list of item elements.
|
|
500
|
+
|
|
501
|
+
#### Returns
|
|
502
|
+
|
|
503
|
+
`Promise`\<`any`[]\>
|
|
504
|
+
|
|
505
|
+
***
|
|
506
|
+
|
|
507
|
+
### \_extractSegmented()
|
|
508
|
+
|
|
509
|
+
> `protected` **\_extractSegmented**(`schema`, `container`, `opts?`): `Promise`\<`null` \| `any`[]\>
|
|
510
|
+
|
|
511
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:651](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/engine/base.ts#L651)
|
|
512
|
+
|
|
513
|
+
**`Internal`**
|
|
514
|
+
|
|
515
|
+
Performs segmented extraction (Anchor-based Scanning).
|
|
516
|
+
|
|
517
|
+
#### Parameters
|
|
518
|
+
|
|
519
|
+
##### schema
|
|
520
|
+
|
|
521
|
+
`ExtractSchema`
|
|
522
|
+
|
|
523
|
+
The schema for a single item (must be an object).
|
|
524
|
+
|
|
525
|
+
##### container
|
|
526
|
+
|
|
527
|
+
`any`
|
|
528
|
+
|
|
529
|
+
The container element to scan.
|
|
530
|
+
|
|
531
|
+
##### opts?
|
|
532
|
+
|
|
533
|
+
`SegmentedOptions`
|
|
534
|
+
|
|
535
|
+
Segmented extraction options (anchor).
|
|
536
|
+
|
|
537
|
+
#### Returns
|
|
538
|
+
|
|
539
|
+
`Promise`\<`null` \| `any`[]\>
|
|
540
|
+
|
|
541
|
+
An array of extracted items.
|
|
542
|
+
|
|
543
|
+
***
|
|
544
|
+
|
|
439
545
|
### \_extractValue()
|
|
440
546
|
|
|
441
547
|
> `abstract` `protected` **\_extractValue**(`schema`, `context`): `Promise`\<`any`\>
|
|
442
548
|
|
|
443
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
549
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:309](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/engine/base.ts#L309)
|
|
550
|
+
|
|
551
|
+
**`Internal`**
|
|
552
|
+
|
|
553
|
+
Extracts a primitive value from the element based on schema.
|
|
444
554
|
|
|
445
555
|
#### Parameters
|
|
446
556
|
|
|
@@ -448,10 +558,14 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:256](https://github.com/isd
|
|
|
448
558
|
|
|
449
559
|
`ExtractValueSchema`
|
|
450
560
|
|
|
561
|
+
Value extraction schema.
|
|
562
|
+
|
|
451
563
|
##### context
|
|
452
564
|
|
|
453
565
|
`any`
|
|
454
566
|
|
|
567
|
+
The element context.
|
|
568
|
+
|
|
455
569
|
#### Returns
|
|
456
570
|
|
|
457
571
|
`Promise`\<`any`\>
|
|
@@ -462,7 +576,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:256](https://github.com/isd
|
|
|
462
576
|
|
|
463
577
|
> `abstract` `protected` **\_getSpecificCrawlerOptions**(`ctx`): `Partial`\<`TOptions`\> \| `Promise`\<`Partial`\<`TOptions`\>\>
|
|
464
578
|
|
|
465
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
579
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:709](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/engine/base.ts#L709)
|
|
466
580
|
|
|
467
581
|
**`Internal`**
|
|
468
582
|
|
|
@@ -482,11 +596,114 @@ The fetch engine context.
|
|
|
482
596
|
|
|
483
597
|
***
|
|
484
598
|
|
|
599
|
+
### \_isImplicitObject()
|
|
600
|
+
|
|
601
|
+
> `protected` **\_isImplicitObject**(`schema`): `boolean`
|
|
602
|
+
|
|
603
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:344](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/engine/base.ts#L344)
|
|
604
|
+
|
|
605
|
+
#### Parameters
|
|
606
|
+
|
|
607
|
+
##### schema
|
|
608
|
+
|
|
609
|
+
`any`
|
|
610
|
+
|
|
611
|
+
#### Returns
|
|
612
|
+
|
|
613
|
+
`boolean`
|
|
614
|
+
|
|
615
|
+
***
|
|
616
|
+
|
|
617
|
+
### \_isSameElement()
|
|
618
|
+
|
|
619
|
+
> `abstract` `protected` **\_isSameElement**(`element1`, `element2`): `Promise`\<`boolean`\>
|
|
620
|
+
|
|
621
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:327](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/engine/base.ts#L327)
|
|
622
|
+
|
|
623
|
+
**`Internal`**
|
|
624
|
+
|
|
625
|
+
Checks if two elements are the same.
|
|
626
|
+
|
|
627
|
+
#### Parameters
|
|
628
|
+
|
|
629
|
+
##### element1
|
|
630
|
+
|
|
631
|
+
`any`
|
|
632
|
+
|
|
633
|
+
First element.
|
|
634
|
+
|
|
635
|
+
##### element2
|
|
636
|
+
|
|
637
|
+
`any`
|
|
638
|
+
|
|
639
|
+
Second element.
|
|
640
|
+
|
|
641
|
+
#### Returns
|
|
642
|
+
|
|
643
|
+
`Promise`\<`boolean`\>
|
|
644
|
+
|
|
645
|
+
***
|
|
646
|
+
|
|
647
|
+
### \_nextSiblingsUntil()
|
|
648
|
+
|
|
649
|
+
> `abstract` `protected` **\_nextSiblingsUntil**(`element`, `untilSelector?`): `Promise`\<`any`[]\>
|
|
650
|
+
|
|
651
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:339](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/engine/base.ts#L339)
|
|
652
|
+
|
|
653
|
+
**`Internal`**
|
|
654
|
+
|
|
655
|
+
Gets all subsequent siblings of an element until a sibling matches the selector.
|
|
656
|
+
Used in 'segmented' extraction mode.
|
|
657
|
+
|
|
658
|
+
#### Parameters
|
|
659
|
+
|
|
660
|
+
##### element
|
|
661
|
+
|
|
662
|
+
`any`
|
|
663
|
+
|
|
664
|
+
The anchor element.
|
|
665
|
+
|
|
666
|
+
##### untilSelector?
|
|
667
|
+
|
|
668
|
+
`string`
|
|
669
|
+
|
|
670
|
+
Optional selector that marks the end of the segment.
|
|
671
|
+
|
|
672
|
+
#### Returns
|
|
673
|
+
|
|
674
|
+
`Promise`\<`any`[]\>
|
|
675
|
+
|
|
676
|
+
***
|
|
677
|
+
|
|
678
|
+
### \_normalizeArrayMode()
|
|
679
|
+
|
|
680
|
+
> `protected` **\_normalizeArrayMode**(`mode?`): `any`
|
|
681
|
+
|
|
682
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:455](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/engine/base.ts#L455)
|
|
683
|
+
|
|
684
|
+
**`Internal`**
|
|
685
|
+
|
|
686
|
+
Normalizes the array extraction mode into an options object.
|
|
687
|
+
|
|
688
|
+
#### Parameters
|
|
689
|
+
|
|
690
|
+
##### mode?
|
|
691
|
+
|
|
692
|
+
`ExtractArrayMode`
|
|
693
|
+
|
|
694
|
+
The mode string or options object.
|
|
695
|
+
|
|
696
|
+
#### Returns
|
|
697
|
+
|
|
698
|
+
`any`
|
|
699
|
+
|
|
700
|
+
***
|
|
701
|
+
|
|
485
702
|
### \_normalizeSchema()
|
|
486
703
|
|
|
487
704
|
> `protected` **\_normalizeSchema**(`schema`): `ExtractSchema`
|
|
488
705
|
|
|
489
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
706
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:867](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/engine/base.ts#L867)
|
|
490
707
|
|
|
491
708
|
#### Parameters
|
|
492
709
|
|
|
@@ -500,11 +717,39 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:459](https://github.com/isd
|
|
|
500
717
|
|
|
501
718
|
***
|
|
502
719
|
|
|
720
|
+
### \_parentElement()
|
|
721
|
+
|
|
722
|
+
> `abstract` `protected` **\_parentElement**(`element`): `Promise`\<`any`\>
|
|
723
|
+
|
|
724
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:319](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/engine/base.ts#L319)
|
|
725
|
+
|
|
726
|
+
**`Internal`**
|
|
727
|
+
|
|
728
|
+
Gets the parent element of the given element.
|
|
729
|
+
|
|
730
|
+
#### Parameters
|
|
731
|
+
|
|
732
|
+
##### element
|
|
733
|
+
|
|
734
|
+
`any`
|
|
735
|
+
|
|
736
|
+
The element.
|
|
737
|
+
|
|
738
|
+
#### Returns
|
|
739
|
+
|
|
740
|
+
`Promise`\<`any`\>
|
|
741
|
+
|
|
742
|
+
***
|
|
743
|
+
|
|
503
744
|
### \_querySelectorAll()
|
|
504
745
|
|
|
505
746
|
> `abstract` `protected` **\_querySelectorAll**(`context`, `selector`): `Promise`\<`any`[]\>
|
|
506
747
|
|
|
507
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
748
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:298](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/engine/base.ts#L298)
|
|
749
|
+
|
|
750
|
+
**`Internal`**
|
|
751
|
+
|
|
752
|
+
Finds all elements matching the selector within the given context.
|
|
508
753
|
|
|
509
754
|
#### Parameters
|
|
510
755
|
|
|
@@ -512,10 +757,14 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:255](https://github.com/isd
|
|
|
512
757
|
|
|
513
758
|
`any`
|
|
514
759
|
|
|
760
|
+
The context to search in (Engine-specific element/node or array of nodes).
|
|
761
|
+
|
|
515
762
|
##### selector
|
|
516
763
|
|
|
517
764
|
`string`
|
|
518
765
|
|
|
766
|
+
CSS selector.
|
|
767
|
+
|
|
519
768
|
#### Returns
|
|
520
769
|
|
|
521
770
|
`Promise`\<`any`[]\>
|
|
@@ -526,7 +775,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:255](https://github.com/isd
|
|
|
526
775
|
|
|
527
776
|
> `protected` **\_sharedFailedRequestHandler**(`context`, `error?`): `Promise`\<`void`\>
|
|
528
777
|
|
|
529
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
778
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:1196](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/engine/base.ts#L1196)
|
|
530
779
|
|
|
531
780
|
#### Parameters
|
|
532
781
|
|
|
@@ -548,7 +797,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:748](https://github.com/isd
|
|
|
548
797
|
|
|
549
798
|
> `protected` **\_sharedRequestHandler**(`context`): `Promise`\<`void`\>
|
|
550
799
|
|
|
551
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
800
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:1156](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/engine/base.ts#L1156)
|
|
552
801
|
|
|
553
802
|
#### Parameters
|
|
554
803
|
|
|
@@ -566,7 +815,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:713](https://github.com/isd
|
|
|
566
815
|
|
|
567
816
|
> **blockResources**(`types`, `overwrite?`): `Promise`\<`number`\>
|
|
568
817
|
|
|
569
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
818
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:1302](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/engine/base.ts#L1302)
|
|
570
819
|
|
|
571
820
|
Blocks specified resource types from loading.
|
|
572
821
|
|
|
@@ -603,7 +852,7 @@ await engine.blockResources(['script'], true); // Replace existing
|
|
|
603
852
|
|
|
604
853
|
> `protected` **buildResponse**(`context`): `Promise`\<[`FetchResponse`](../interfaces/FetchResponse.md)\>
|
|
605
854
|
|
|
606
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
855
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:723](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/engine/base.ts#L723)
|
|
607
856
|
|
|
608
857
|
#### Parameters
|
|
609
858
|
|
|
@@ -621,7 +870,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:327](https://github.com/isd
|
|
|
621
870
|
|
|
622
871
|
> **cleanup**(): `Promise`\<`void`\>
|
|
623
872
|
|
|
624
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
873
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:1084](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/engine/base.ts#L1084)
|
|
625
874
|
|
|
626
875
|
#### Returns
|
|
627
876
|
|
|
@@ -633,7 +882,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:645](https://github.com/isd
|
|
|
633
882
|
|
|
634
883
|
> **click**(`selector`): `Promise`\<`void`\>
|
|
635
884
|
|
|
636
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
885
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:817](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/engine/base.ts#L817)
|
|
637
886
|
|
|
638
887
|
Clicks on element matching selector.
|
|
639
888
|
|
|
@@ -663,7 +912,7 @@ When no active page context exists
|
|
|
663
912
|
|
|
664
913
|
> **cookies**(): `Promise`\<[`Cookie`](../interfaces/Cookie.md)[]\>
|
|
665
914
|
|
|
666
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
915
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:1418](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/engine/base.ts#L1418)
|
|
667
916
|
|
|
668
917
|
Manages cookies for current session with multiple overloads.
|
|
669
918
|
|
|
@@ -688,7 +937,7 @@ await engine.cookies([{ name: 'session', value: '123' }]);
|
|
|
688
937
|
|
|
689
938
|
> **cookies**(`cookies`): `Promise`\<`boolean`\>
|
|
690
939
|
|
|
691
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
940
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:1419](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/engine/base.ts#L1419)
|
|
692
941
|
|
|
693
942
|
Manages cookies for current session with multiple overloads.
|
|
694
943
|
|
|
@@ -723,7 +972,7 @@ await engine.cookies([{ name: 'session', value: '123' }]);
|
|
|
723
972
|
|
|
724
973
|
> `protected` **dispatchAction**\<`T`\>(`action`): `Promise`\<`T`\>
|
|
725
974
|
|
|
726
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
975
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:1219](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/engine/base.ts#L1219)
|
|
727
976
|
|
|
728
977
|
#### Type Parameters
|
|
729
978
|
|
|
@@ -747,7 +996,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:764](https://github.com/isd
|
|
|
747
996
|
|
|
748
997
|
> **dispose**(): `Promise`\<`void`\>
|
|
749
998
|
|
|
750
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
999
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:1454](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/engine/base.ts#L1454)
|
|
751
1000
|
|
|
752
1001
|
Disposes of engine, cleaning up all resources.
|
|
753
1002
|
|
|
@@ -763,7 +1012,7 @@ Promise resolving when disposal completes
|
|
|
763
1012
|
|
|
764
1013
|
> `abstract` `protected` **executeAction**(`context`, `action`): `Promise`\<`any`\>
|
|
765
1014
|
|
|
766
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1015
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:772](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/engine/base.ts#L772)
|
|
767
1016
|
|
|
768
1017
|
**`Internal`**
|
|
769
1018
|
|
|
@@ -799,7 +1048,7 @@ Handles specific user interactions using underlying technology (Playwright/Cheer
|
|
|
799
1048
|
|
|
800
1049
|
> **extract**\<`T`\>(`schema`): `Promise`\<`T`\>
|
|
801
1050
|
|
|
802
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1051
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:862](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/engine/base.ts#L862)
|
|
803
1052
|
|
|
804
1053
|
Extracts structured data from the current page content.
|
|
805
1054
|
|
|
@@ -829,7 +1078,7 @@ A promise that resolves to an object with the extracted data.
|
|
|
829
1078
|
|
|
830
1079
|
> **fill**(`selector`, `value`): `Promise`\<`void`\>
|
|
831
1080
|
|
|
832
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1081
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:829](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/engine/base.ts#L829)
|
|
833
1082
|
|
|
834
1083
|
Fills input element with specified value.
|
|
835
1084
|
|
|
@@ -863,7 +1112,7 @@ When no active page context exists
|
|
|
863
1112
|
|
|
864
1113
|
> **getContent**(): `Promise`\<[`FetchResponse`](../interfaces/FetchResponse.md)\>
|
|
865
1114
|
|
|
866
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1115
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:1316](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/engine/base.ts#L1316)
|
|
867
1116
|
|
|
868
1117
|
Gets content of current page.
|
|
869
1118
|
|
|
@@ -883,7 +1132,7 @@ When no content has been fetched yet
|
|
|
883
1132
|
|
|
884
1133
|
> **getState**(): `Promise`\<\{ `cookies`: [`Cookie`](../interfaces/Cookie.md)[]; `sessionState?`: `any`; \}\>
|
|
885
1134
|
|
|
886
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1135
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:921](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/engine/base.ts#L921)
|
|
887
1136
|
|
|
888
1137
|
Returns the current state of the engine (cookies)
|
|
889
1138
|
that can be used to restore the session later.
|
|
@@ -898,7 +1147,7 @@ that can be used to restore the session later.
|
|
|
898
1147
|
|
|
899
1148
|
> `abstract` **goto**(`url`, `params?`): `Promise`\<`void` \| [`FetchResponse`](../interfaces/FetchResponse.md)\>
|
|
900
1149
|
|
|
901
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1150
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:789](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/engine/base.ts#L789)
|
|
902
1151
|
|
|
903
1152
|
Navigates to the specified URL.
|
|
904
1153
|
|
|
@@ -936,7 +1185,7 @@ await engine.goto('https://example.com');
|
|
|
936
1185
|
|
|
937
1186
|
> **headers**(): `Promise`\<`Record`\<`string`, `string`\>\>
|
|
938
1187
|
|
|
939
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1188
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:1357](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/engine/base.ts#L1357)
|
|
940
1189
|
|
|
941
1190
|
Manages HTTP headers for requests with multiple overloads.
|
|
942
1191
|
|
|
@@ -963,7 +1212,7 @@ await engine.headers('auth', 'token');
|
|
|
963
1212
|
|
|
964
1213
|
> **headers**(`name`): `Promise`\<`string`\>
|
|
965
1214
|
|
|
966
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1215
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:1358](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/engine/base.ts#L1358)
|
|
967
1216
|
|
|
968
1217
|
Manages HTTP headers for requests with multiple overloads.
|
|
969
1218
|
|
|
@@ -998,7 +1247,7 @@ await engine.headers('auth', 'token');
|
|
|
998
1247
|
|
|
999
1248
|
> **headers**(`headers`, `replaced?`): `Promise`\<`boolean`\>
|
|
1000
1249
|
|
|
1001
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1250
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:1359](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/engine/base.ts#L1359)
|
|
1002
1251
|
|
|
1003
1252
|
Manages HTTP headers for requests with multiple overloads.
|
|
1004
1253
|
|
|
@@ -1039,7 +1288,7 @@ await engine.headers('auth', 'token');
|
|
|
1039
1288
|
|
|
1040
1289
|
> **headers**(`name`, `value`): `Promise`\<`boolean`\>
|
|
1041
1290
|
|
|
1042
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1291
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:1363](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/engine/base.ts#L1363)
|
|
1043
1292
|
|
|
1044
1293
|
Manages HTTP headers for requests with multiple overloads.
|
|
1045
1294
|
|
|
@@ -1082,7 +1331,7 @@ await engine.headers('auth', 'token');
|
|
|
1082
1331
|
|
|
1083
1332
|
> **initialize**(`context`, `options?`): `Promise`\<`void`\>
|
|
1084
1333
|
|
|
1085
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1334
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:953](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/engine/base.ts#L953)
|
|
1086
1335
|
|
|
1087
1336
|
Initializes the fetch engine with provided context and options.
|
|
1088
1337
|
|
|
@@ -1117,7 +1366,7 @@ Automatically called when creating engine via `FetchEngine.create()`.
|
|
|
1117
1366
|
|
|
1118
1367
|
> **pause**(`message?`): `Promise`\<`void`\>
|
|
1119
1368
|
|
|
1120
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1369
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:852](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/engine/base.ts#L852)
|
|
1121
1370
|
|
|
1122
1371
|
Pauses execution, allowing for manual intervention or inspection.
|
|
1123
1372
|
|
|
@@ -1145,7 +1394,7 @@ When no active page context exists
|
|
|
1145
1394
|
|
|
1146
1395
|
> **submit**(`selector?`, `options?`): `Promise`\<`void`\>
|
|
1147
1396
|
|
|
1148
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1397
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:841](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/engine/base.ts#L841)
|
|
1149
1398
|
|
|
1150
1399
|
Submits a form.
|
|
1151
1400
|
|
|
@@ -1179,7 +1428,7 @@ When no active page context exists
|
|
|
1179
1428
|
|
|
1180
1429
|
> **waitFor**(`params?`): `Promise`\<`void`\>
|
|
1181
1430
|
|
|
1182
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1431
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:806](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/engine/base.ts#L806)
|
|
1183
1432
|
|
|
1184
1433
|
Waits for specified condition before continuing.
|
|
1185
1434
|
|
|
@@ -1210,7 +1459,7 @@ await engine.waitFor({ selector: '#content' }); // Wait for element
|
|
|
1210
1459
|
|
|
1211
1460
|
> `static` **create**(`ctx`, `options?`): `Promise`\<`undefined` \| `AnyFetchEngine`\>
|
|
1212
1461
|
|
|
1213
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1462
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:231](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/engine/base.ts#L231)
|
|
1214
1463
|
|
|
1215
1464
|
Factory method to create and initialize a fetch engine instance.
|
|
1216
1465
|
|
|
@@ -1248,7 +1497,7 @@ Primary entry point for engine creation. Selects appropriate implementation base
|
|
|
1248
1497
|
|
|
1249
1498
|
> `static` **get**(`id`): `undefined` \| `AnyFetchEngineCtor`
|
|
1250
1499
|
|
|
1251
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1500
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:204](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/engine/base.ts#L204)
|
|
1252
1501
|
|
|
1253
1502
|
Retrieves a fetch engine implementation by its unique ID.
|
|
1254
1503
|
|
|
@@ -1272,7 +1521,7 @@ Engine class if found, otherwise `undefined`
|
|
|
1272
1521
|
|
|
1273
1522
|
> `static` **getByMode**(`mode`): `undefined` \| `AnyFetchEngineCtor`
|
|
1274
1523
|
|
|
1275
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1524
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:214](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/engine/base.ts#L214)
|
|
1276
1525
|
|
|
1277
1526
|
Retrieves a fetch engine implementation by execution mode.
|
|
1278
1527
|
|
|
@@ -1296,7 +1545,7 @@ Engine class if found, otherwise `undefined`
|
|
|
1296
1545
|
|
|
1297
1546
|
> `static` **register**(`engineClass`): `void`
|
|
1298
1547
|
|
|
1299
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1548
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:191](https://github.com/isdk/web-fetcher.js/blob/61e40bab9fc20e6de9e2060909d088d8c6cc7b99/src/engine/base.ts#L191)
|
|
1300
1549
|
|
|
1301
1550
|
Registers a fetch engine implementation with the global registry.
|
|
1302
1551
|
|