@isdk/web-fetcher 0.2.6 → 0.2.8

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.
Files changed (61) hide show
  1. package/README.cn.md +4 -1
  2. package/README.engine.cn.md +31 -1
  3. package/README.engine.md +31 -1
  4. package/README.md +4 -1
  5. package/dist/index.d.mts +12 -3
  6. package/dist/index.d.ts +12 -3
  7. package/dist/index.js +1 -1
  8. package/dist/index.mjs +1 -1
  9. package/docs/README.md +4 -1
  10. package/docs/_media/README.cn.md +4 -1
  11. package/docs/_media/README.engine.md +31 -1
  12. package/docs/classes/CheerioFetchEngine.md +95 -71
  13. package/docs/classes/ClickAction.md +23 -23
  14. package/docs/classes/ExtractAction.md +23 -23
  15. package/docs/classes/FetchAction.md +23 -23
  16. package/docs/classes/FetchEngine.md +83 -67
  17. package/docs/classes/FetchSession.md +24 -12
  18. package/docs/classes/FillAction.md +23 -23
  19. package/docs/classes/GetContentAction.md +23 -23
  20. package/docs/classes/GotoAction.md +23 -23
  21. package/docs/classes/PauseAction.md +23 -23
  22. package/docs/classes/PlaywrightFetchEngine.md +95 -71
  23. package/docs/classes/SubmitAction.md +23 -23
  24. package/docs/classes/WaitForAction.md +23 -23
  25. package/docs/classes/WebFetcher.md +5 -5
  26. package/docs/enumerations/FetchActionResultStatus.md +4 -4
  27. package/docs/functions/fetchWeb.md +2 -2
  28. package/docs/interfaces/BaseFetchActionProperties.md +11 -11
  29. package/docs/interfaces/BaseFetchCollectorActionProperties.md +15 -15
  30. package/docs/interfaces/BaseFetcherProperties.md +46 -22
  31. package/docs/interfaces/DispatchedEngineAction.md +4 -4
  32. package/docs/interfaces/ExtractActionProperties.md +11 -11
  33. package/docs/interfaces/FetchActionInContext.md +15 -15
  34. package/docs/interfaces/FetchActionProperties.md +12 -12
  35. package/docs/interfaces/FetchActionResult.md +6 -6
  36. package/docs/interfaces/FetchContext.md +68 -32
  37. package/docs/interfaces/FetchEngineContext.md +63 -27
  38. package/docs/interfaces/FetchMetadata.md +5 -5
  39. package/docs/interfaces/FetchResponse.md +13 -13
  40. package/docs/interfaces/FetchReturnTypeRegistry.md +7 -7
  41. package/docs/interfaces/FetchSite.md +61 -25
  42. package/docs/interfaces/FetcherOptions.md +60 -24
  43. package/docs/interfaces/GotoActionOptions.md +6 -6
  44. package/docs/interfaces/PendingEngineRequest.md +3 -3
  45. package/docs/interfaces/SubmitActionOptions.md +2 -2
  46. package/docs/interfaces/WaitForActionOptions.md +5 -5
  47. package/docs/type-aliases/BaseFetchActionOptions.md +1 -1
  48. package/docs/type-aliases/BaseFetchCollectorOptions.md +1 -1
  49. package/docs/type-aliases/BrowserEngine.md +1 -1
  50. package/docs/type-aliases/FetchActionCapabilities.md +1 -1
  51. package/docs/type-aliases/FetchActionCapabilityMode.md +1 -1
  52. package/docs/type-aliases/FetchActionOptions.md +1 -1
  53. package/docs/type-aliases/FetchEngineAction.md +1 -1
  54. package/docs/type-aliases/FetchEngineType.md +1 -1
  55. package/docs/type-aliases/FetchReturnType.md +1 -1
  56. package/docs/type-aliases/FetchReturnTypeFor.md +1 -1
  57. package/docs/type-aliases/OnFetchPauseCallback.md +1 -1
  58. package/docs/type-aliases/ResourceType.md +1 -1
  59. package/docs/variables/DefaultFetcherProperties.md +1 -1
  60. package/docs/variables/FetcherOptionKeys.md +1 -1
  61. package/package.json +3 -2
@@ -24,13 +24,43 @@ This is the abstract base class that defines the contract for all fetch engines.
24
24
  * **Key Abstractions**:
25
25
  * **Lifecycle**: `initialize()` and `cleanup()` methods.
26
26
  * **Core Actions**: `goto()`, `getContent()`, `click()`, `fill()`, `submit()`, `waitFor()`, `extract()`.
27
- * **Configuration & State**: `headers()`, `cookies()`, `blockResources()`, `getState()`.
27
+ * **Configuration & State**: `headers()`, `cookies()`, `blockResources()`, `getState()`, `sessionPoolOptions`.
28
28
  * **Static Registry**: It maintains a static registry of all available engine implementations (`FetchEngine.register`), allowing for dynamic selection by `id` or `mode`.
29
29
 
30
30
  ### `FetchEngine.create(context, options)`
31
31
 
32
32
  This static factory method is the designated entry point for creating an engine instance. It automatically selects and initializes the appropriate engine.
33
33
 
