@isdk/web-fetcher 0.3.0 → 0.3.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.action.cn.md +77 -312
- package/README.action.extract.cn.md +263 -0
- package/README.action.extract.md +263 -0
- package/README.action.md +76 -311
- package/README.cn.md +12 -2
- package/README.engine.cn.md +22 -1
- package/README.engine.md +22 -1
- package/README.md +10 -1
- package/dist/index.d.mts +245 -1
- package/dist/index.d.ts +245 -1
- package/dist/index.js +1 -1
- package/dist/index.mjs +1 -1
- package/docs/README.md +10 -1
- package/docs/_media/README.action.md +76 -311
- package/docs/_media/README.cn.md +12 -2
- package/docs/_media/README.engine.md +22 -1
- package/docs/classes/CheerioFetchEngine.md +312 -88
- package/docs/classes/ClickAction.md +23 -23
- package/docs/classes/EvaluateAction.md +23 -23
- package/docs/classes/ExtractAction.md +23 -23
- package/docs/classes/FetchAction.md +29 -23
- package/docs/classes/FetchEngine.md +286 -86
- package/docs/classes/FetchSession.md +13 -13
- package/docs/classes/FillAction.md +23 -23
- package/docs/classes/GetContentAction.md +23 -23
- package/docs/classes/GotoAction.md +23 -23
- package/docs/classes/KeyboardPressAction.md +533 -0
- package/docs/classes/KeyboardTypeAction.md +533 -0
- package/docs/classes/MouseClickAction.md +533 -0
- package/docs/classes/MouseMoveAction.md +533 -0
- package/docs/classes/MouseWheelAction.md +533 -0
- package/docs/classes/PauseAction.md +23 -23
- package/docs/classes/PlaywrightFetchEngine.md +472 -88
- package/docs/classes/ScrollIntoViewAction.md +533 -0
- package/docs/classes/SubmitAction.md +23 -23
- package/docs/classes/TrimAction.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/functions/getRandomDelay.md +25 -0
- package/docs/globals.md +13 -0
- package/docs/interfaces/BaseFetchActionProperties.md +12 -12
- package/docs/interfaces/BaseFetchCollectorActionProperties.md +16 -16
- package/docs/interfaces/BaseFetcherProperties.md +31 -27
- package/docs/interfaces/Cookie.md +14 -14
- package/docs/interfaces/DispatchedEngineAction.md +4 -4
- package/docs/interfaces/EvaluateActionOptions.md +3 -3
- package/docs/interfaces/ExtractActionProperties.md +12 -12
- package/docs/interfaces/FetchActionInContext.md +15 -15
- package/docs/interfaces/FetchActionProperties.md +13 -13
- package/docs/interfaces/FetchActionResult.md +6 -6
- package/docs/interfaces/FetchContext.md +41 -37
- package/docs/interfaces/FetchEngineContext.md +36 -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 +34 -30
- package/docs/interfaces/FetcherOptions.md +33 -29
- package/docs/interfaces/GotoActionOptions.md +14 -6
- package/docs/interfaces/KeyboardPressParams.md +25 -0
- package/docs/interfaces/KeyboardTypeParams.md +25 -0
- package/docs/interfaces/MouseClickParams.md +49 -0
- package/docs/interfaces/MouseMoveParams.md +41 -0
- package/docs/interfaces/MouseWheelParams.md +69 -0
- package/docs/interfaces/PendingEngineRequest.md +3 -3
- package/docs/interfaces/ScrollIntoViewParams.md +17 -0
- package/docs/interfaces/StorageOptions.md +5 -5
- package/docs/interfaces/SubmitActionOptions.md +2 -2
- package/docs/interfaces/TrimActionOptions.md +3 -3
- 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 +2 -2
- 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/type-aliases/TrimPreset.md +1 -1
- package/docs/variables/DefaultFetcherProperties.md +1 -1
- package/docs/variables/FetcherOptionKeys.md +1 -1
- package/docs/variables/TRIM_PRESETS.md +1 -1
- package/package.json +10 -10
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: BaseFetcherProperties
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:63](https://github.com/isdk/web-fetcher.js/blob/
|
|
9
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:63](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/core/types.ts#L63)
|
|
10
10
|
|
|
11
11
|
## Extended by
|
|
12
12
|
|
|
@@ -20,7 +20,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:63](https://github.com/isdk/
|
|
|
20
20
|
|
|
21
21
|
> `optional` **antibot**: `boolean`
|
|
22
22
|
|
|
23
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:74](https://github.com/isdk/web-fetcher.js/blob/
|
|
23
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:74](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/core/types.ts#L74)
|
|
24
24
|
|
|
25
25
|
***
|
|
26
26
|
|
|
@@ -28,7 +28,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:74](https://github.com/isdk/
|
|
|
28
28
|
|
|
29
29
|
> `optional` **blockResources**: `string`[]
|
|
30
30
|
|
|
31
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:91](https://github.com/isdk/web-fetcher.js/blob/
|
|
31
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:91](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/core/types.ts#L91)
|
|
32
32
|
|
|
33
33
|
***
|
|
34
34
|
|
|
@@ -36,7 +36,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:91](https://github.com/isdk/
|
|
|
36
36
|
|
|
37
37
|
> `optional` **browser**: `object`
|
|
38
38
|
|
|
39
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:101](https://github.com/isdk/web-fetcher.js/blob/
|
|
39
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:101](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/core/types.ts#L101)
|
|
40
40
|
|
|
41
41
|
#### engine?
|
|
42
42
|
|
|
@@ -51,6 +51,10 @@ Defined in: [packages/web-fetcher/src/core/types.ts:101](https://github.com/isdk
|
|
|
51
51
|
|
|
52
52
|
> `optional` **headless**: `boolean`
|
|
53
53
|
|
|
54
|
+
#### launchOptions?
|
|
55
|
+
|
|
56
|
+
> `optional` **launchOptions**: `Record`\<`string`, `any`\>
|
|
57
|
+
|
|
54
58
|
#### waitUntil?
|
|
55
59
|
|
|
56
60
|
> `optional` **waitUntil**: `"load"` \| `"domcontentloaded"` \| `"networkidle"` \| `"commit"`
|
|
@@ -61,7 +65,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:101](https://github.com/isdk
|
|
|
61
65
|
|
|
62
66
|
> `optional` **cookies**: [`Cookie`](Cookie.md)[]
|
|
63
67
|
|
|
64
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:78](https://github.com/isdk/web-fetcher.js/blob/
|
|
68
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:78](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/core/types.ts#L78)
|
|
65
69
|
|
|
66
70
|
***
|
|
67
71
|
|
|
@@ -69,7 +73,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:78](https://github.com/isdk/
|
|
|
69
73
|
|
|
70
74
|
> `optional` **debug**: `string` \| `boolean` \| `string`[]
|
|
71
75
|
|
|
72
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:75](https://github.com/isdk/web-fetcher.js/blob/
|
|
76
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:75](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/core/types.ts#L75)
|
|
73
77
|
|
|
74
78
|
***
|
|
75
79
|
|
|
@@ -77,7 +81,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:75](https://github.com/isdk/
|
|
|
77
81
|
|
|
78
82
|
> `optional` **delayBetweenRequestsMs**: `number`
|
|
79
83
|
|
|
80
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
84
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:123](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/core/types.ts#L123)
|
|
81
85
|
|
|
82
86
|
***
|
|
83
87
|
|
|
@@ -85,7 +89,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:122](https://github.com/isdk
|
|
|
85
89
|
|
|
86
90
|
> `optional` **enableSmart**: `boolean`
|
|
87
91
|
|
|
88
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:72](https://github.com/isdk/web-fetcher.js/blob/
|
|
92
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:72](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/core/types.ts#L72)
|
|
89
93
|
|
|
90
94
|
***
|
|
91
95
|
|
|
@@ -93,7 +97,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:72](https://github.com/isdk/
|
|
|
93
97
|
|
|
94
98
|
> `optional` **engine**: `string`
|
|
95
99
|
|
|
96
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:71](https://github.com/isdk/web-fetcher.js/blob/
|
|
100
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:71](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/core/types.ts#L71)
|
|
97
101
|
|
|
98
102
|
抓取模式
|
|
99
103
|
|
|
@@ -107,7 +111,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:71](https://github.com/isdk/
|
|
|
107
111
|
|
|
108
112
|
> `optional` **headers**: `Record`\<`string`, `string`\>
|
|
109
113
|
|
|
110
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:77](https://github.com/isdk/web-fetcher.js/blob/
|
|
114
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:77](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/core/types.ts#L77)
|
|
111
115
|
|
|
112
116
|
***
|
|
113
117
|
|
|
@@ -115,7 +119,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:77](https://github.com/isdk/
|
|
|
115
119
|
|
|
116
120
|
> `optional` **http**: `object`
|
|
117
121
|
|
|
118
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
122
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:114](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/core/types.ts#L114)
|
|
119
123
|
|
|
120
124
|
#### body?
|
|
121
125
|
|
|
@@ -131,7 +135,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:113](https://github.com/isdk
|
|
|
131
135
|
|
|
132
136
|
> `optional` **ignoreSslErrors**: `boolean`
|
|
133
137
|
|
|
134
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:99](https://github.com/isdk/web-fetcher.js/blob/
|
|
138
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:99](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/core/types.ts#L99)
|
|
135
139
|
|
|
136
140
|
***
|
|
137
141
|
|
|
@@ -139,7 +143,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:99](https://github.com/isdk/
|
|
|
139
143
|
|
|
140
144
|
> `optional` **maxConcurrency**: `number`
|
|
141
145
|
|
|
142
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
146
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:121](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/core/types.ts#L121)
|
|
143
147
|
|
|
144
148
|
***
|
|
145
149
|
|
|
@@ -147,7 +151,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:120](https://github.com/isdk
|
|
|
147
151
|
|
|
148
152
|
> `optional` **maxRequestsPerMinute**: `number`
|
|
149
153
|
|
|
150
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
154
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:122](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/core/types.ts#L122)
|
|
151
155
|
|
|
152
156
|
***
|
|
153
157
|
|
|
@@ -155,7 +159,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:121](https://github.com/isdk
|
|
|
155
159
|
|
|
156
160
|
> `optional` **output**: `object`
|
|
157
161
|
|
|
158
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:84](https://github.com/isdk/web-fetcher.js/blob/
|
|
162
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:84](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/core/types.ts#L84)
|
|
159
163
|
|
|
160
164
|
#### cookies?
|
|
161
165
|
|
|
@@ -171,7 +175,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:84](https://github.com/isdk/
|
|
|
171
175
|
|
|
172
176
|
> `optional` **overrideSessionState**: `boolean`
|
|
173
177
|
|
|
174
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:81](https://github.com/isdk/web-fetcher.js/blob/
|
|
178
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:81](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/core/types.ts#L81)
|
|
175
179
|
|
|
176
180
|
***
|
|
177
181
|
|
|
@@ -179,7 +183,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:81](https://github.com/isdk/
|
|
|
179
183
|
|
|
180
184
|
> `optional` **proxy**: `string` \| `string`[]
|
|
181
185
|
|
|
182
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:89](https://github.com/isdk/web-fetcher.js/blob/
|
|
186
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:89](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/core/types.ts#L89)
|
|
183
187
|
|
|
184
188
|
***
|
|
185
189
|
|
|
@@ -187,7 +191,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:89](https://github.com/isdk/
|
|
|
187
191
|
|
|
188
192
|
> `optional` **requestHandlerTimeoutSecs**: `number`
|
|
189
193
|
|
|
190
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
194
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:120](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/core/types.ts#L120)
|
|
191
195
|
|
|
192
196
|
***
|
|
193
197
|
|
|
@@ -195,7 +199,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:119](https://github.com/isdk
|
|
|
195
199
|
|
|
196
200
|
> `optional` **retries**: `number`
|
|
197
201
|
|
|
198
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
202
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:124](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/core/types.ts#L124)
|
|
199
203
|
|
|
200
204
|
***
|
|
201
205
|
|
|
@@ -203,7 +207,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:123](https://github.com/isdk
|
|
|
203
207
|
|
|
204
208
|
> `optional` **sessionPoolOptions**: `SessionPoolOptions`
|
|
205
209
|
|
|
206
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:80](https://github.com/isdk/web-fetcher.js/blob/
|
|
210
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:80](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/core/types.ts#L80)
|
|
207
211
|
|
|
208
212
|
***
|
|
209
213
|
|
|
@@ -211,7 +215,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:80](https://github.com/isdk/
|
|
|
211
215
|
|
|
212
216
|
> `optional` **sessionState**: `any`
|
|
213
217
|
|
|
214
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:79](https://github.com/isdk/web-fetcher.js/blob/
|
|
218
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:79](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/core/types.ts#L79)
|
|
215
219
|
|
|
216
220
|
***
|
|
217
221
|
|
|
@@ -219,7 +223,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:79](https://github.com/isdk/
|
|
|
219
223
|
|
|
220
224
|
> `optional` **sites**: [`FetchSite`](FetchSite.md)[]
|
|
221
225
|
|
|
222
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
226
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:126](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/core/types.ts#L126)
|
|
223
227
|
|
|
224
228
|
***
|
|
225
229
|
|
|
@@ -227,7 +231,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:125](https://github.com/isdk
|
|
|
227
231
|
|
|
228
232
|
> `optional` **storage**: [`StorageOptions`](StorageOptions.md)
|
|
229
233
|
|
|
230
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:96](https://github.com/isdk/web-fetcher.js/blob/
|
|
234
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:96](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/core/types.ts#L96)
|
|
231
235
|
|
|
232
236
|
Storage configuration for session isolation and persistence.
|
|
233
237
|
|
|
@@ -237,7 +241,7 @@ Storage configuration for session isolation and persistence.
|
|
|
237
241
|
|
|
238
242
|
> `optional` **throwHttpErrors**: `boolean`
|
|
239
243
|
|
|
240
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:82](https://github.com/isdk/web-fetcher.js/blob/
|
|
244
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:82](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/core/types.ts#L82)
|
|
241
245
|
|
|
242
246
|
***
|
|
243
247
|
|
|
@@ -245,7 +249,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:82](https://github.com/isdk/
|
|
|
245
249
|
|
|
246
250
|
> `optional` **timeoutMs**: `number`
|
|
247
251
|
|
|
248
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
252
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:119](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/core/types.ts#L119)
|
|
249
253
|
|
|
250
254
|
***
|
|
251
255
|
|
|
@@ -253,7 +257,7 @@ Defined in: [packages/web-fetcher/src/core/types.ts:118](https://github.com/isdk
|
|
|
253
257
|
|
|
254
258
|
> `optional` **url**: `string`
|
|
255
259
|
|
|
256
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
260
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:127](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/core/types.ts#L127)
|
|
257
261
|
|
|
258
262
|
***
|
|
259
263
|
|
|
@@ -261,4 +265,4 @@ Defined in: [packages/web-fetcher/src/core/types.ts:126](https://github.com/isdk
|
|
|
261
265
|
|
|
262
266
|
> `optional` **useSiteRegistry**: `boolean`
|
|
263
267
|
|
|
264
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:73](https://github.com/isdk/web-fetcher.js/blob/
|
|
268
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:73](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/core/types.ts#L73)
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: Cookie
|
|
8
8
|
|
|
9
|
-
Defined in: node\_modules/.pnpm/@crawlee+types@3.
|
|
9
|
+
Defined in: node\_modules/.pnpm/@crawlee+types@3.16.0/node\_modules/@crawlee/types/browser.d.ts:2
|
|
10
10
|
|
|
11
11
|
## Properties
|
|
12
12
|
|
|
@@ -14,7 +14,7 @@ Defined in: node\_modules/.pnpm/@crawlee+types@3.15.1/node\_modules/@crawlee/typ
|
|
|
14
14
|
|
|
15
15
|
> `optional` **domain**: `string`
|
|
16
16
|
|
|
17
|
-
Defined in: node\_modules/.pnpm/@crawlee+types@3.
|
|
17
|
+
Defined in: node\_modules/.pnpm/@crawlee+types@3.16.0/node\_modules/@crawlee/types/browser.d.ts:19
|
|
18
18
|
|
|
19
19
|
Cookie domain.
|
|
20
20
|
|
|
@@ -24,7 +24,7 @@ Cookie domain.
|
|
|
24
24
|
|
|
25
25
|
> `optional` **expires**: `number`
|
|
26
26
|
|
|
27
|
-
Defined in: node\_modules/.pnpm/@crawlee+types@3.
|
|
27
|
+
Defined in: node\_modules/.pnpm/@crawlee+types@3.16.0/node\_modules/@crawlee/types/browser.d.ts:39
|
|
28
28
|
|
|
29
29
|
Cookie expiration date, session cookie if not set
|
|
30
30
|
|
|
@@ -34,7 +34,7 @@ Cookie expiration date, session cookie if not set
|
|
|
34
34
|
|
|
35
35
|
> `optional` **httpOnly**: `boolean`
|
|
36
36
|
|
|
37
|
-
Defined in: node\_modules/.pnpm/@crawlee+types@3.
|
|
37
|
+
Defined in: node\_modules/.pnpm/@crawlee+types@3.16.0/node\_modules/@crawlee/types/browser.d.ts:31
|
|
38
38
|
|
|
39
39
|
True if cookie is http-only.
|
|
40
40
|
|
|
@@ -44,7 +44,7 @@ True if cookie is http-only.
|
|
|
44
44
|
|
|
45
45
|
> **name**: `string`
|
|
46
46
|
|
|
47
|
-
Defined in: node\_modules/.pnpm/@crawlee+types@3.
|
|
47
|
+
Defined in: node\_modules/.pnpm/@crawlee+types@3.16.0/node\_modules/@crawlee/types/browser.d.ts:6
|
|
48
48
|
|
|
49
49
|
Cookie name.
|
|
50
50
|
|
|
@@ -54,7 +54,7 @@ Cookie name.
|
|
|
54
54
|
|
|
55
55
|
> `optional` **path**: `string`
|
|
56
56
|
|
|
57
|
-
Defined in: node\_modules/.pnpm/@crawlee+types@3.
|
|
57
|
+
Defined in: node\_modules/.pnpm/@crawlee+types@3.16.0/node\_modules/@crawlee/types/browser.d.ts:23
|
|
58
58
|
|
|
59
59
|
Cookie path.
|
|
60
60
|
|
|
@@ -64,7 +64,7 @@ Cookie path.
|
|
|
64
64
|
|
|
65
65
|
> `optional` **priority**: `"Low"` \| `"Medium"` \| `"High"`
|
|
66
66
|
|
|
67
|
-
Defined in: node\_modules/.pnpm/@crawlee+types@3.
|
|
67
|
+
Defined in: node\_modules/.pnpm/@crawlee+types@3.16.0/node\_modules/@crawlee/types/browser.d.ts:43
|
|
68
68
|
|
|
69
69
|
Cookie Priority.
|
|
70
70
|
|
|
@@ -74,7 +74,7 @@ Cookie Priority.
|
|
|
74
74
|
|
|
75
75
|
> `optional` **sameParty**: `boolean`
|
|
76
76
|
|
|
77
|
-
Defined in: node\_modules/.pnpm/@crawlee+types@3.
|
|
77
|
+
Defined in: node\_modules/.pnpm/@crawlee+types@3.16.0/node\_modules/@crawlee/types/browser.d.ts:47
|
|
78
78
|
|
|
79
79
|
True if cookie is SameParty.
|
|
80
80
|
|
|
@@ -84,7 +84,7 @@ True if cookie is SameParty.
|
|
|
84
84
|
|
|
85
85
|
> `optional` **sameSite**: `"Strict"` \| `"Lax"` \| `"None"`
|
|
86
86
|
|
|
87
|
-
Defined in: node\_modules/.pnpm/@crawlee+types@3.
|
|
87
|
+
Defined in: node\_modules/.pnpm/@crawlee+types@3.16.0/node\_modules/@crawlee/types/browser.d.ts:35
|
|
88
88
|
|
|
89
89
|
Cookie SameSite type.
|
|
90
90
|
|
|
@@ -94,7 +94,7 @@ Cookie SameSite type.
|
|
|
94
94
|
|
|
95
95
|
> `optional` **secure**: `boolean`
|
|
96
96
|
|
|
97
|
-
Defined in: node\_modules/.pnpm/@crawlee+types@3.
|
|
97
|
+
Defined in: node\_modules/.pnpm/@crawlee+types@3.16.0/node\_modules/@crawlee/types/browser.d.ts:27
|
|
98
98
|
|
|
99
99
|
True if cookie is secure.
|
|
100
100
|
|
|
@@ -104,7 +104,7 @@ True if cookie is secure.
|
|
|
104
104
|
|
|
105
105
|
> `optional` **sourcePort**: `number`
|
|
106
106
|
|
|
107
|
-
Defined in: node\_modules/.pnpm/@crawlee+types@3.
|
|
107
|
+
Defined in: node\_modules/.pnpm/@crawlee+types@3.16.0/node\_modules/@crawlee/types/browser.d.ts:57
|
|
108
108
|
|
|
109
109
|
Cookie source port. Valid values are `-1` or `1-65535`, `-1` indicates an unspecified port.
|
|
110
110
|
An unspecified port value allows protocol clients to emulate legacy cookie scope for the port.
|
|
@@ -116,7 +116,7 @@ This is a temporary ability and it will be removed in the future.
|
|
|
116
116
|
|
|
117
117
|
> `optional` **sourceScheme**: `"Unset"` \| `"NonSecure"` \| `"Secure"`
|
|
118
118
|
|
|
119
|
-
Defined in: node\_modules/.pnpm/@crawlee+types@3.
|
|
119
|
+
Defined in: node\_modules/.pnpm/@crawlee+types@3.16.0/node\_modules/@crawlee/types/browser.d.ts:51
|
|
120
120
|
|
|
121
121
|
Cookie source scheme type.
|
|
122
122
|
|
|
@@ -126,7 +126,7 @@ Cookie source scheme type.
|
|
|
126
126
|
|
|
127
127
|
> `optional` **url**: `string`
|
|
128
128
|
|
|
129
|
-
Defined in: node\_modules/.pnpm/@crawlee+types@3.
|
|
129
|
+
Defined in: node\_modules/.pnpm/@crawlee+types@3.16.0/node\_modules/@crawlee/types/browser.d.ts:15
|
|
130
130
|
|
|
131
131
|
The request-URI to associate with the setting of the cookie. This value can affect the
|
|
132
132
|
default domain, path, source port, and source scheme values of the created cookie.
|
|
@@ -137,6 +137,6 @@ default domain, path, source port, and source scheme values of the created cooki
|
|
|
137
137
|
|
|
138
138
|
> **value**: `string`
|
|
139
139
|
|
|
140
|
-
Defined in: node\_modules/.pnpm/@crawlee+types@3.
|
|
140
|
+
Defined in: node\_modules/.pnpm/@crawlee+types@3.16.0/node\_modules/@crawlee/types/browser.d.ts:10
|
|
141
141
|
|
|
142
142
|
Cookie value.
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: DispatchedEngineAction
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
9
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:259](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/engine/base.ts#L259)
|
|
10
10
|
|
|
11
11
|
Represents an action that has been dispatched and is awaiting execution in the active page context.
|
|
12
12
|
|
|
@@ -21,7 +21,7 @@ to handle promises while maintaining the page context validity window.
|
|
|
21
21
|
|
|
22
22
|
> **action**: [`FetchEngineAction`](../type-aliases/FetchEngineAction.md)
|
|
23
23
|
|
|
24
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
24
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:260](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/engine/base.ts#L260)
|
|
25
25
|
|
|
26
26
|
***
|
|
27
27
|
|
|
@@ -29,7 +29,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:230](https://github.com/isd
|
|
|
29
29
|
|
|
30
30
|
> **reject**: (`reason?`) => `void`
|
|
31
31
|
|
|
32
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
32
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:262](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/engine/base.ts#L262)
|
|
33
33
|
|
|
34
34
|
#### Parameters
|
|
35
35
|
|
|
@@ -47,7 +47,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:232](https://github.com/isd
|
|
|
47
47
|
|
|
48
48
|
> **resolve**: (`value?`) => `void`
|
|
49
49
|
|
|
50
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
50
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:261](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/engine/base.ts#L261)
|
|
51
51
|
|
|
52
52
|
#### Parameters
|
|
53
53
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: EvaluateActionOptions
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
9
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:179](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/engine/base.ts#L179)
|
|
10
10
|
|
|
11
11
|
Options for the [FetchEngine.evaluate](../classes/FetchEngine.md#evaluate) action, specifying the function to execute and its arguments.
|
|
12
12
|
|
|
@@ -51,7 +51,7 @@ automatically detect the change, trigger a navigation, and wait for the new page
|
|
|
51
51
|
|
|
52
52
|
> `optional` **args**: `any`
|
|
53
53
|
|
|
54
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
54
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:200](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/engine/base.ts#L200)
|
|
55
55
|
|
|
56
56
|
Data to pass to the function.
|
|
57
57
|
|
|
@@ -66,7 +66,7 @@ Recommended to use an array or object for multiple values.
|
|
|
66
66
|
|
|
67
67
|
> **fn**: `string` \| (...`args`) => `any`
|
|
68
68
|
|
|
69
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
69
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:192](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/engine/base.ts#L192)
|
|
70
70
|
|
|
71
71
|
The function or expression to execute.
|
|
72
72
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: ExtractActionProperties
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/web-fetcher/src/action/definitions/extract.ts:5](https://github.com/isdk/web-fetcher.js/blob/
|
|
9
|
+
Defined in: [packages/web-fetcher/src/action/definitions/extract.ts:5](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/action/definitions/extract.ts#L5)
|
|
10
10
|
|
|
11
11
|
## Extends
|
|
12
12
|
|
|
@@ -22,7 +22,7 @@ Defined in: [packages/web-fetcher/src/action/definitions/extract.ts:5](https://g
|
|
|
22
22
|
|
|
23
23
|
> `optional` **action**: `string` \| [`FetchAction`](../classes/FetchAction.md)
|
|
24
24
|
|
|
25
|
-
Defined in: [packages/web-fetcher/src/action/fetch-action.ts:49](https://github.com/isdk/web-fetcher.js/blob/
|
|
25
|
+
Defined in: [packages/web-fetcher/src/action/fetch-action.ts:49](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/action/fetch-action.ts#L49)
|
|
26
26
|
|
|
27
27
|
#### Inherited from
|
|
28
28
|
|
|
@@ -34,7 +34,7 @@ Defined in: [packages/web-fetcher/src/action/fetch-action.ts:49](https://github.
|
|
|
34
34
|
|
|
35
35
|
> `optional` **args**: `any`
|
|
36
36
|
|
|
37
|
-
Defined in: [packages/web-fetcher/src/action/fetch-action.ts:52](https://github.com/isdk/web-fetcher.js/blob/
|
|
37
|
+
Defined in: [packages/web-fetcher/src/action/fetch-action.ts:52](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/action/fetch-action.ts#L52)
|
|
38
38
|
|
|
39
39
|
#### Inherited from
|
|
40
40
|
|
|
@@ -46,7 +46,7 @@ Defined in: [packages/web-fetcher/src/action/fetch-action.ts:52](https://github.
|
|
|
46
46
|
|
|
47
47
|
> `optional` **failOnError**: `boolean`
|
|
48
48
|
|
|
49
|
-
Defined in: [packages/web-fetcher/src/action/fetch-action.ts:57](https://github.com/isdk/web-fetcher.js/blob/
|
|
49
|
+
Defined in: [packages/web-fetcher/src/action/fetch-action.ts:57](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/action/fetch-action.ts#L57)
|
|
50
50
|
|
|
51
51
|
#### Inherited from
|
|
52
52
|
|
|
@@ -58,7 +58,7 @@ Defined in: [packages/web-fetcher/src/action/fetch-action.ts:57](https://github.
|
|
|
58
58
|
|
|
59
59
|
> `optional` **failOnTimeout**: `boolean`
|
|
60
60
|
|
|
61
|
-
Defined in: [packages/web-fetcher/src/action/fetch-action.ts:59](https://github.com/isdk/web-fetcher.js/blob/
|
|
61
|
+
Defined in: [packages/web-fetcher/src/action/fetch-action.ts:59](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/action/fetch-action.ts#L59)
|
|
62
62
|
|
|
63
63
|
#### Inherited from
|
|
64
64
|
|
|
@@ -70,7 +70,7 @@ Defined in: [packages/web-fetcher/src/action/fetch-action.ts:59](https://github.
|
|
|
70
70
|
|
|
71
71
|
> `optional` **id**: `string`
|
|
72
72
|
|
|
73
|
-
Defined in: [packages/web-fetcher/src/action/fetch-action.ts:47](https://github.com/isdk/web-fetcher.js/blob/
|
|
73
|
+
Defined in: [packages/web-fetcher/src/action/fetch-action.ts:47](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/action/fetch-action.ts#L47)
|
|
74
74
|
|
|
75
75
|
#### Inherited from
|
|
76
76
|
|
|
@@ -82,7 +82,7 @@ Defined in: [packages/web-fetcher/src/action/fetch-action.ts:47](https://github.
|
|
|
82
82
|
|
|
83
83
|
> `optional` **index**: `number`
|
|
84
84
|
|
|
85
|
-
Defined in: [packages/web-fetcher/src/action/fetch-action.ts:50](https://github.com/isdk/web-fetcher.js/blob/
|
|
85
|
+
Defined in: [packages/web-fetcher/src/action/fetch-action.ts:50](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/action/fetch-action.ts#L50)
|
|
86
86
|
|
|
87
87
|
#### Inherited from
|
|
88
88
|
|
|
@@ -94,7 +94,7 @@ Defined in: [packages/web-fetcher/src/action/fetch-action.ts:50](https://github.
|
|
|
94
94
|
|
|
95
95
|
> `optional` **maxRetries**: `number`
|
|
96
96
|
|
|
97
|
-
Defined in: [packages/web-fetcher/src/action/fetch-action.ts:61](https://github.com/isdk/web-fetcher.js/blob/
|
|
97
|
+
Defined in: [packages/web-fetcher/src/action/fetch-action.ts:61](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/action/fetch-action.ts#L61)
|
|
98
98
|
|
|
99
99
|
#### Inherited from
|
|
100
100
|
|
|
@@ -106,7 +106,7 @@ Defined in: [packages/web-fetcher/src/action/fetch-action.ts:61](https://github.
|
|
|
106
106
|
|
|
107
107
|
> `optional` **name**: `string`
|
|
108
108
|
|
|
109
|
-
Defined in: [packages/web-fetcher/src/action/fetch-action.ts:48](https://github.com/isdk/web-fetcher.js/blob/
|
|
109
|
+
Defined in: [packages/web-fetcher/src/action/fetch-action.ts:48](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/action/fetch-action.ts#L48)
|
|
110
110
|
|
|
111
111
|
#### Inherited from
|
|
112
112
|
|
|
@@ -118,7 +118,7 @@ Defined in: [packages/web-fetcher/src/action/fetch-action.ts:48](https://github.
|
|
|
118
118
|
|
|
119
119
|
> **params**: `ExtractSchema`
|
|
120
120
|
|
|
121
|
-
Defined in: [packages/web-fetcher/src/action/definitions/extract.ts:6](https://github.com/isdk/web-fetcher.js/blob/
|
|
121
|
+
Defined in: [packages/web-fetcher/src/action/definitions/extract.ts:6](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/action/definitions/extract.ts#L6)
|
|
122
122
|
|
|
123
123
|
#### Overrides
|
|
124
124
|
|
|
@@ -130,7 +130,7 @@ Defined in: [packages/web-fetcher/src/action/definitions/extract.ts:6](https://g
|
|
|
130
130
|
|
|
131
131
|
> `optional` **storeAs**: `string`
|
|
132
132
|
|
|
133
|
-
Defined in: [packages/web-fetcher/src/action/fetch-action.ts:54](https://github.com/isdk/web-fetcher.js/blob/
|
|
133
|
+
Defined in: [packages/web-fetcher/src/action/fetch-action.ts:54](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/action/fetch-action.ts#L54)
|
|
134
134
|
|
|
135
135
|
#### Inherited from
|
|
136
136
|
|
|
@@ -142,7 +142,7 @@ Defined in: [packages/web-fetcher/src/action/fetch-action.ts:54](https://github.
|
|
|
142
142
|
|
|
143
143
|
> `optional` **timeoutMs**: `number`
|
|
144
144
|
|
|
145
|
-
Defined in: [packages/web-fetcher/src/action/fetch-action.ts:60](https://github.com/isdk/web-fetcher.js/blob/
|
|
145
|
+
Defined in: [packages/web-fetcher/src/action/fetch-action.ts:60](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/action/fetch-action.ts#L60)
|
|
146
146
|
|
|
147
147
|
#### Inherited from
|
|
148
148
|
|