@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
|
# Class: PlaywrightFetchEngine
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/web-fetcher/src/engine/playwright.ts:16](https://github.com/isdk/web-fetcher.js/blob/
|
|
9
|
+
Defined in: [packages/web-fetcher/src/engine/playwright.ts:16](https://github.com/isdk/web-fetcher.js/blob/454450fb9b2c03ba1bee72ac0677a667dd8faece/src/engine/playwright.ts#L16)
|
|
10
10
|
|
|
11
11
|
## Extends
|
|
12
12
|
|
|
@@ -32,7 +32,7 @@ Defined in: [packages/web-fetcher/src/engine/playwright.ts:16](https://github.co
|
|
|
32
32
|
|
|
33
33
|
> `protected` **actionEmitter**: `EventEmitter`
|
|
34
34
|
|
|
35
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:236](https://github.com/isdk/web-fetcher.js/blob/
|
|
35
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:236](https://github.com/isdk/web-fetcher.js/blob/454450fb9b2c03ba1bee72ac0677a667dd8faece/src/engine/base.ts#L236)
|
|
36
36
|
|
|
37
37
|
#### Inherited from
|
|
38
38
|
|
|
@@ -44,7 +44,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:236](https://github.com/isd
|
|
|
44
44
|
|
|
45
45
|
> `protected` **blockedTypes**: `Set`\<`string`\>
|
|
46
46
|
|
|
47
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:240](https://github.com/isdk/web-fetcher.js/blob/
|
|
47
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:240](https://github.com/isdk/web-fetcher.js/blob/454450fb9b2c03ba1bee72ac0677a667dd8faece/src/engine/base.ts#L240)
|
|
48
48
|
|
|
49
49
|
#### Inherited from
|
|
50
50
|
|
|
@@ -56,7 +56,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:240](https://github.com/isd
|
|
|
56
56
|
|
|
57
57
|
> `protected` `optional` **crawler**: `PlaywrightCrawler`
|
|
58
58
|
|
|
59
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:228](https://github.com/isdk/web-fetcher.js/blob/
|
|
59
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:228](https://github.com/isdk/web-fetcher.js/blob/454450fb9b2c03ba1bee72ac0677a667dd8faece/src/engine/base.ts#L228)
|
|
60
60
|
|
|
61
61
|
#### Inherited from
|
|
62
62
|
|
|
@@ -68,7 +68,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:228](https://github.com/isd
|
|
|
68
68
|
|
|
69
69
|
> `protected` `optional` **ctx**: [`FetchEngineContext`](../interfaces/FetchEngineContext.md)
|
|
70
70
|
|
|
71
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:226](https://github.com/isdk/web-fetcher.js/blob/
|
|
71
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:226](https://github.com/isdk/web-fetcher.js/blob/454450fb9b2c03ba1bee72ac0677a667dd8faece/src/engine/base.ts#L226)
|
|
72
72
|
|
|
73
73
|
#### Inherited from
|
|
74
74
|
|
|
@@ -80,7 +80,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:226](https://github.com/isd
|
|
|
80
80
|
|
|
81
81
|
> `protected` **hdrs**: `Record`\<`string`, `string`\> = `{}`
|
|
82
82
|
|
|
83
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:232](https://github.com/isdk/web-fetcher.js/blob/
|
|
83
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:232](https://github.com/isdk/web-fetcher.js/blob/454450fb9b2c03ba1bee72ac0677a667dd8faece/src/engine/base.ts#L232)
|
|
84
84
|
|
|
85
85
|
#### Inherited from
|
|
86
86
|
|
|
@@ -92,7 +92,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:232](https://github.com/isd
|
|
|
92
92
|
|
|
93
93
|
> `protected` `optional` **isCrawlerReady**: `boolean`
|
|
94
94
|
|
|
95
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:229](https://github.com/isdk/web-fetcher.js/blob/
|
|
95
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:229](https://github.com/isdk/web-fetcher.js/blob/454450fb9b2c03ba1bee72ac0677a667dd8faece/src/engine/base.ts#L229)
|
|
96
96
|
|
|
97
97
|
#### Inherited from
|
|
98
98
|
|
|
@@ -104,7 +104,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:229](https://github.com/isd
|
|
|
104
104
|
|
|
105
105
|
> `protected` **isPageActive**: `boolean` = `false`
|
|
106
106
|
|
|
107
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:237](https://github.com/isdk/web-fetcher.js/blob/
|
|
107
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:237](https://github.com/isdk/web-fetcher.js/blob/454450fb9b2c03ba1bee72ac0677a667dd8faece/src/engine/base.ts#L237)
|
|
108
108
|
|
|
109
109
|
#### Inherited from
|
|
110
110
|
|
|
@@ -116,7 +116,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:237](https://github.com/isd
|
|
|
116
116
|
|
|
117
117
|
> `protected` **jar**: [`Cookie`](../interfaces/Cookie.md)[] = `[]`
|
|
118
118
|
|
|
119
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:233](https://github.com/isdk/web-fetcher.js/blob/
|
|
119
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:233](https://github.com/isdk/web-fetcher.js/blob/454450fb9b2c03ba1bee72ac0677a667dd8faece/src/engine/base.ts#L233)
|
|
120
120
|
|
|
121
121
|
#### Inherited from
|
|
122
122
|
|
|
@@ -128,7 +128,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:233](https://github.com/isd
|
|
|
128
128
|
|
|
129
129
|
> `protected` `optional` **lastResponse**: [`FetchResponse`](../interfaces/FetchResponse.md)
|
|
130
130
|
|
|
131
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:239](https://github.com/isdk/web-fetcher.js/blob/
|
|
131
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:239](https://github.com/isdk/web-fetcher.js/blob/454450fb9b2c03ba1bee72ac0677a667dd8faece/src/engine/base.ts#L239)
|
|
132
132
|
|
|
133
133
|
#### Inherited from
|
|
134
134
|
|
|
@@ -140,7 +140,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:239](https://github.com/isd
|
|
|
140
140
|
|
|
141
141
|
> `protected` **navigationLock**: `PromiseLock`
|
|
142
142
|
|
|
143
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:238](https://github.com/isdk/web-fetcher.js/blob/
|
|
143
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:238](https://github.com/isdk/web-fetcher.js/blob/454450fb9b2c03ba1bee72ac0677a667dd8faece/src/engine/base.ts#L238)
|
|
144
144
|
|
|
145
145
|
#### Inherited from
|
|
146
146
|
|
|
@@ -152,7 +152,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:238](https://github.com/isd
|
|
|
152
152
|
|
|
153
153
|
> `protected` `optional` **opts**: [`BaseFetcherProperties`](../interfaces/BaseFetcherProperties.md)
|
|
154
154
|
|
|
155
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:227](https://github.com/isdk/web-fetcher.js/blob/
|
|
155
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:227](https://github.com/isdk/web-fetcher.js/blob/454450fb9b2c03ba1bee72ac0677a667dd8faece/src/engine/base.ts#L227)
|
|
156
156
|
|
|
157
157
|
#### Inherited from
|
|
158
158
|
|
|
@@ -164,7 +164,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:227](https://github.com/isd
|
|
|
164
164
|
|
|
165
165
|
> `protected` **pendingRequests**: `Map`\<`string`, [`PendingEngineRequest`](../interfaces/PendingEngineRequest.md)\>
|
|
166
166
|
|
|
167
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:234](https://github.com/isdk/web-fetcher.js/blob/
|
|
167
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:234](https://github.com/isdk/web-fetcher.js/blob/454450fb9b2c03ba1bee72ac0677a667dd8faece/src/engine/base.ts#L234)
|
|
168
168
|
|
|
169
169
|
#### Inherited from
|
|
170
170
|
|
|
@@ -176,7 +176,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:234](https://github.com/isd
|
|
|
176
176
|
|
|
177
177
|
> `protected` **requestCounter**: `number` = `0`
|
|
178
178
|
|
|
179
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:235](https://github.com/isdk/web-fetcher.js/blob/
|
|
179
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:235](https://github.com/isdk/web-fetcher.js/blob/454450fb9b2c03ba1bee72ac0677a667dd8faece/src/engine/base.ts#L235)
|
|
180
180
|
|
|
181
181
|
#### Inherited from
|
|
182
182
|
|
|
@@ -188,7 +188,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:235](https://github.com/isd
|
|
|
188
188
|
|
|
189
189
|
> `protected` `optional` **requestQueue**: `RequestQueue`
|
|
190
190
|
|
|
191
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:230](https://github.com/isdk/web-fetcher.js/blob/
|
|
191
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:230](https://github.com/isdk/web-fetcher.js/blob/454450fb9b2c03ba1bee72ac0677a667dd8faece/src/engine/base.ts#L230)
|
|
192
192
|
|
|
193
193
|
#### Inherited from
|
|
194
194
|
|
|
@@ -200,7 +200,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:230](https://github.com/isd
|
|
|
200
200
|
|
|
201
201
|
> `readonly` `static` **id**: `"playwright"` = `'playwright'`
|
|
202
202
|
|
|
203
|
-
Defined in: [packages/web-fetcher/src/engine/playwright.ts:21](https://github.com/isdk/web-fetcher.js/blob/
|
|
203
|
+
Defined in: [packages/web-fetcher/src/engine/playwright.ts:21](https://github.com/isdk/web-fetcher.js/blob/454450fb9b2c03ba1bee72ac0677a667dd8faece/src/engine/playwright.ts#L21)
|
|
204
204
|
|
|
205
205
|
Unique identifier for the engine implementation.
|
|
206
206
|
|
|
@@ -218,7 +218,7 @@ Must be defined by concrete implementations. Used for registration and lookup in
|
|
|
218
218
|
|
|
219
219
|
> `readonly` `static` **mode**: `"browser"` = `'browser'`
|
|
220
220
|
|
|
221
|
-
Defined in: [packages/web-fetcher/src/engine/playwright.ts:22](https://github.com/isdk/web-fetcher.js/blob/
|
|
221
|
+
Defined in: [packages/web-fetcher/src/engine/playwright.ts:22](https://github.com/isdk/web-fetcher.js/blob/454450fb9b2c03ba1bee72ac0677a667dd8faece/src/engine/playwright.ts#L22)
|
|
222
222
|
|
|
223
223
|
Execution mode of the engine (`'http'` or `'browser'`).
|
|
224
224
|
|
|
@@ -238,7 +238,7 @@ Must be defined by concrete implementations. Indicates whether engine operates a
|
|
|
238
238
|
|
|
239
239
|
> **get** **context**(): `undefined` \| [`FetchEngineContext`](../interfaces/FetchEngineContext.md)
|
|
240
240
|
|
|
241
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
241
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:491](https://github.com/isdk/web-fetcher.js/blob/454450fb9b2c03ba1bee72ac0677a667dd8faece/src/engine/base.ts#L491)
|
|
242
242
|
|
|
243
243
|
Gets the fetch engine context associated with this instance.
|
|
244
244
|
|
|
@@ -258,7 +258,7 @@ Gets the fetch engine context associated with this instance.
|
|
|
258
258
|
|
|
259
259
|
> **get** **id**(): `string`
|
|
260
260
|
|
|
261
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:467](https://github.com/isdk/web-fetcher.js/blob/
|
|
261
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:467](https://github.com/isdk/web-fetcher.js/blob/454450fb9b2c03ba1bee72ac0677a667dd8faece/src/engine/base.ts#L467)
|
|
262
262
|
|
|
263
263
|
Gets the unique identifier of this engine implementation.
|
|
264
264
|
|
|
@@ -278,7 +278,7 @@ Gets the unique identifier of this engine implementation.
|
|
|
278
278
|
|
|
279
279
|
> **get** **mode**(): [`FetchEngineType`](../type-aliases/FetchEngineType.md)
|
|
280
280
|
|
|
281
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
281
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:484](https://github.com/isdk/web-fetcher.js/blob/454450fb9b2c03ba1bee72ac0677a667dd8faece/src/engine/base.ts#L484)
|
|
282
282
|
|
|
283
283
|
Gets the execution mode of this engine (`'http'` or `'browser'`).
|
|
284
284
|
|
|
@@ -296,7 +296,7 @@ Gets the execution mode of this engine (`'http'` or `'browser'`).
|
|
|
296
296
|
|
|
297
297
|
> `protected` **\_buildResponse**(`context`): `Promise`\<[`FetchResponse`](../interfaces/FetchResponse.md)\>
|
|
298
298
|
|
|
299
|
-
Defined in: [packages/web-fetcher/src/engine/playwright.ts:24](https://github.com/isdk/web-fetcher.js/blob/
|
|
299
|
+
Defined in: [packages/web-fetcher/src/engine/playwright.ts:24](https://github.com/isdk/web-fetcher.js/blob/454450fb9b2c03ba1bee72ac0677a667dd8faece/src/engine/playwright.ts#L24)
|
|
300
300
|
|
|
301
301
|
**`Internal`**
|
|
302
302
|
|
|
@@ -330,7 +330,7 @@ Converts implementation-specific context (Playwright `page` or Cheerio `$`) to s
|
|
|
330
330
|
|
|
331
331
|
> `protected` `optional` **\_cleanup**(): `Promise`\<`void`\>
|
|
332
332
|
|
|
333
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:242](https://github.com/isdk/web-fetcher.js/blob/
|
|
333
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:242](https://github.com/isdk/web-fetcher.js/blob/454450fb9b2c03ba1bee72ac0677a667dd8faece/src/engine/base.ts#L242)
|
|
334
334
|
|
|
335
335
|
#### Returns
|
|
336
336
|
|
|
@@ -346,7 +346,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:242](https://github.com/isd
|
|
|
346
346
|
|
|
347
347
|
> `protected` **\_commonCleanup**(): `Promise`\<`void`\>
|
|
348
348
|
|
|
349
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
349
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:675](https://github.com/isdk/web-fetcher.js/blob/454450fb9b2c03ba1bee72ac0677a667dd8faece/src/engine/base.ts#L675)
|
|
350
350
|
|
|
351
351
|
#### Returns
|
|
352
352
|
|
|
@@ -362,7 +362,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:665](https://github.com/isd
|
|
|
362
362
|
|
|
363
363
|
> `protected` **\_createCrawler**(`options`): `PlaywrightCrawler`
|
|
364
364
|
|
|
365
|
-
Defined in: [packages/web-fetcher/src/engine/playwright.ts:
|
|
365
|
+
Defined in: [packages/web-fetcher/src/engine/playwright.ts:214](https://github.com/isdk/web-fetcher.js/blob/454450fb9b2c03ba1bee72ac0677a667dd8faece/src/engine/playwright.ts#L214)
|
|
366
366
|
|
|
367
367
|
**`Internal`**
|
|
368
368
|
|
|
@@ -390,7 +390,7 @@ The final crawler options.
|
|
|
390
390
|
|
|
391
391
|
> `protected` **\_executePendingActions**(`context`): `Promise`\<`void`\>
|
|
392
392
|
|
|
393
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
393
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:591](https://github.com/isdk/web-fetcher.js/blob/454450fb9b2c03ba1bee72ac0677a667dd8faece/src/engine/base.ts#L591)
|
|
394
394
|
|
|
395
395
|
**`Internal`**
|
|
396
396
|
|
|
@@ -443,7 +443,7 @@ If called outside valid page context window (`!this.isPageActive`)
|
|
|
443
443
|
|
|
444
444
|
> `protected` **\_extract**(`schema`, `context`): `Promise`\<`any`\>
|
|
445
445
|
|
|
446
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:247](https://github.com/isdk/web-fetcher.js/blob/
|
|
446
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:247](https://github.com/isdk/web-fetcher.js/blob/454450fb9b2c03ba1bee72ac0677a667dd8faece/src/engine/base.ts#L247)
|
|
447
447
|
|
|
448
448
|
#### Parameters
|
|
449
449
|
|
|
@@ -469,7 +469,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:247](https://github.com/isd
|
|
|
469
469
|
|
|
470
470
|
> `protected` **\_extractValue**(`schema`, `context`): `Promise`\<`any`\>
|
|
471
471
|
|
|
472
|
-
Defined in: [packages/web-fetcher/src/engine/playwright.ts:
|
|
472
|
+
Defined in: [packages/web-fetcher/src/engine/playwright.ts:59](https://github.com/isdk/web-fetcher.js/blob/454450fb9b2c03ba1bee72ac0677a667dd8faece/src/engine/playwright.ts#L59)
|
|
473
473
|
|
|
474
474
|
#### Parameters
|
|
475
475
|
|
|
@@ -495,7 +495,7 @@ Defined in: [packages/web-fetcher/src/engine/playwright.ts:57](https://github.co
|
|
|
495
495
|
|
|
496
496
|
> `protected` **\_getSpecificCrawlerOptions**(`ctx`): `Promise`\<`Partial`\<`PlaywrightCrawlerOptions`\>\>
|
|
497
497
|
|
|
498
|
-
Defined in: [packages/web-fetcher/src/engine/playwright.ts:
|
|
498
|
+
Defined in: [packages/web-fetcher/src/engine/playwright.ts:218](https://github.com/isdk/web-fetcher.js/blob/454450fb9b2c03ba1bee72ac0677a667dd8faece/src/engine/playwright.ts#L218)
|
|
499
499
|
|
|
500
500
|
**`Internal`**
|
|
501
501
|
|
|
@@ -523,7 +523,7 @@ The fetch engine context.
|
|
|
523
523
|
|
|
524
524
|
> `protected` **\_normalizeSchema**(`schema`): `ExtractSchema`
|
|
525
525
|
|
|
526
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:423](https://github.com/isdk/web-fetcher.js/blob/
|
|
526
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:423](https://github.com/isdk/web-fetcher.js/blob/454450fb9b2c03ba1bee72ac0677a667dd8faece/src/engine/base.ts#L423)
|
|
527
527
|
|
|
528
528
|
#### Parameters
|
|
529
529
|
|
|
@@ -545,7 +545,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:423](https://github.com/isd
|
|
|
545
545
|
|
|
546
546
|
> `protected` **\_querySelectorAll**(`context`, `selector`): `Promise`\<`any`[]\>
|
|
547
547
|
|
|
548
|
-
Defined in: [packages/web-fetcher/src/engine/playwright.ts:
|
|
548
|
+
Defined in: [packages/web-fetcher/src/engine/playwright.ts:55](https://github.com/isdk/web-fetcher.js/blob/454450fb9b2c03ba1bee72ac0677a667dd8faece/src/engine/playwright.ts#L55)
|
|
549
549
|
|
|
550
550
|
#### Parameters
|
|
551
551
|
|
|
@@ -571,7 +571,7 @@ Defined in: [packages/web-fetcher/src/engine/playwright.ts:53](https://github.co
|
|
|
571
571
|
|
|
572
572
|
> `protected` **\_sharedFailedRequestHandler**(`context`, `error?`): `Promise`\<`void`\>
|
|
573
573
|
|
|
574
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
574
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:642](https://github.com/isdk/web-fetcher.js/blob/454450fb9b2c03ba1bee72ac0677a667dd8faece/src/engine/base.ts#L642)
|
|
575
575
|
|
|
576
576
|
#### Parameters
|
|
577
577
|
|
|
@@ -597,7 +597,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:632](https://github.com/isd
|
|
|
597
597
|
|
|
598
598
|
> `protected` **\_sharedRequestHandler**(`context`): `Promise`\<`void`\>
|
|
599
599
|
|
|
600
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
600
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:614](https://github.com/isdk/web-fetcher.js/blob/454450fb9b2c03ba1bee72ac0677a667dd8faece/src/engine/base.ts#L614)
|
|
601
601
|
|
|
602
602
|
#### Parameters
|
|
603
603
|
|
|
@@ -619,7 +619,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:604](https://github.com/isd
|
|
|
619
619
|
|
|
620
620
|
> **blockResources**(`types`, `overwrite?`): `Promise`\<`number`\>
|
|
621
621
|
|
|
622
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
622
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:719](https://github.com/isdk/web-fetcher.js/blob/454450fb9b2c03ba1bee72ac0677a667dd8faece/src/engine/base.ts#L719)
|
|
623
623
|
|
|
624
624
|
Blocks specified resource types from loading.
|
|
625
625
|
|
|
@@ -660,7 +660,7 @@ await engine.blockResources(['script'], true); // Replace existing
|
|
|
660
660
|
|
|
661
661
|
> `protected` **buildResponse**(`context`): `Promise`\<[`FetchResponse`](../interfaces/FetchResponse.md)\>
|
|
662
662
|
|
|
663
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:316](https://github.com/isdk/web-fetcher.js/blob/
|
|
663
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:316](https://github.com/isdk/web-fetcher.js/blob/454450fb9b2c03ba1bee72ac0677a667dd8faece/src/engine/base.ts#L316)
|
|
664
664
|
|
|
665
665
|
#### Parameters
|
|
666
666
|
|
|
@@ -682,7 +682,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:316](https://github.com/isd
|
|
|
682
682
|
|
|
683
683
|
> **cleanup**(): `Promise`\<`void`\>
|
|
684
684
|
|
|
685
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
685
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:555](https://github.com/isdk/web-fetcher.js/blob/454450fb9b2c03ba1bee72ac0677a667dd8faece/src/engine/base.ts#L555)
|
|
686
686
|
|
|
687
687
|
#### Returns
|
|
688
688
|
|
|
@@ -698,7 +698,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:545](https://github.com/isd
|
|
|
698
698
|
|
|
699
699
|
> **click**(`selector`): `Promise`\<`void`\>
|
|
700
700
|
|
|
701
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:373](https://github.com/isdk/web-fetcher.js/blob/
|
|
701
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:373](https://github.com/isdk/web-fetcher.js/blob/454450fb9b2c03ba1bee72ac0677a667dd8faece/src/engine/base.ts#L373)
|
|
702
702
|
|
|
703
703
|
Clicks on element matching selector.
|
|
704
704
|
|
|
@@ -732,7 +732,7 @@ When no active page context exists
|
|
|
732
732
|
|
|
733
733
|
> **cookies**(): `Promise`\<[`Cookie`](../interfaces/Cookie.md)[]\>
|
|
734
734
|
|
|
735
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
735
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:830](https://github.com/isdk/web-fetcher.js/blob/454450fb9b2c03ba1bee72ac0677a667dd8faece/src/engine/base.ts#L830)
|
|
736
736
|
|
|
737
737
|
Manages cookies for current session with multiple overloads.
|
|
738
738
|
|
|
@@ -761,7 +761,7 @@ await engine.cookies([{ name: 'session', value: '123' }]);
|
|
|
761
761
|
|
|
762
762
|
> **cookies**(`cookies`): `Promise`\<`boolean`\>
|
|
763
763
|
|
|
764
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
764
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:831](https://github.com/isdk/web-fetcher.js/blob/454450fb9b2c03ba1bee72ac0677a667dd8faece/src/engine/base.ts#L831)
|
|
765
765
|
|
|
766
766
|
Manages cookies for current session with multiple overloads.
|
|
767
767
|
|
|
@@ -800,7 +800,7 @@ await engine.cookies([{ name: 'session', value: '123' }]);
|
|
|
800
800
|
|
|
801
801
|
> `protected` **dispatchAction**\<`T`\>(`action`): `Promise`\<`T`\>
|
|
802
802
|
|
|
803
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
803
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:658](https://github.com/isdk/web-fetcher.js/blob/454450fb9b2c03ba1bee72ac0677a667dd8faece/src/engine/base.ts#L658)
|
|
804
804
|
|
|
805
805
|
#### Type Parameters
|
|
806
806
|
|
|
@@ -828,7 +828,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:648](https://github.com/isd
|
|
|
828
828
|
|
|
829
829
|
> **dispose**(): `Promise`\<`void`\>
|
|
830
830
|
|
|
831
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
831
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:848](https://github.com/isdk/web-fetcher.js/blob/454450fb9b2c03ba1bee72ac0677a667dd8faece/src/engine/base.ts#L848)
|
|
832
832
|
|
|
833
833
|
Disposes of engine, cleaning up all resources.
|
|
834
834
|
|
|
@@ -848,7 +848,7 @@ Promise resolving when disposal completes
|
|
|
848
848
|
|
|
849
849
|
> `protected` **executeAction**(`context`, `action`): `Promise`\<`any`\>
|
|
850
850
|
|
|
851
|
-
Defined in: [packages/web-fetcher/src/engine/playwright.ts:
|
|
851
|
+
Defined in: [packages/web-fetcher/src/engine/playwright.ts:87](https://github.com/isdk/web-fetcher.js/blob/454450fb9b2c03ba1bee72ac0677a667dd8faece/src/engine/playwright.ts#L87)
|
|
852
852
|
|
|
853
853
|
**`Internal`**
|
|
854
854
|
|
|
@@ -888,7 +888,7 @@ Handles specific user interactions using underlying technology (Playwright/Cheer
|
|
|
888
888
|
|
|
889
889
|
> **extract**\<`T`\>(`schema`): `Promise`\<`T`\>
|
|
890
890
|
|
|
891
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:418](https://github.com/isdk/web-fetcher.js/blob/
|
|
891
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:418](https://github.com/isdk/web-fetcher.js/blob/454450fb9b2c03ba1bee72ac0677a667dd8faece/src/engine/base.ts#L418)
|
|
892
892
|
|
|
893
893
|
Extracts structured data from the current page content.
|
|
894
894
|
|
|
@@ -922,7 +922,7 @@ A promise that resolves to an object with the extracted data.
|
|
|
922
922
|
|
|
923
923
|
> **fill**(`selector`, `value`): `Promise`\<`void`\>
|
|
924
924
|
|
|
925
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:385](https://github.com/isdk/web-fetcher.js/blob/
|
|
925
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:385](https://github.com/isdk/web-fetcher.js/blob/454450fb9b2c03ba1bee72ac0677a667dd8faece/src/engine/base.ts#L385)
|
|
926
926
|
|
|
927
927
|
Fills input element with specified value.
|
|
928
928
|
|
|
@@ -960,7 +960,7 @@ When no active page context exists
|
|
|
960
960
|
|
|
961
961
|
> **getContent**(): `Promise`\<[`FetchResponse`](../interfaces/FetchResponse.md)\>
|
|
962
962
|
|
|
963
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
963
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:733](https://github.com/isdk/web-fetcher.js/blob/454450fb9b2c03ba1bee72ac0677a667dd8faece/src/engine/base.ts#L733)
|
|
964
964
|
|
|
965
965
|
Gets content of current page.
|
|
966
966
|
|
|
@@ -980,11 +980,30 @@ When no content has been fetched yet
|
|
|
980
980
|
|
|
981
981
|
***
|
|
982
982
|
|
|
983
|
+
### getState()
|
|
984
|
+
|
|
985
|
+
> **getState**(): `Promise`\<\{ `cookies`: [`Cookie`](../interfaces/Cookie.md)[]; \}\>
|
|
986
|
+
|
|
987
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:475](https://github.com/isdk/web-fetcher.js/blob/454450fb9b2c03ba1bee72ac0677a667dd8faece/src/engine/base.ts#L475)
|
|
988
|
+
|
|
989
|
+
Returns the current state of the engine (cookies)
|
|
990
|
+
that can be used to restore the session later.
|
|
991
|
+
|
|
992
|
+
#### Returns
|
|
993
|
+
|
|
994
|
+
`Promise`\<\{ `cookies`: [`Cookie`](../interfaces/Cookie.md)[]; \}\>
|
|
995
|
+
|
|
996
|
+
#### Inherited from
|
|
997
|
+
|
|
998
|
+
[`FetchEngine`](FetchEngine.md).[`getState`](FetchEngine.md#getstate)
|
|
999
|
+
|
|
1000
|
+
***
|
|
1001
|
+
|
|
983
1002
|
### goto()
|
|
984
1003
|
|
|
985
1004
|
> **goto**(`url`, `opts?`): `Promise`\<[`FetchResponse`](../interfaces/FetchResponse.md)\>
|
|
986
1005
|
|
|
987
|
-
Defined in: [packages/web-fetcher/src/engine/playwright.ts:
|
|
1006
|
+
Defined in: [packages/web-fetcher/src/engine/playwright.ts:288](https://github.com/isdk/web-fetcher.js/blob/454450fb9b2c03ba1bee72ac0677a667dd8faece/src/engine/playwright.ts#L288)
|
|
988
1007
|
|
|
989
1008
|
Navigates to the specified URL.
|
|
990
1009
|
|
|
@@ -1024,7 +1043,7 @@ await engine.goto('https://example.com');
|
|
|
1024
1043
|
|
|
1025
1044
|
> **headers**(): `Promise`\<`Record`\<`string`, `string`\>\>
|
|
1026
1045
|
|
|
1027
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1046
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:772](https://github.com/isdk/web-fetcher.js/blob/454450fb9b2c03ba1bee72ac0677a667dd8faece/src/engine/base.ts#L772)
|
|
1028
1047
|
|
|
1029
1048
|
Manages HTTP headers for requests with multiple overloads.
|
|
1030
1049
|
|
|
@@ -1055,7 +1074,7 @@ await engine.headers('auth', 'token');
|
|
|
1055
1074
|
|
|
1056
1075
|
> **headers**(`name`): `Promise`\<`string`\>
|
|
1057
1076
|
|
|
1058
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1077
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:773](https://github.com/isdk/web-fetcher.js/blob/454450fb9b2c03ba1bee72ac0677a667dd8faece/src/engine/base.ts#L773)
|
|
1059
1078
|
|
|
1060
1079
|
Manages HTTP headers for requests with multiple overloads.
|
|
1061
1080
|
|
|
@@ -1094,7 +1113,7 @@ await engine.headers('auth', 'token');
|
|
|
1094
1113
|
|
|
1095
1114
|
> **headers**(`headers`, `replaced?`): `Promise`\<`boolean`\>
|
|
1096
1115
|
|
|
1097
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1116
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:774](https://github.com/isdk/web-fetcher.js/blob/454450fb9b2c03ba1bee72ac0677a667dd8faece/src/engine/base.ts#L774)
|
|
1098
1117
|
|
|
1099
1118
|
Manages HTTP headers for requests with multiple overloads.
|
|
1100
1119
|
|
|
@@ -1139,7 +1158,7 @@ await engine.headers('auth', 'token');
|
|
|
1139
1158
|
|
|
1140
1159
|
> **headers**(`name`, `value`): `Promise`\<`boolean`\>
|
|
1141
1160
|
|
|
1142
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1161
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:775](https://github.com/isdk/web-fetcher.js/blob/454450fb9b2c03ba1bee72ac0677a667dd8faece/src/engine/base.ts#L775)
|
|
1143
1162
|
|
|
1144
1163
|
Manages HTTP headers for requests with multiple overloads.
|
|
1145
1164
|
|
|
@@ -1186,7 +1205,7 @@ await engine.headers('auth', 'token');
|
|
|
1186
1205
|
|
|
1187
1206
|
> **initialize**(`context`, `options?`): `Promise`\<`void`\>
|
|
1188
1207
|
|
|
1189
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
1208
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:506](https://github.com/isdk/web-fetcher.js/blob/454450fb9b2c03ba1bee72ac0677a667dd8faece/src/engine/base.ts#L506)
|
|
1190
1209
|
|
|
1191
1210
|
Initializes the fetch engine with provided context and options.
|
|
1192
1211
|
|
|
@@ -1225,7 +1244,7 @@ Automatically called when creating engine via `FetchEngine.create()`.
|
|
|
1225
1244
|
|
|
1226
1245
|
> **pause**(`message?`): `Promise`\<`void`\>
|
|
1227
1246
|
|
|
1228
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:408](https://github.com/isdk/web-fetcher.js/blob/
|
|
1247
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:408](https://github.com/isdk/web-fetcher.js/blob/454450fb9b2c03ba1bee72ac0677a667dd8faece/src/engine/base.ts#L408)
|
|
1229
1248
|
|
|
1230
1249
|
Pauses execution, allowing for manual intervention or inspection.
|
|
1231
1250
|
|
|
@@ -1257,7 +1276,7 @@ When no active page context exists
|
|
|
1257
1276
|
|
|
1258
1277
|
> **submit**(`selector?`, `options?`): `Promise`\<`void`\>
|
|
1259
1278
|
|
|
1260
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:397](https://github.com/isdk/web-fetcher.js/blob/
|
|
1279
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:397](https://github.com/isdk/web-fetcher.js/blob/454450fb9b2c03ba1bee72ac0677a667dd8faece/src/engine/base.ts#L397)
|
|
1261
1280
|
|
|
1262
1281
|
Submits a form.
|
|
1263
1282
|
|
|
@@ -1295,7 +1314,7 @@ When no active page context exists
|
|
|
1295
1314
|
|
|
1296
1315
|
> **waitFor**(`params?`): `Promise`\<`void`\>
|
|
1297
1316
|
|
|
1298
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:362](https://github.com/isdk/web-fetcher.js/blob/
|
|
1317
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:362](https://github.com/isdk/web-fetcher.js/blob/454450fb9b2c03ba1bee72ac0677a667dd8faece/src/engine/base.ts#L362)
|
|
1299
1318
|
|
|
1300
1319
|
Waits for specified condition before continuing.
|
|
1301
1320
|
|
|
@@ -1330,7 +1349,7 @@ await engine.waitFor({ selector: '#content' }); // Wait for element
|
|
|
1330
1349
|
|
|
1331
1350
|
> `static` **create**(`ctx`, `options?`): `Promise`\<`undefined` \| `AnyFetchEngine`\>
|
|
1332
1351
|
|
|
1333
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:199](https://github.com/isdk/web-fetcher.js/blob/
|
|
1352
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:199](https://github.com/isdk/web-fetcher.js/blob/454450fb9b2c03ba1bee72ac0677a667dd8faece/src/engine/base.ts#L199)
|
|
1334
1353
|
|
|
1335
1354
|
Factory method to create and initialize a fetch engine instance.
|
|
1336
1355
|
|
|
@@ -1372,7 +1391,7 @@ Primary entry point for engine creation. Selects appropriate implementation base
|
|
|
1372
1391
|
|
|
1373
1392
|
> `static` **get**(`id`): `undefined` \| `AnyFetchEngineCtor`
|
|
1374
1393
|
|
|
1375
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:172](https://github.com/isdk/web-fetcher.js/blob/
|
|
1394
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:172](https://github.com/isdk/web-fetcher.js/blob/454450fb9b2c03ba1bee72ac0677a667dd8faece/src/engine/base.ts#L172)
|
|
1376
1395
|
|
|
1377
1396
|
Retrieves a fetch engine implementation by its unique ID.
|
|
1378
1397
|
|
|
@@ -1400,7 +1419,7 @@ Engine class if found, otherwise `undefined`
|
|
|
1400
1419
|
|
|
1401
1420
|
> `static` **getByMode**(`mode`): `undefined` \| `AnyFetchEngineCtor`
|
|
1402
1421
|
|
|
1403
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:182](https://github.com/isdk/web-fetcher.js/blob/
|
|
1422
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:182](https://github.com/isdk/web-fetcher.js/blob/454450fb9b2c03ba1bee72ac0677a667dd8faece/src/engine/base.ts#L182)
|
|
1404
1423
|
|
|
1405
1424
|
Retrieves a fetch engine implementation by execution mode.
|
|
1406
1425
|
|
|
@@ -1428,7 +1447,7 @@ Engine class if found, otherwise `undefined`
|
|
|
1428
1447
|
|
|
1429
1448
|
> `static` **register**(`engineClass`): `void`
|
|
1430
1449
|
|
|
1431
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:159](https://github.com/isdk/web-fetcher.js/blob/
|
|
1450
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:159](https://github.com/isdk/web-fetcher.js/blob/454450fb9b2c03ba1bee72ac0677a667dd8faece/src/engine/base.ts#L159)
|
|
1432
1451
|
|
|
1433
1452
|
Registers a fetch engine implementation with the global registry.
|
|
1434
1453
|
|