34
+ ### `FetchSession(options, engine)`
35
+
36
+ The `FetchSession` class manages the lifecycle of a fetch operation. It now supports an optional `engine` parameter in its constructor to force a specific engine implementation for that session, bypassing any auto-detection or registry-based selection.
37
+
38
+ ### Engine Selection Priority
39
+
40
+ When the library determines which engine to use (via internal `maybeCreateEngine`), it follows this priority:
41
+
42
+ 1. **Explicit Forced Engine**: If an engine ID is explicitly passed during session or engine creation (e.g., the new `engine` parameter in `FetchSession`).
43
+ 2. **Configuration Engine**: The `engine` property defined in `FetcherOptions`.
44
+ 3. **Site Registry**: If the target URL matches a domain in the configured `sites` registry, it uses the engine preferred for that site.
45
+ 4. **Default**: Defaults to `auto`, which intelligently switches between `http` and `browser` if `enableSmart` is enabled, or defaults to `http` otherwise.
46
+
47
+ ### Session Management & State Persistence
48
+
49
+ The engine supports persisting and restoring session state (primarily cookies) between executions.
50
+
51
+ * **`sessionState`**: A comprehensive state object (derived from Crawlee's SessionPool) that can be used to fully restore a previous session. This is set during engine initialization.
52
+ * **`sessionPoolOptions`**: Allows advanced configuration of the underlying Crawlee `SessionPool` (e.g., `maxUsageCount`, `maxPoolSize`).
53
+ > **Note**: `persistenceOptions.enable` is forced to `true` to ensure proper session state management.
54
+ * **`overrideSessionState`**: If set to `true`, it forces the engine to overwrite any existing persistent state in the storage with the provided `sessionState`. This is useful when you want to ensure the session starts with the exact state provided, ignoring any stale data in the persistence layer.
55
+ * **`cookies`**: An array of explicit cookies to use for the session.
56
+
57
+ **Precedence Rule:**
58
+ If both `sessionState` and `cookies` are provided, the engine adopts a **"Merge and Override"** strategy:
59
+ 1. The session is first restored from the `sessionState`.
60
+ 2. The explicit `cookies` are then applied on top.
61
+ * **Result:** Any conflicting cookies in `sessionState` will be **overwritten** by the explicit `cookies`.
62
+ * A warning will be logged if both are present to alert the user of this override behavior.
63
+
34
64
  ---
35
65
 
36
66
  ## 🏗️ 3. Architecture and Workflow
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Class: CheerioFetchEngine
8
8
 
9
- Defined in: [packages/web-fetcher/src/engine/cheerio.ts:20](https://github.com/isdk/web-fetcher.js/blob/d7b505cc39fc821039fb79f641e2e590d2fc028d/src/engine/cheerio.ts#L20)
9
+ Defined in: [packages/web-fetcher/src/engine/cheerio.ts:20](https://github.com/isdk/web-fetcher.js/blob/7bb51cb9bc54b4138642b08ddf371740d89af7ca/src/engine/cheerio.ts#L20)
10
10
 
11
11
  ## Extends
12
12
 
@@ -28,11 +28,35 @@ Defined in: [packages/web-fetcher/src/engine/cheerio.ts:20](https://github.com/i
28
28
 
29
29
  ## Properties
30
30
 
31
+ ### \_initialCookies?
32
+
33
+ > `protected` `optional` **\_initialCookies**: [`Cookie`](../interfaces/Cookie.md)[]
34
+
35
+ Defined in: [packages/web-fetcher/src/engine/base.ts:236](https://github.com/isdk/web-fetcher.js/blob/7bb51cb9bc54b4138642b08ddf371740d89af7ca/src/engine/base.ts#L236)
36
+
37
+ #### Inherited from
38
+
39
+ [`FetchEngine`](FetchEngine.md).[`_initialCookies`](FetchEngine.md#_initialcookies)
40
+
41
+ ***
42
+
43
+ ### \_initializedSessions
44
+
45
+ > `protected` **\_initializedSessions**: `Set`\<`string`\>
46
+
47
+ Defined in: [packages/web-fetcher/src/engine/base.ts:237](https://github.com/isdk/web-fetcher.js/blob/7bb51cb9bc54b4138642b08ddf371740d89af7ca/src/engine/base.ts#L237)
48
+
49
+ #### Inherited from
50
+
51
+ [`FetchEngine`](FetchEngine.md).[`_initializedSessions`](FetchEngine.md#_initializedsessions)
52
+
53
+ ***
54
+
31
55
  ### actionEmitter
32
56
 
33
57
  > `protected` **actionEmitter**: `EventEmitter`
34
58
 
35
- Defined in: [packages/web-fetcher/src/engine/base.ts:236](https://github.com/isdk/web-fetcher.js/blob/d7b505cc39fc821039fb79f641e2e590d2fc028d/src/engine/base.ts#L236)
59
+ Defined in: [packages/web-fetcher/src/engine/base.ts:241](https://github.com/isdk/web-fetcher.js/blob/7bb51cb9bc54b4138642b08ddf371740d89af7ca/src/engine/base.ts#L241)
36
60
 
37
61
  #### Inherited from
38
62
 
@@ -44,7 +68,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:236](https://github.com/isd
44
68
 
45
69
  > `protected` **blockedTypes**: `Set`\<`string`\>
46
70
 
47
- Defined in: [packages/web-fetcher/src/engine/base.ts:240](https://github.com/isdk/web-fetcher.js/blob/d7b505cc39fc821039fb79f641e2e590d2fc028d/src/engine/base.ts#L240)
71
+ Defined in: [packages/web-fetcher/src/engine/base.ts:245](https://github.com/isdk/web-fetcher.js/blob/7bb51cb9bc54b4138642b08ddf371740d89af7ca/src/engine/base.ts#L245)
48
72
 
49
73
  #### Inherited from
50
74
 
@@ -56,7 +80,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:240](https://github.com/isd
56
80
 
57
81
  > `protected` `optional` **crawler**: `CheerioCrawler`
58
82
 
59
- Defined in: [packages/web-fetcher/src/engine/base.ts:228](https://github.com/isdk/web-fetcher.js/blob/d7b505cc39fc821039fb79f641e2e590d2fc028d/src/engine/base.ts#L228)
83
+ Defined in: [packages/web-fetcher/src/engine/base.ts:231](https://github.com/isdk/web-fetcher.js/blob/7bb51cb9bc54b4138642b08ddf371740d89af7ca/src/engine/base.ts#L231)
60
84
 
61
85
  #### Inherited from
62
86
 
@@ -68,7 +92,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:228](https://github.com/isd
68
92
 
69
93
  > `protected` `optional` **ctx**: [`FetchEngineContext`](../interfaces/FetchEngineContext.md)
70
94
 
71
- Defined in: [packages/web-fetcher/src/engine/base.ts:226](https://github.com/isdk/web-fetcher.js/blob/d7b505cc39fc821039fb79f641e2e590d2fc028d/src/engine/base.ts#L226)
95
+ Defined in: [packages/web-fetcher/src/engine/base.ts:229](https://github.com/isdk/web-fetcher.js/blob/7bb51cb9bc54b4138642b08ddf371740d89af7ca/src/engine/base.ts#L229)
72
96
 
73
97
  #### Inherited from
74
98
 
@@ -76,11 +100,23 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:226](https://github.com/isd
76
100
 
77
101
  ***
78
102
 
103
+ ### currentSession?
104
+
105
+ > `protected` `optional` **currentSession**: `Session`
106
+
107
+ Defined in: [packages/web-fetcher/src/engine/base.ts:238](https://github.com/isdk/web-fetcher.js/blob/7bb51cb9bc54b4138642b08ddf371740d89af7ca/src/engine/base.ts#L238)
108
+
109
+ #### Inherited from
110
+
111
+ [`FetchEngine`](FetchEngine.md).[`currentSession`](FetchEngine.md#currentsession)
112
+
113
+ ***
114
+
79
115
  ### hdrs
80
116
 
81
117
  > `protected` **hdrs**: `Record`\<`string`, `string`\> = `{}`
82
118
 
83
- Defined in: [packages/web-fetcher/src/engine/base.ts:232](https://github.com/isdk/web-fetcher.js/blob/d7b505cc39fc821039fb79f641e2e590d2fc028d/src/engine/base.ts#L232)
119
+ Defined in: [packages/web-fetcher/src/engine/base.ts:235](https://github.com/isdk/web-fetcher.js/blob/7bb51cb9bc54b4138642b08ddf371740d89af7ca/src/engine/base.ts#L235)
84
120
 
85
121
  #### Inherited from
86
122
 
@@ -92,7 +128,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:232](https://github.com/isd
92
128
 
93
129
  > `protected` `optional` **isCrawlerReady**: `boolean`
94
130
 
95
- Defined in: [packages/web-fetcher/src/engine/base.ts:229](https://github.com/isdk/web-fetcher.js/blob/d7b505cc39fc821039fb79f641e2e590d2fc028d/src/engine/base.ts#L229)
131
+ Defined in: [packages/web-fetcher/src/engine/base.ts:232](https://github.com/isdk/web-fetcher.js/blob/7bb51cb9bc54b4138642b08ddf371740d89af7ca/src/engine/base.ts#L232)
96
132
 
97
133
  #### Inherited from
98
134
 
@@ -104,7 +140,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:229](https://github.com/isd
104
140
 
105
141
  > `protected` **isPageActive**: `boolean` = `false`
106
142
 
107
- Defined in: [packages/web-fetcher/src/engine/base.ts:237](https://github.com/isdk/web-fetcher.js/blob/d7b505cc39fc821039fb79f641e2e590d2fc028d/src/engine/base.ts#L237)
143
+ Defined in: [packages/web-fetcher/src/engine/base.ts:242](https://github.com/isdk/web-fetcher.js/blob/7bb51cb9bc54b4138642b08ddf371740d89af7ca/src/engine/base.ts#L242)
108
144
 
109
145
  #### Inherited from
110
146
 
@@ -112,23 +148,11 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:237](https://github.com/isd
112
148
 
113
149
  ***
114
150
 
115
- ### jar
116
-
117
- > `protected` **jar**: [`Cookie`](../interfaces/Cookie.md)[] = `[]`
118
-
119
- Defined in: [packages/web-fetcher/src/engine/base.ts:233](https://github.com/isdk/web-fetcher.js/blob/d7b505cc39fc821039fb79f641e2e590d2fc028d/src/engine/base.ts#L233)
120
-
121
- #### Inherited from
122
-
123
- [`FetchEngine`](FetchEngine.md).[`jar`](FetchEngine.md#jar)
124
-
125
- ***
126
-
127
151
  ### lastResponse?
128
152
 
129
153
  > `protected` `optional` **lastResponse**: [`FetchResponse`](../interfaces/FetchResponse.md)
130
154
 
131
- Defined in: [packages/web-fetcher/src/engine/base.ts:239](https://github.com/isdk/web-fetcher.js/blob/d7b505cc39fc821039fb79f641e2e590d2fc028d/src/engine/base.ts#L239)
155
+ Defined in: [packages/web-fetcher/src/engine/base.ts:244](https://github.com/isdk/web-fetcher.js/blob/7bb51cb9bc54b4138642b08ddf371740d89af7ca/src/engine/base.ts#L244)
132
156
 
133
157
  #### Inherited from
134
158
 
@@ -140,7 +164,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:239](https://github.com/isd
140
164
 
141
165
  > `protected` **navigationLock**: `PromiseLock`
142
166
 
143
- Defined in: [packages/web-fetcher/src/engine/base.ts:238](https://github.com/isdk/web-fetcher.js/blob/d7b505cc39fc821039fb79f641e2e590d2fc028d/src/engine/base.ts#L238)
167
+ Defined in: [packages/web-fetcher/src/engine/base.ts:243](https://github.com/isdk/web-fetcher.js/blob/7bb51cb9bc54b4138642b08ddf371740d89af7ca/src/engine/base.ts#L243)
144
168
 
145
169
  #### Inherited from
146
170
 
@@ -152,7 +176,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:238](https://github.com/isd
152
176
 
153
177
  > `protected` `optional` **opts**: [`BaseFetcherProperties`](../interfaces/BaseFetcherProperties.md)
154
178
 
155
- Defined in: [packages/web-fetcher/src/engine/base.ts:227](https://github.com/isdk/web-fetcher.js/blob/d7b505cc39fc821039fb79f641e2e590d2fc028d/src/engine/base.ts#L227)
179
+ Defined in: [packages/web-fetcher/src/engine/base.ts:230](https://github.com/isdk/web-fetcher.js/blob/7bb51cb9bc54b4138642b08ddf371740d89af7ca/src/engine/base.ts#L230)
156
180
 
157
181
  #### Inherited from
158
182
 
@@ -164,7 +188,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:227](https://github.com/isd
164
188
 
165
189
  > `protected` **pendingRequests**: `Map`\<`string`, [`PendingEngineRequest`](../interfaces/PendingEngineRequest.md)\>
166
190
 
167
- Defined in: [packages/web-fetcher/src/engine/base.ts:234](https://github.com/isdk/web-fetcher.js/blob/d7b505cc39fc821039fb79f641e2e590d2fc028d/src/engine/base.ts#L234)
191
+ Defined in: [packages/web-fetcher/src/engine/base.ts:239](https://github.com/isdk/web-fetcher.js/blob/7bb51cb9bc54b4138642b08ddf371740d89af7ca/src/engine/base.ts#L239)
168
192
 
169
193
  #### Inherited from
170
194
 
@@ -176,7 +200,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:234](https://github.com/isd
176
200
 
177
201
  > `protected` **requestCounter**: `number` = `0`
178
202
 
179
- Defined in: [packages/web-fetcher/src/engine/base.ts:235](https://github.com/isdk/web-fetcher.js/blob/d7b505cc39fc821039fb79f641e2e590d2fc028d/src/engine/base.ts#L235)
203
+ Defined in: [packages/web-fetcher/src/engine/base.ts:240](https://github.com/isdk/web-fetcher.js/blob/7bb51cb9bc54b4138642b08ddf371740d89af7ca/src/engine/base.ts#L240)
180
204
 
181
205
  #### Inherited from
182
206
 
@@ -188,7 +212,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:235](https://github.com/isd
188
212
 
189
213
  > `protected` `optional` **requestQueue**: `RequestQueue`
190
214
 
191
- Defined in: [packages/web-fetcher/src/engine/base.ts:230](https://github.com/isdk/web-fetcher.js/blob/d7b505cc39fc821039fb79f641e2e590d2fc028d/src/engine/base.ts#L230)
215
+ Defined in: [packages/web-fetcher/src/engine/base.ts:233](https://github.com/isdk/web-fetcher.js/blob/7bb51cb9bc54b4138642b08ddf371740d89af7ca/src/engine/base.ts#L233)
192
216
 
193
217
  #### Inherited from
194
218
 
@@ -200,7 +224,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:230](https://github.com/isd
200
224
 
201
225
  > `readonly` `static` **id**: `"cheerio"` = `'cheerio'`
202
226
 
203
- Defined in: [packages/web-fetcher/src/engine/cheerio.ts:25](https://github.com/isdk/web-fetcher.js/blob/d7b505cc39fc821039fb79f641e2e590d2fc028d/src/engine/cheerio.ts#L25)
227
+ Defined in: [packages/web-fetcher/src/engine/cheerio.ts:25](https://github.com/isdk/web-fetcher.js/blob/7bb51cb9bc54b4138642b08ddf371740d89af7ca/src/engine/cheerio.ts#L25)
204
228
 
205
229
  Unique identifier for the engine implementation.
206
230
 
@@ -218,7 +242,7 @@ Must be defined by concrete implementations. Used for registration and lookup in
218
242
 
219
243
  > `readonly` `static` **mode**: `"http"` = `'http'`
220
244
 
221
- Defined in: [packages/web-fetcher/src/engine/cheerio.ts:26](https://github.com/isdk/web-fetcher.js/blob/d7b505cc39fc821039fb79f641e2e590d2fc028d/src/engine/cheerio.ts#L26)
245
+ Defined in: [packages/web-fetcher/src/engine/cheerio.ts:26](https://github.com/isdk/web-fetcher.js/blob/7bb51cb9bc54b4138642b08ddf371740d89af7ca/src/engine/cheerio.ts#L26)
222
246
 
223
247
  Execution mode of the engine (`'http'` or `'browser'`).
224
248
 
@@ -238,7 +262,7 @@ Must be defined by concrete implementations. Indicates whether engine operates a
238
262
 
239
263
  > **get** **context**(): `undefined` \| [`FetchEngineContext`](../interfaces/FetchEngineContext.md)
240
264
 
241
- Defined in: [packages/web-fetcher/src/engine/base.ts:491](https://github.com/isdk/web-fetcher.js/blob/d7b505cc39fc821039fb79f641e2e590d2fc028d/src/engine/base.ts#L491)
265
+ Defined in: [packages/web-fetcher/src/engine/base.ts:497](https://github.com/isdk/web-fetcher.js/blob/7bb51cb9bc54b4138642b08ddf371740d89af7ca/src/engine/base.ts#L497)
242
266
 
243
267
  Gets the fetch engine context associated with this instance.
244
268
 
@@ -258,7 +282,7 @@ Gets the fetch engine context associated with this instance.
258
282
 
259
283
  > **get** **id**(): `string`
260
284
 
261
- Defined in: [packages/web-fetcher/src/engine/base.ts:467](https://github.com/isdk/web-fetcher.js/blob/d7b505cc39fc821039fb79f641e2e590d2fc028d/src/engine/base.ts#L467)
285
+ Defined in: [packages/web-fetcher/src/engine/base.ts:472](https://github.com/isdk/web-fetcher.js/blob/7bb51cb9bc54b4138642b08ddf371740d89af7ca/src/engine/base.ts#L472)
262
286
 
263
287
  Gets the unique identifier of this engine implementation.
264
288
 
@@ -278,7 +302,7 @@ Gets the unique identifier of this engine implementation.
278
302
 
279
303
  > **get** **mode**(): [`FetchEngineType`](../type-aliases/FetchEngineType.md)
280
304
 
281
- Defined in: [packages/web-fetcher/src/engine/base.ts:484](https://github.com/isdk/web-fetcher.js/blob/d7b505cc39fc821039fb79f641e2e590d2fc028d/src/engine/base.ts#L484)
305
+ Defined in: [packages/web-fetcher/src/engine/base.ts:490](https://github.com/isdk/web-fetcher.js/blob/7bb51cb9bc54b4138642b08ddf371740d89af7ca/src/engine/base.ts#L490)
282
306
 
283
307
  Gets the execution mode of this engine (`'http'` or `'browser'`).
284
308
 
@@ -296,7 +320,7 @@ Gets the execution mode of this engine (`'http'` or `'browser'`).
296
320
 
297
321
  > `protected` **\_buildResponse**(`context`): `Promise`\<[`FetchResponse`](../interfaces/FetchResponse.md)\>
298
322
 
299
- Defined in: [packages/web-fetcher/src/engine/cheerio.ts:28](https://github.com/isdk/web-fetcher.js/blob/d7b505cc39fc821039fb79f641e2e590d2fc028d/src/engine/cheerio.ts#L28)
323
+ Defined in: [packages/web-fetcher/src/engine/cheerio.ts:39](https://github.com/isdk/web-fetcher.js/blob/7bb51cb9bc54b4138642b08ddf371740d89af7ca/src/engine/cheerio.ts#L39)
300
324
 
301
325
  **`Internal`**
302
326
 
@@ -330,7 +354,7 @@ Converts implementation-specific context (Playwright `page` or Cheerio `$`) to s
330
354
 
331
355
  > `protected` `optional` **\_cleanup**(): `Promise`\<`void`\>
332
356
 
333
- Defined in: [packages/web-fetcher/src/engine/base.ts:242](https://github.com/isdk/web-fetcher.js/blob/d7b505cc39fc821039fb79f641e2e590d2fc028d/src/engine/base.ts#L242)
357
+ Defined in: [packages/web-fetcher/src/engine/base.ts:247](https://github.com/isdk/web-fetcher.js/blob/7bb51cb9bc54b4138642b08ddf371740d89af7ca/src/engine/base.ts#L247)
334
358
 
335
359
  #### Returns
336
360
 
@@ -346,7 +370,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:242](https://github.com/isd
346
370
 
347
371
  > `protected` **\_commonCleanup**(): `Promise`\<`void`\>
348
372
 
349
- Defined in: [packages/web-fetcher/src/engine/base.ts:675](https://github.com/isdk/web-fetcher.js/blob/d7b505cc39fc821039fb79f641e2e590d2fc028d/src/engine/base.ts#L675)
373
+ Defined in: [packages/web-fetcher/src/engine/base.ts:718](https://github.com/isdk/web-fetcher.js/blob/7bb51cb9bc54b4138642b08ddf371740d89af7ca/src/engine/base.ts#L718)
350
374
 
351
375
  #### Returns
352
376
 
@@ -362,7 +386,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:675](https://github.com/isd
362
386
 
363
387
  > `protected` **\_createCrawler**(`options`): `CheerioCrawler`
364
388
 
365
- Defined in: [packages/web-fetcher/src/engine/cheerio.ts:247](https://github.com/isdk/web-fetcher.js/blob/d7b505cc39fc821039fb79f641e2e590d2fc028d/src/engine/cheerio.ts#L247)
389
+ Defined in: [packages/web-fetcher/src/engine/cheerio.ts:259](https://github.com/isdk/web-fetcher.js/blob/7bb51cb9bc54b4138642b08ddf371740d89af7ca/src/engine/cheerio.ts#L259)
366
390
 
367
391
  **`Internal`**
368
392
 
@@ -390,7 +414,7 @@ The final crawler options.
390
414
 
391
415
  > `protected` **\_executePendingActions**(`context`): `Promise`\<`void`\>
392
416
 
393
- Defined in: [packages/web-fetcher/src/engine/base.ts:591](https://github.com/isdk/web-fetcher.js/blob/d7b505cc39fc821039fb79f641e2e590d2fc028d/src/engine/base.ts#L591)
417
+ Defined in: [packages/web-fetcher/src/engine/base.ts:627](https://github.com/isdk/web-fetcher.js/blob/7bb51cb9bc54b4138642b08ddf371740d89af7ca/src/engine/base.ts#L627)
394
418
 
395
419
  **`Internal`**
396
420
 
@@ -443,7 +467,7 @@ If called outside valid page context window (`!this.isPageActive`)
443
467
 
444
468
  > `protected` **\_extract**(`schema`, `context`): `Promise`\<`any`\>
445
469
 
446
- Defined in: [packages/web-fetcher/src/engine/base.ts:247](https://github.com/isdk/web-fetcher.js/blob/d7b505cc39fc821039fb79f641e2e590d2fc028d/src/engine/base.ts#L247)
470
+ Defined in: [packages/web-fetcher/src/engine/base.ts:252](https://github.com/isdk/web-fetcher.js/blob/7bb51cb9bc54b4138642b08ddf371740d89af7ca/src/engine/base.ts#L252)
447
471
 
448
472
  #### Parameters
449
473
 
@@ -469,7 +493,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:247](https://github.com/isd
469
493
 
470
494
  > `protected` **\_extractValue**(`schema`, `context`): `Promise`\<`any`\>
471
495
 
472
- Defined in: [packages/web-fetcher/src/engine/cheerio.ts:64](https://github.com/isdk/web-fetcher.js/blob/d7b505cc39fc821039fb79f641e2e590d2fc028d/src/engine/cheerio.ts#L64)
496
+ Defined in: [packages/web-fetcher/src/engine/cheerio.ts:76](https://github.com/isdk/web-fetcher.js/blob/7bb51cb9bc54b4138642b08ddf371740d89af7ca/src/engine/cheerio.ts#L76)
473
497
 
474
498
  #### Parameters
475
499
 
@@ -497,7 +521,7 @@ Defined in: [packages/web-fetcher/src/engine/cheerio.ts:64](https://github.com/i
497
521
 
498
522
  > `protected` **\_getSpecificCrawlerOptions**(`ctx`): `CheerioCrawlerOptions`
499
523
 
500
- Defined in: [packages/web-fetcher/src/engine/cheerio.ts:251](https://github.com/isdk/web-fetcher.js/blob/d7b505cc39fc821039fb79f641e2e590d2fc028d/src/engine/cheerio.ts#L251)
524
+ Defined in: [packages/web-fetcher/src/engine/cheerio.ts:263](https://github.com/isdk/web-fetcher.js/blob/7bb51cb9bc54b4138642b08ddf371740d89af7ca/src/engine/cheerio.ts#L263)
501
525
 
502
526
  **`Internal`**
503
527
 
@@ -525,7 +549,7 @@ The fetch engine context.
525
549
 
526
550
  > `protected` **\_normalizeSchema**(`schema`): `ExtractSchema`
527
551
 
528
- Defined in: [packages/web-fetcher/src/engine/base.ts:423](https://github.com/isdk/web-fetcher.js/blob/d7b505cc39fc821039fb79f641e2e590d2fc028d/src/engine/base.ts#L423)
552
+ Defined in: [packages/web-fetcher/src/engine/base.ts:428](https://github.com/isdk/web-fetcher.js/blob/7bb51cb9bc54b4138642b08ddf371740d89af7ca/src/engine/base.ts#L428)
529
553
 
530
554
  #### Parameters
531
555
 
@@ -547,7 +571,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:423](https://github.com/isd
547
571
 
548
572
  > `protected` **\_querySelectorAll**(`context`, `selector`): `Promise`\<`any`[]\>
549
573
 
550
- Defined in: [packages/web-fetcher/src/engine/cheerio.ts:59](https://github.com/isdk/web-fetcher.js/blob/d7b505cc39fc821039fb79f641e2e590d2fc028d/src/engine/cheerio.ts#L59)
574
+ Defined in: [packages/web-fetcher/src/engine/cheerio.ts:71](https://github.com/isdk/web-fetcher.js/blob/7bb51cb9bc54b4138642b08ddf371740d89af7ca/src/engine/cheerio.ts#L71)
551
575
 
552
576
  #### Parameters
553
577
 
@@ -579,7 +603,7 @@ Defined in: [packages/web-fetcher/src/engine/cheerio.ts:59](https://github.com/i
579
603
 
580
604
  > `protected` **\_sharedFailedRequestHandler**(`context`, `error?`): `Promise`\<`void`\>
581
605
 
582
- Defined in: [packages/web-fetcher/src/engine/base.ts:642](https://github.com/isdk/web-fetcher.js/blob/d7b505cc39fc821039fb79f641e2e590d2fc028d/src/engine/base.ts#L642)
606
+ Defined in: [packages/web-fetcher/src/engine/base.ts:685](https://github.com/isdk/web-fetcher.js/blob/7bb51cb9bc54b4138642b08ddf371740d89af7ca/src/engine/base.ts#L685)
583
607
 
584
608
  #### Parameters
585
609
 
@@ -605,7 +629,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:642](https://github.com/isd
605
629
 
606
630
  > `protected` **\_sharedRequestHandler**(`context`): `Promise`\<`void`\>
607
631
 
608
- Defined in: [packages/web-fetcher/src/engine/base.ts:614](https://github.com/isdk/web-fetcher.js/blob/d7b505cc39fc821039fb79f641e2e590d2fc028d/src/engine/base.ts#L614)
632
+ Defined in: [packages/web-fetcher/src/engine/base.ts:650](https://github.com/isdk/web-fetcher.js/blob/7bb51cb9bc54b4138642b08ddf371740d89af7ca/src/engine/base.ts#L650)
609
633
 
610
634
  #### Parameters
611
635
 
@@ -627,7 +651,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:614](https://github.com/isd
627
651
 
628
652
  > **blockResources**(`types`, `overwrite?`): `Promise`\<`number`\>
629
653
 
630
- Defined in: [packages/web-fetcher/src/engine/base.ts:719](https://github.com/isdk/web-fetcher.js/blob/d7b505cc39fc821039fb79f641e2e590d2fc028d/src/engine/base.ts#L719)
654
+ Defined in: [packages/web-fetcher/src/engine/base.ts:763](https://github.com/isdk/web-fetcher.js/blob/7bb51cb9bc54b4138642b08ddf371740d89af7ca/src/engine/base.ts#L763)
631
655
 
632
656
  Blocks specified resource types from loading.
633
657
 
@@ -668,7 +692,7 @@ await engine.blockResources(['script'], true); // Replace existing
668
692
 
669
693
  > `protected` **buildResponse**(`context`): `Promise`\<[`FetchResponse`](../interfaces/FetchResponse.md)\>
670
694
 
671
- Defined in: [packages/web-fetcher/src/engine/base.ts:316](https://github.com/isdk/web-fetcher.js/blob/d7b505cc39fc821039fb79f641e2e590d2fc028d/src/engine/base.ts#L316)
695
+ Defined in: [packages/web-fetcher/src/engine/base.ts:321](https://github.com/isdk/web-fetcher.js/blob/7bb51cb9bc54b4138642b08ddf371740d89af7ca/src/engine/base.ts#L321)
672
696
 
673
697
  #### Parameters
674
698
 
@@ -690,7 +714,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:316](https://github.com/isd
690
714
 
691
715
  > **cleanup**(): `Promise`\<`void`\>
692
716
 
693
- Defined in: [packages/web-fetcher/src/engine/base.ts:555](https://github.com/isdk/web-fetcher.js/blob/d7b505cc39fc821039fb79f641e2e590d2fc028d/src/engine/base.ts#L555)
717
+ Defined in: [packages/web-fetcher/src/engine/base.ts:591](https://github.com/isdk/web-fetcher.js/blob/7bb51cb9bc54b4138642b08ddf371740d89af7ca/src/engine/base.ts#L591)
694
718
 
695
719
  #### Returns
696
720
 
@@ -706,7 +730,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:555](https://github.com/isd
706
730
 
707
731
  > **click**(`selector`): `Promise`\<`void`\>
708
732
 
709
- Defined in: [packages/web-fetcher/src/engine/base.ts:373](https://github.com/isdk/web-fetcher.js/blob/d7b505cc39fc821039fb79f641e2e590d2fc028d/src/engine/base.ts#L373)
733
+ Defined in: [packages/web-fetcher/src/engine/base.ts:378](https://github.com/isdk/web-fetcher.js/blob/7bb51cb9bc54b4138642b08ddf371740d89af7ca/src/engine/base.ts#L378)
710
734
 
711
735
  Clicks on element matching selector.
712
736
 
@@ -740,7 +764,7 @@ When no active page context exists
740
764
 
741
765
  > **cookies**(): `Promise`\<[`Cookie`](../interfaces/Cookie.md)[]\>
742
766
 
743
- Defined in: [packages/web-fetcher/src/engine/base.ts:830](https://github.com/isdk/web-fetcher.js/blob/d7b505cc39fc821039fb79f641e2e590d2fc028d/src/engine/base.ts#L830)
767
+ Defined in: [packages/web-fetcher/src/engine/base.ts:874](https://github.com/isdk/web-fetcher.js/blob/7bb51cb9bc54b4138642b08ddf371740d89af7ca/src/engine/base.ts#L874)
744
768
 
745
769
  Manages cookies for current session with multiple overloads.
746
770
 
@@ -769,7 +793,7 @@ await engine.cookies([{ name: 'session', value: '123' }]);
769
793
 
770
794
  > **cookies**(`cookies`): `Promise`\<`boolean`\>
771
795
 
772
- Defined in: [packages/web-fetcher/src/engine/base.ts:831](https://github.com/isdk/web-fetcher.js/blob/d7b505cc39fc821039fb79f641e2e590d2fc028d/src/engine/base.ts#L831)
796
+ Defined in: [packages/web-fetcher/src/engine/base.ts:875](https://github.com/isdk/web-fetcher.js/blob/7bb51cb9bc54b4138642b08ddf371740d89af7ca/src/engine/base.ts#L875)
773
797
 
774
798
  Manages cookies for current session with multiple overloads.
775
799
 
@@ -808,7 +832,7 @@ await engine.cookies([{ name: 'session', value: '123' }]);
808
832
 
809
833
  > `protected` **dispatchAction**\<`T`\>(`action`): `Promise`\<`T`\>
810
834
 
811
- Defined in: [packages/web-fetcher/src/engine/base.ts:658](https://github.com/isdk/web-fetcher.js/blob/d7b505cc39fc821039fb79f641e2e590d2fc028d/src/engine/base.ts#L658)
835
+ Defined in: [packages/web-fetcher/src/engine/base.ts:701](https://github.com/isdk/web-fetcher.js/blob/7bb51cb9bc54b4138642b08ddf371740d89af7ca/src/engine/base.ts#L701)
812
836
 
813
837
  #### Type Parameters
814
838
 
@@ -836,7 +860,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:658](https://github.com/isd
836
860
 
837
861
  > **dispose**(): `Promise`\<`void`\>
838
862
 
839
- Defined in: [packages/web-fetcher/src/engine/base.ts:848](https://github.com/isdk/web-fetcher.js/blob/d7b505cc39fc821039fb79f641e2e590d2fc028d/src/engine/base.ts#L848)
863
+ Defined in: [packages/web-fetcher/src/engine/base.ts:910](https://github.com/isdk/web-fetcher.js/blob/7bb51cb9bc54b4138642b08ddf371740d89af7ca/src/engine/base.ts#L910)
840
864
 
841
865
  Disposes of engine, cleaning up all resources.
842
866
 
@@ -856,7 +880,7 @@ Promise resolving when disposal completes
856
880
 
857
881
  > `protected` **executeAction**(`context`, `action`): `Promise`\<`any`\>
858
882
 
859
- Defined in: [packages/web-fetcher/src/engine/cheerio.ts:92](https://github.com/isdk/web-fetcher.js/blob/d7b505cc39fc821039fb79f641e2e590d2fc028d/src/engine/cheerio.ts#L92)
883
+ Defined in: [packages/web-fetcher/src/engine/cheerio.ts:104](https://github.com/isdk/web-fetcher.js/blob/7bb51cb9bc54b4138642b08ddf371740d89af7ca/src/engine/cheerio.ts#L104)
860
884
 
861
885
  **`Internal`**
862
886
 
@@ -896,7 +920,7 @@ Handles specific user interactions using underlying technology (Playwright/Cheer
896
920
 
897
921
  > **extract**\<`T`\>(`schema`): `Promise`\<`T`\>
898
922
 
899
- Defined in: [packages/web-fetcher/src/engine/base.ts:418](https://github.com/isdk/web-fetcher.js/blob/d7b505cc39fc821039fb79f641e2e590d2fc028d/src/engine/base.ts#L418)
923
+ Defined in: [packages/web-fetcher/src/engine/base.ts:423](https://github.com/isdk/web-fetcher.js/blob/7bb51cb9bc54b4138642b08ddf371740d89af7ca/src/engine/base.ts#L423)
900
924
 
901
925
  Extracts structured data from the current page content.
902
926
 
@@ -930,7 +954,7 @@ A promise that resolves to an object with the extracted data.
930
954
 
931
955
  > **fill**(`selector`, `value`): `Promise`\<`void`\>
932
956
 
933
- Defined in: [packages/web-fetcher/src/engine/base.ts:385](https://github.com/isdk/web-fetcher.js/blob/d7b505cc39fc821039fb79f641e2e590d2fc028d/src/engine/base.ts#L385)
957
+ Defined in: [packages/web-fetcher/src/engine/base.ts:390](https://github.com/isdk/web-fetcher.js/blob/7bb51cb9bc54b4138642b08ddf371740d89af7ca/src/engine/base.ts#L390)
934
958
 
935
959
  Fills input element with specified value.
936
960
 
@@ -968,7 +992,7 @@ When no active page context exists
968
992
 
969
993
  > **getContent**(): `Promise`\<[`FetchResponse`](../interfaces/FetchResponse.md)\>
970
994
 
971
- Defined in: [packages/web-fetcher/src/engine/base.ts:733](https://github.com/isdk/web-fetcher.js/blob/d7b505cc39fc821039fb79f641e2e590d2fc028d/src/engine/base.ts#L733)
995
+ Defined in: [packages/web-fetcher/src/engine/base.ts:777](https://github.com/isdk/web-fetcher.js/blob/7bb51cb9bc54b4138642b08ddf371740d89af7ca/src/engine/base.ts#L777)
972
996
 
973
997
  Gets content of current page.
974
998
 
@@ -990,16 +1014,16 @@ When no content has been fetched yet
990
1014
 
991
1015
  ### getState()
992
1016
 
993
- > **getState**(): `Promise`\<\{ `cookies`: [`Cookie`](../interfaces/Cookie.md)[]; \}\>
1017
+ > **getState**(): `Promise`\<\{ `cookies`: [`Cookie`](../interfaces/Cookie.md)[]; `sessionState?`: `any`; \}\>
994
1018
 
995
- Defined in: [packages/web-fetcher/src/engine/base.ts:475](https://github.com/isdk/web-fetcher.js/blob/d7b505cc39fc821039fb79f641e2e590d2fc028d/src/engine/base.ts#L475)
1019
+ Defined in: [packages/web-fetcher/src/engine/base.ts:480](https://github.com/isdk/web-fetcher.js/blob/7bb51cb9bc54b4138642b08ddf371740d89af7ca/src/engine/base.ts#L480)
996
1020
 
997
1021
  Returns the current state of the engine (cookies)
998
1022
  that can be used to restore the session later.
999
1023
 
1000
1024
  #### Returns
1001
1025
 
1002
- `Promise`\<\{ `cookies`: [`Cookie`](../interfaces/Cookie.md)[]; \}\>
1026
+ `Promise`\<\{ `cookies`: [`Cookie`](../interfaces/Cookie.md)[]; `sessionState?`: `any`; \}\>
1003
1027
 
1004
1028
  #### Inherited from
1005
1029
 
@@ -1011,7 +1035,7 @@ that can be used to restore the session later.
1011
1035
 
1012
1036
  > **goto**(`url`, `params?`): `Promise`\<`void` \| [`FetchResponse`](../interfaces/FetchResponse.md)\>
1013
1037
 
1014
- Defined in: [packages/web-fetcher/src/engine/cheerio.ts:282](https://github.com/isdk/web-fetcher.js/blob/d7b505cc39fc821039fb79f641e2e590d2fc028d/src/engine/cheerio.ts#L282)
1038
+ Defined in: [packages/web-fetcher/src/engine/cheerio.ts:283](https://github.com/isdk/web-fetcher.js/blob/7bb51cb9bc54b4138642b08ddf371740d89af7ca/src/engine/cheerio.ts#L283)
1015
1039
 
1016
1040
  Navigates to the specified URL.
1017
1041
 
@@ -1053,7 +1077,7 @@ await engine.goto('https://example.com');
1053
1077
 
1054
1078
  > **headers**(): `Promise`\<`Record`\<`string`, `string`\>\>
1055
1079
 
1056
- Defined in: [packages/web-fetcher/src/engine/base.ts:772](https://github.com/isdk/web-fetcher.js/blob/d7b505cc39fc821039fb79f641e2e590d2fc028d/src/engine/base.ts#L772)
1080
+ Defined in: [packages/web-fetcher/src/engine/base.ts:816](https://github.com/isdk/web-fetcher.js/blob/7bb51cb9bc54b4138642b08ddf371740d89af7ca/src/engine/base.ts#L816)
1057
1081
 
1058
1082
  Manages HTTP headers for requests with multiple overloads.
1059
1083
 
@@ -1084,7 +1108,7 @@ await engine.headers('auth', 'token');
1084
1108
 
1085
1109
  > **headers**(`name`): `Promise`\<`string`\>
1086
1110
 
1087
- Defined in: [packages/web-fetcher/src/engine/base.ts:773](https://github.com/isdk/web-fetcher.js/blob/d7b505cc39fc821039fb79f641e2e590d2fc028d/src/engine/base.ts#L773)
1111
+ Defined in: [packages/web-fetcher/src/engine/base.ts:817](https://github.com/isdk/web-fetcher.js/blob/7bb51cb9bc54b4138642b08ddf371740d89af7ca/src/engine/base.ts#L817)
1088
1112
 
1089
1113
  Manages HTTP headers for requests with multiple overloads.
1090
1114
 
@@ -1123,7 +1147,7 @@ await engine.headers('auth', 'token');
1123
1147
 
1124
1148
  > **headers**(`headers`, `replaced?`): `Promise`\<`boolean`\>
1125
1149
 
1126
- Defined in: [packages/web-fetcher/src/engine/base.ts:774](https://github.com/isdk/web-fetcher.js/blob/d7b505cc39fc821039fb79f641e2e590d2fc028d/src/engine/base.ts#L774)
1150
+ Defined in: [packages/web-fetcher/src/engine/base.ts:818](https://github.com/isdk/web-fetcher.js/blob/7bb51cb9bc54b4138642b08ddf371740d89af7ca/src/engine/base.ts#L818)
1127
1151
 
1128
1152
  Manages HTTP headers for requests with multiple overloads.
1129
1153
 
@@ -1168,7 +1192,7 @@ await engine.headers('auth', 'token');
1168
1192
 
1169
1193
  > **headers**(`name`, `value`): `Promise`\<`boolean`\>
1170
1194
 
1171
- Defined in: [packages/web-fetcher/src/engine/base.ts:775](https://github.com/isdk/web-fetcher.js/blob/d7b505cc39fc821039fb79f641e2e590d2fc028d/src/engine/base.ts#L775)
1195
+ Defined in: [packages/web-fetcher/src/engine/base.ts:819](https://github.com/isdk/web-fetcher.js/blob/7bb51cb9bc54b4138642b08ddf371740d89af7ca/src/engine/base.ts#L819)
1172
1196
 
1173
1197
  Manages HTTP headers for requests with multiple overloads.
1174
1198
 
@@ -1215,7 +1239,7 @@ await engine.headers('auth', 'token');
1215
1239
 
1216
1240
  > **initialize**(`context`, `options?`): `Promise`\<`void`\>
1217
1241
 
1218
- Defined in: [packages/web-fetcher/src/engine/base.ts:506](https://github.com/isdk/web-fetcher.js/blob/d7b505cc39fc821039fb79f641e2e590d2fc028d/src/engine/base.ts#L506)
1242
+ Defined in: [packages/web-fetcher/src/engine/base.ts:512](https://github.com/isdk/web-fetcher.js/blob/7bb51cb9bc54b4138642b08ddf371740d89af7ca/src/engine/base.ts#L512)
1219
1243
 
1220
1244
  Initializes the fetch engine with provided context and options.
1221
1245
 
@@ -1254,7 +1278,7 @@ Automatically called when creating engine via `FetchEngine.create()`.
1254
1278
 
1255
1279
  > **pause**(`message?`): `Promise`\<`void`\>
1256
1280
 
1257
- Defined in: [packages/web-fetcher/src/engine/base.ts:408](https://github.com/isdk/web-fetcher.js/blob/d7b505cc39fc821039fb79f641e2e590d2fc028d/src/engine/base.ts#L408)
1281
+ Defined in: [packages/web-fetcher/src/engine/base.ts:413](https://github.com/isdk/web-fetcher.js/blob/7bb51cb9bc54b4138642b08ddf371740d89af7ca/src/engine/base.ts#L413)
1258
1282
 
1259
1283
  Pauses execution, allowing for manual intervention or inspection.
1260
1284
 
@@ -1286,7 +1310,7 @@ When no active page context exists
1286
1310
 
1287
1311
  > **submit**(`selector?`, `options?`): `Promise`\<`void`\>
1288
1312
 
1289
- Defined in: [packages/web-fetcher/src/engine/base.ts:397](https://github.com/isdk/web-fetcher.js/blob/d7b505cc39fc821039fb79f641e2e590d2fc028d/src/engine/base.ts#L397)
1313
+ Defined in: [packages/web-fetcher/src/engine/base.ts:402](https://github.com/isdk/web-fetcher.js/blob/7bb51cb9bc54b4138642b08ddf371740d89af7ca/src/engine/base.ts#L402)
1290
1314
 
1291
1315
  Submits a form.
1292
1316
 
@@ -1324,7 +1348,7 @@ When no active page context exists
1324
1348
 
1325
1349
  > **waitFor**(`params?`): `Promise`\<`void`\>
1326
1350
 
1327
- Defined in: [packages/web-fetcher/src/engine/base.ts:362](https://github.com/isdk/web-fetcher.js/blob/d7b505cc39fc821039fb79f641e2e590d2fc028d/src/engine/base.ts#L362)
1351
+ Defined in: [packages/web-fetcher/src/engine/base.ts:367](https://github.com/isdk/web-fetcher.js/blob/7bb51cb9bc54b4138642b08ddf371740d89af7ca/src/engine/base.ts#L367)
1328
1352
 
1329
1353
  Waits for specified condition before continuing.
1330
1354
 
@@ -1359,7 +1383,7 @@ await engine.waitFor({ selector: '#content' }); // Wait for element
1359
1383
 
1360
1384
  > `static` **create**(`ctx`, `options?`): `Promise`\<`undefined` \| `AnyFetchEngine`\>
1361
1385
 
1362
- Defined in: [packages/web-fetcher/src/engine/base.ts:199](https://github.com/isdk/web-fetcher.js/blob/d7b505cc39fc821039fb79f641e2e590d2fc028d/src/engine/base.ts#L199)
1386
+ Defined in: [packages/web-fetcher/src/engine/base.ts:202](https://github.com/isdk/web-fetcher.js/blob/7bb51cb9bc54b4138642b08ddf371740d89af7ca/src/engine/base.ts#L202)
1363
1387
 
1364
1388
  Factory method to create and initialize a fetch engine instance.
1365
1389
 
@@ -1401,7 +1425,7 @@ Primary entry point for engine creation. Selects appropriate implementation base
1401
1425
 
1402
1426
  > `static` **get**(`id`): `undefined` \| `AnyFetchEngineCtor`
1403
1427
 
1404
- Defined in: [packages/web-fetcher/src/engine/base.ts:172](https://github.com/isdk/web-fetcher.js/blob/d7b505cc39fc821039fb79f641e2e590d2fc028d/src/engine/base.ts#L172)
1428
+ Defined in: [packages/web-fetcher/src/engine/base.ts:175](https://github.com/isdk/web-fetcher.js/blob/7bb51cb9bc54b4138642b08ddf371740d89af7ca/src/engine/base.ts#L175)
1405
1429
 
1406
1430
  Retrieves a fetch engine implementation by its unique ID.
1407
1431
 
@@ -1429,7 +1453,7 @@ Engine class if found, otherwise `undefined`
1429
1453
 
1430
1454
  > `static` **getByMode**(`mode`): `undefined` \| `AnyFetchEngineCtor`
1431
1455
 
1432
- Defined in: [packages/web-fetcher/src/engine/base.ts:182](https://github.com/isdk/web-fetcher.js/blob/d7b505cc39fc821039fb79f641e2e590d2fc028d/src/engine/base.ts#L182)
1456
+ Defined in: [packages/web-fetcher/src/engine/base.ts:185](https://github.com/isdk/web-fetcher.js/blob/7bb51cb9bc54b4138642b08ddf371740d89af7ca/src/engine/base.ts#L185)
1433
1457
 
1434
1458
  Retrieves a fetch engine implementation by execution mode.
1435
1459
 
@@ -1457,7 +1481,7 @@ Engine class if found, otherwise `undefined`
1457
1481
 
1458
1482
  > `static` **register**(`engineClass`): `void`
1459
1483
 
1460
- Defined in: [packages/web-fetcher/src/engine/base.ts:159](https://github.com/isdk/web-fetcher.js/blob/d7b505cc39fc821039fb79f641e2e590d2fc028d/src/engine/base.ts#L159)
1484
+ Defined in: [packages/web-fetcher/src/engine/base.ts:162](https://github.com/isdk/web-fetcher.js/blob/7bb51cb9bc54b4138642b08ddf371740d89af7ca/src/engine/base.ts#L162)
1461
1485
 
1462
1486
  Registers a fetch engine implementation with the global registry.
1463
1487