@isdk/web-fetcher 0.3.2 → 0.3.3
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 +19 -0
- package/README.engine.cn.md +34 -6
- package/README.engine.md +29 -1
- package/README.md +21 -1
- package/dist/index.d.mts +1515 -1490
- package/dist/index.d.ts +1515 -1490
- package/dist/index.js +1 -1
- package/dist/index.mjs +1 -1
- package/docs/README.md +21 -1
- package/docs/_media/README.cn.md +19 -0
- package/docs/_media/README.engine.md +29 -1
- package/docs/classes/CheerioFetchEngine.md +95 -95
- package/docs/classes/ClickAction.md +29 -29
- package/docs/classes/EngineUpgradeError.md +335 -0
- package/docs/classes/EvaluateAction.md +29 -29
- package/docs/classes/ExtractAction.md +29 -29
- package/docs/classes/FetchAction.md +29 -29
- package/docs/classes/FetchEngine.md +93 -93
- package/docs/classes/FetchSession.md +14 -14
- package/docs/classes/FillAction.md +29 -29
- package/docs/classes/GetContentAction.md +29 -29
- package/docs/classes/GotoAction.md +29 -29
- package/docs/classes/KeyboardPressAction.md +29 -29
- package/docs/classes/KeyboardTypeAction.md +29 -29
- package/docs/classes/MouseClickAction.md +29 -29
- package/docs/classes/MouseMoveAction.md +29 -29
- package/docs/classes/MouseWheelAction.md +29 -29
- package/docs/classes/PauseAction.md +29 -29
- package/docs/classes/PlaywrightFetchEngine.md +101 -101
- package/docs/classes/ScrollIntoViewAction.md +29 -29
- package/docs/classes/SubmitAction.md +29 -29
- package/docs/classes/TrimAction.md +29 -29
- package/docs/classes/WaitForAction.md +29 -29
- 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 +1 -1
- package/docs/globals.md +3 -1
- package/docs/interfaces/BaseFetchActionProperties.md +13 -13
- package/docs/interfaces/BaseFetchCollectorActionProperties.md +17 -17
- package/docs/interfaces/BaseFetcherProperties.md +44 -28
- package/docs/interfaces/DispatchedEngineAction.md +4 -4
- package/docs/interfaces/EvaluateActionOptions.md +3 -3
- package/docs/interfaces/ExtractActionProperties.md +13 -13
- package/docs/interfaces/FetchActionMeta.md +73 -0
- package/docs/interfaces/FetchActionProperties.md +15 -19
- package/docs/interfaces/FetchActionResult.md +7 -7
- package/docs/interfaces/FetchContext.md +65 -41
- package/docs/interfaces/FetchEngineContext.md +57 -33
- 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 +55 -31
- package/docs/interfaces/FetcherOptions.md +55 -31
- package/docs/interfaces/GotoActionOptions.md +8 -8
- package/docs/interfaces/KeyboardPressParams.md +3 -3
- package/docs/interfaces/KeyboardTypeParams.md +3 -3
- package/docs/interfaces/MouseClickParams.md +6 -6
- package/docs/interfaces/MouseMoveParams.md +5 -5
- package/docs/interfaces/MouseWheelParams.md +7 -7
- package/docs/interfaces/PendingEngineRequest.md +3 -3
- package/docs/interfaces/ScrollIntoViewParams.md +2 -2
- 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/FetchActionInContext.md +38 -0
- 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/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 +1 -1
- package/docs/interfaces/FetchActionInContext.md +0 -190
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: GotoActionOptions
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:70](https://github.com/isdk/web-fetcher.js/blob/
|
|
9
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:70](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/engine/base.ts#L70)
|
|
10
10
|
|
|
11
11
|
Options for the [FetchEngine.goto](../classes/FetchEngine.md#goto), allowing configuration of HTTP method, payload, headers, and navigation behavior.
|
|
12
12
|
|
|
@@ -31,15 +31,15 @@ await engine.goto('https://example.com', {
|
|
|
31
31
|
|
|
32
32
|
> `optional` **headers**: `Record`\<`string`, `string`\>
|
|
33
33
|
|
|
34
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:82](https://github.com/isdk/web-fetcher.js/blob/
|
|
34
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:82](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/engine/base.ts#L82)
|
|
35
35
|
|
|
36
36
|
***
|
|
37
37
|
|
|
38
38
|
### method?
|
|
39
39
|
|
|
40
|
-
> `optional` **method**: `"GET"` \| `"
|
|
40
|
+
> `optional` **method**: `"GET"` \| `"POST"` \| `"PUT"` \| `"PATCH"` \| `"DELETE"` \| `"HEAD"` \| `"TRACE"` \| `"OPTIONS"` \| `"CONNECT"`
|
|
41
41
|
|
|
42
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:71](https://github.com/isdk/web-fetcher.js/blob/
|
|
42
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:71](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/engine/base.ts#L71)
|
|
43
43
|
|
|
44
44
|
***
|
|
45
45
|
|
|
@@ -47,7 +47,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:71](https://github.com/isdk
|
|
|
47
47
|
|
|
48
48
|
> `optional` **payload**: `any`
|
|
49
49
|
|
|
50
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:81](https://github.com/isdk/web-fetcher.js/blob/
|
|
50
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:81](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/engine/base.ts#L81)
|
|
51
51
|
|
|
52
52
|
***
|
|
53
53
|
|
|
@@ -55,7 +55,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:81](https://github.com/isdk
|
|
|
55
55
|
|
|
56
56
|
> `optional` **simulate**: `boolean`
|
|
57
57
|
|
|
58
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:85](https://github.com/isdk/web-fetcher.js/blob/
|
|
58
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:85](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/engine/base.ts#L85)
|
|
59
59
|
|
|
60
60
|
***
|
|
61
61
|
|
|
@@ -63,7 +63,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:85](https://github.com/isdk
|
|
|
63
63
|
|
|
64
64
|
> `optional` **timeoutMs**: `number`
|
|
65
65
|
|
|
66
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:84](https://github.com/isdk/web-fetcher.js/blob/
|
|
66
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:84](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/engine/base.ts#L84)
|
|
67
67
|
|
|
68
68
|
***
|
|
69
69
|
|
|
@@ -71,4 +71,4 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:84](https://github.com/isdk
|
|
|
71
71
|
|
|
72
72
|
> `optional` **waitUntil**: `"load"` \| `"domcontentloaded"` \| `"networkidle"` \| `"commit"`
|
|
73
73
|
|
|
74
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:83](https://github.com/isdk/web-fetcher.js/blob/
|
|
74
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:83](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/engine/base.ts#L83)
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: KeyboardPressParams
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/web-fetcher/src/action/definitions/keyboard.ts:27](https://github.com/isdk/web-fetcher.js/blob/
|
|
9
|
+
Defined in: [packages/web-fetcher/src/action/definitions/keyboard.ts:27](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/action/definitions/keyboard.ts#L27)
|
|
10
10
|
|
|
11
11
|
## Properties
|
|
12
12
|
|
|
@@ -14,7 +14,7 @@ Defined in: [packages/web-fetcher/src/action/definitions/keyboard.ts:27](https:/
|
|
|
14
14
|
|
|
15
15
|
> `optional` **delay**: `number`
|
|
16
16
|
|
|
17
|
-
Defined in: [packages/web-fetcher/src/action/definitions/keyboard.ts:29](https://github.com/isdk/web-fetcher.js/blob/
|
|
17
|
+
Defined in: [packages/web-fetcher/src/action/definitions/keyboard.ts:29](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/action/definitions/keyboard.ts#L29)
|
|
18
18
|
|
|
19
19
|
***
|
|
20
20
|
|
|
@@ -22,4 +22,4 @@ Defined in: [packages/web-fetcher/src/action/definitions/keyboard.ts:29](https:/
|
|
|
22
22
|
|
|
23
23
|
> **key**: `string`
|
|
24
24
|
|
|
25
|
-
Defined in: [packages/web-fetcher/src/action/definitions/keyboard.ts:28](https://github.com/isdk/web-fetcher.js/blob/
|
|
25
|
+
Defined in: [packages/web-fetcher/src/action/definitions/keyboard.ts:28](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/action/definitions/keyboard.ts#L28)
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: KeyboardTypeParams
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/web-fetcher/src/action/definitions/keyboard.ts:4](https://github.com/isdk/web-fetcher.js/blob/
|
|
9
|
+
Defined in: [packages/web-fetcher/src/action/definitions/keyboard.ts:4](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/action/definitions/keyboard.ts#L4)
|
|
10
10
|
|
|
11
11
|
## Properties
|
|
12
12
|
|
|
@@ -14,7 +14,7 @@ Defined in: [packages/web-fetcher/src/action/definitions/keyboard.ts:4](https://
|
|
|
14
14
|
|
|
15
15
|
> `optional` **delay**: `number`
|
|
16
16
|
|
|
17
|
-
Defined in: [packages/web-fetcher/src/action/definitions/keyboard.ts:6](https://github.com/isdk/web-fetcher.js/blob/
|
|
17
|
+
Defined in: [packages/web-fetcher/src/action/definitions/keyboard.ts:6](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/action/definitions/keyboard.ts#L6)
|
|
18
18
|
|
|
19
19
|
***
|
|
20
20
|
|
|
@@ -22,4 +22,4 @@ Defined in: [packages/web-fetcher/src/action/definitions/keyboard.ts:6](https://
|
|
|
22
22
|
|
|
23
23
|
> **text**: `string`
|
|
24
24
|
|
|
25
|
-
Defined in: [packages/web-fetcher/src/action/definitions/keyboard.ts:5](https://github.com/isdk/web-fetcher.js/blob/
|
|
25
|
+
Defined in: [packages/web-fetcher/src/action/definitions/keyboard.ts:5](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/action/definitions/keyboard.ts#L5)
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: MouseClickParams
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/web-fetcher/src/action/definitions/mouse.ts:28](https://github.com/isdk/web-fetcher.js/blob/
|
|
9
|
+
Defined in: [packages/web-fetcher/src/action/definitions/mouse.ts:28](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/action/definitions/mouse.ts#L28)
|
|
10
10
|
|
|
11
11
|
## Properties
|
|
12
12
|
|
|
@@ -14,7 +14,7 @@ Defined in: [packages/web-fetcher/src/action/definitions/mouse.ts:28](https://gi
|
|
|
14
14
|
|
|
15
15
|
> `optional` **button**: `"left"` \| `"right"` \| `"middle"`
|
|
16
16
|
|
|
17
|
-
Defined in: [packages/web-fetcher/src/action/definitions/mouse.ts:31](https://github.com/isdk/web-fetcher.js/blob/
|
|
17
|
+
Defined in: [packages/web-fetcher/src/action/definitions/mouse.ts:31](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/action/definitions/mouse.ts#L31)
|
|
18
18
|
|
|
19
19
|
***
|
|
20
20
|
|
|
@@ -22,7 +22,7 @@ Defined in: [packages/web-fetcher/src/action/definitions/mouse.ts:31](https://gi
|
|
|
22
22
|
|
|
23
23
|
> `optional` **clickCount**: `number`
|
|
24
24
|
|
|
25
|
-
Defined in: [packages/web-fetcher/src/action/definitions/mouse.ts:32](https://github.com/isdk/web-fetcher.js/blob/
|
|
25
|
+
Defined in: [packages/web-fetcher/src/action/definitions/mouse.ts:32](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/action/definitions/mouse.ts#L32)
|
|
26
26
|
|
|
27
27
|
***
|
|
28
28
|
|
|
@@ -30,7 +30,7 @@ Defined in: [packages/web-fetcher/src/action/definitions/mouse.ts:32](https://gi
|
|
|
30
30
|
|
|
31
31
|
> `optional` **delay**: `number`
|
|
32
32
|
|
|
33
|
-
Defined in: [packages/web-fetcher/src/action/definitions/mouse.ts:33](https://github.com/isdk/web-fetcher.js/blob/
|
|
33
|
+
Defined in: [packages/web-fetcher/src/action/definitions/mouse.ts:33](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/action/definitions/mouse.ts#L33)
|
|
34
34
|
|
|
35
35
|
***
|
|
36
36
|
|
|
@@ -38,7 +38,7 @@ Defined in: [packages/web-fetcher/src/action/definitions/mouse.ts:33](https://gi
|
|
|
38
38
|
|
|
39
39
|
> `optional` **x**: `number`
|
|
40
40
|
|
|
41
|
-
Defined in: [packages/web-fetcher/src/action/definitions/mouse.ts:29](https://github.com/isdk/web-fetcher.js/blob/
|
|
41
|
+
Defined in: [packages/web-fetcher/src/action/definitions/mouse.ts:29](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/action/definitions/mouse.ts#L29)
|
|
42
42
|
|
|
43
43
|
***
|
|
44
44
|
|
|
@@ -46,4 +46,4 @@ Defined in: [packages/web-fetcher/src/action/definitions/mouse.ts:29](https://gi
|
|
|
46
46
|
|
|
47
47
|
> `optional` **y**: `number`
|
|
48
48
|
|
|
49
|
-
Defined in: [packages/web-fetcher/src/action/definitions/mouse.ts:30](https://github.com/isdk/web-fetcher.js/blob/
|
|
49
|
+
Defined in: [packages/web-fetcher/src/action/definitions/mouse.ts:30](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/action/definitions/mouse.ts#L30)
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: MouseMoveParams
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/web-fetcher/src/action/definitions/mouse.ts:4](https://github.com/isdk/web-fetcher.js/blob/
|
|
9
|
+
Defined in: [packages/web-fetcher/src/action/definitions/mouse.ts:4](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/action/definitions/mouse.ts#L4)
|
|
10
10
|
|
|
11
11
|
## Properties
|
|
12
12
|
|
|
@@ -14,7 +14,7 @@ Defined in: [packages/web-fetcher/src/action/definitions/mouse.ts:4](https://git
|
|
|
14
14
|
|
|
15
15
|
> `optional` **selector**: `string`
|
|
16
16
|
|
|
17
|
-
Defined in: [packages/web-fetcher/src/action/definitions/mouse.ts:7](https://github.com/isdk/web-fetcher.js/blob/
|
|
17
|
+
Defined in: [packages/web-fetcher/src/action/definitions/mouse.ts:7](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/action/definitions/mouse.ts#L7)
|
|
18
18
|
|
|
19
19
|
***
|
|
20
20
|
|
|
@@ -22,7 +22,7 @@ Defined in: [packages/web-fetcher/src/action/definitions/mouse.ts:7](https://git
|
|
|
22
22
|
|
|
23
23
|
> `optional` **steps**: `number`
|
|
24
24
|
|
|
25
|
-
Defined in: [packages/web-fetcher/src/action/definitions/mouse.ts:8](https://github.com/isdk/web-fetcher.js/blob/
|
|
25
|
+
Defined in: [packages/web-fetcher/src/action/definitions/mouse.ts:8](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/action/definitions/mouse.ts#L8)
|
|
26
26
|
|
|
27
27
|
***
|
|
28
28
|
|
|
@@ -30,7 +30,7 @@ Defined in: [packages/web-fetcher/src/action/definitions/mouse.ts:8](https://git
|
|
|
30
30
|
|
|
31
31
|
> `optional` **x**: `number`
|
|
32
32
|
|
|
33
|
-
Defined in: [packages/web-fetcher/src/action/definitions/mouse.ts:5](https://github.com/isdk/web-fetcher.js/blob/
|
|
33
|
+
Defined in: [packages/web-fetcher/src/action/definitions/mouse.ts:5](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/action/definitions/mouse.ts#L5)
|
|
34
34
|
|
|
35
35
|
***
|
|
36
36
|
|
|
@@ -38,4 +38,4 @@ Defined in: [packages/web-fetcher/src/action/definitions/mouse.ts:5](https://git
|
|
|
38
38
|
|
|
39
39
|
> `optional` **y**: `number`
|
|
40
40
|
|
|
41
|
-
Defined in: [packages/web-fetcher/src/action/definitions/mouse.ts:6](https://github.com/isdk/web-fetcher.js/blob/
|
|
41
|
+
Defined in: [packages/web-fetcher/src/action/definitions/mouse.ts:6](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/action/definitions/mouse.ts#L6)
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: MouseWheelParams
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/web-fetcher/src/action/definitions/mouse.ts:74](https://github.com/isdk/web-fetcher.js/blob/
|
|
9
|
+
Defined in: [packages/web-fetcher/src/action/definitions/mouse.ts:74](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/action/definitions/mouse.ts#L74)
|
|
10
10
|
|
|
11
11
|
## Properties
|
|
12
12
|
|
|
@@ -14,7 +14,7 @@ Defined in: [packages/web-fetcher/src/action/definitions/mouse.ts:74](https://gi
|
|
|
14
14
|
|
|
15
15
|
> `optional` **deltaX**: `number`
|
|
16
16
|
|
|
17
|
-
Defined in: [packages/web-fetcher/src/action/definitions/mouse.ts:90](https://github.com/isdk/web-fetcher.js/blob/
|
|
17
|
+
Defined in: [packages/web-fetcher/src/action/definitions/mouse.ts:90](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/action/definitions/mouse.ts#L90)
|
|
18
18
|
|
|
19
19
|
Horizontal scroll delta.
|
|
20
20
|
|
|
@@ -24,7 +24,7 @@ Horizontal scroll delta.
|
|
|
24
24
|
|
|
25
25
|
> `optional` **deltaY**: `number`
|
|
26
26
|
|
|
27
|
-
Defined in: [packages/web-fetcher/src/action/definitions/mouse.ts:94](https://github.com/isdk/web-fetcher.js/blob/
|
|
27
|
+
Defined in: [packages/web-fetcher/src/action/definitions/mouse.ts:94](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/action/definitions/mouse.ts#L94)
|
|
28
28
|
|
|
29
29
|
Vertical scroll delta.
|
|
30
30
|
|
|
@@ -34,7 +34,7 @@ Vertical scroll delta.
|
|
|
34
34
|
|
|
35
35
|
> `optional` **selector**: `string`
|
|
36
36
|
|
|
37
|
-
Defined in: [packages/web-fetcher/src/action/definitions/mouse.ts:86](https://github.com/isdk/web-fetcher.js/blob/
|
|
37
|
+
Defined in: [packages/web-fetcher/src/action/definitions/mouse.ts:86](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/action/definitions/mouse.ts#L86)
|
|
38
38
|
|
|
39
39
|
Selector for the element to scroll. If provided, mouse will move to this element before scrolling.
|
|
40
40
|
|
|
@@ -44,7 +44,7 @@ Selector for the element to scroll. If provided, mouse will move to this element
|
|
|
44
44
|
|
|
45
45
|
> `optional` **steps**: `number`
|
|
46
46
|
|
|
47
|
-
Defined in: [packages/web-fetcher/src/action/definitions/mouse.ts:98](https://github.com/isdk/web-fetcher.js/blob/
|
|
47
|
+
Defined in: [packages/web-fetcher/src/action/definitions/mouse.ts:98](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/action/definitions/mouse.ts#L98)
|
|
48
48
|
|
|
49
49
|
Number of steps to split the scroll into for simulating human-like behavior.
|
|
50
50
|
|
|
@@ -54,7 +54,7 @@ Number of steps to split the scroll into for simulating human-like behavior.
|
|
|
54
54
|
|
|
55
55
|
> `optional` **x**: `number`
|
|
56
56
|
|
|
57
|
-
Defined in: [packages/web-fetcher/src/action/definitions/mouse.ts:78](https://github.com/isdk/web-fetcher.js/blob/
|
|
57
|
+
Defined in: [packages/web-fetcher/src/action/definitions/mouse.ts:78](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/action/definitions/mouse.ts#L78)
|
|
58
58
|
|
|
59
59
|
Target X coordinate for the mouse wheel event.
|
|
60
60
|
|
|
@@ -64,6 +64,6 @@ Target X coordinate for the mouse wheel event.
|
|
|
64
64
|
|
|
65
65
|
> `optional` **y**: `number`
|
|
66
66
|
|
|
67
|
-
Defined in: [packages/web-fetcher/src/action/definitions/mouse.ts:82](https://github.com/isdk/web-fetcher.js/blob/
|
|
67
|
+
Defined in: [packages/web-fetcher/src/action/definitions/mouse.ts:82](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/action/definitions/mouse.ts#L82)
|
|
68
68
|
|
|
69
69
|
Target Y coordinate for the mouse wheel event.
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: PendingEngineRequest
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:271](https://github.com/isdk/web-fetcher.js/blob/
|
|
9
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:271](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/engine/base.ts#L271)
|
|
10
10
|
|
|
11
11
|
Represents a pending navigation request awaiting resolution.
|
|
12
12
|
|
|
@@ -20,7 +20,7 @@ Tracks navigation requests that have been queued but not yet processed by the re
|
|
|
20
20
|
|
|
21
21
|
> **reject**: (`reason?`) => `void`
|
|
22
22
|
|
|
23
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:273](https://github.com/isdk/web-fetcher.js/blob/
|
|
23
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:273](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/engine/base.ts#L273)
|
|
24
24
|
|
|
25
25
|
#### Parameters
|
|
26
26
|
|
|
@@ -38,7 +38,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:273](https://github.com/isd
|
|
|
38
38
|
|
|
39
39
|
> **resolve**: (`value`) => `void`
|
|
40
40
|
|
|
41
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:272](https://github.com/isdk/web-fetcher.js/blob/
|
|
41
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:272](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/engine/base.ts#L272)
|
|
42
42
|
|
|
43
43
|
#### Parameters
|
|
44
44
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: ScrollIntoViewParams
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/web-fetcher/src/action/definitions/mouse.ts:53](https://github.com/isdk/web-fetcher.js/blob/
|
|
9
|
+
Defined in: [packages/web-fetcher/src/action/definitions/mouse.ts:53](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/action/definitions/mouse.ts#L53)
|
|
10
10
|
|
|
11
11
|
## Properties
|
|
12
12
|
|
|
@@ -14,4 +14,4 @@ Defined in: [packages/web-fetcher/src/action/definitions/mouse.ts:53](https://gi
|
|
|
14
14
|
|
|
15
15
|
> **selector**: `string`
|
|
16
16
|
|
|
17
|
-
Defined in: [packages/web-fetcher/src/action/definitions/mouse.ts:54](https://github.com/isdk/web-fetcher.js/blob/
|
|
17
|
+
Defined in: [packages/web-fetcher/src/action/definitions/mouse.ts:54](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/action/definitions/mouse.ts#L54)
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: StorageOptions
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
9
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:121](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L121)
|
|
10
10
|
|
|
11
11
|
Storage configuration options for the fetch engine.
|
|
12
12
|
|
|
@@ -20,7 +20,7 @@ Controls how Crawlee's internal storage (RequestQueue, KeyValueStore, SessionPoo
|
|
|
20
20
|
|
|
21
21
|
> `optional` **config**: `Record`\<`string`, `any`\>
|
|
22
22
|
|
|
23
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
23
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:143](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L143)
|
|
24
24
|
|
|
25
25
|
Additional Crawlee configuration options.
|
|
26
26
|
Allows fine-grained control over the underlying Crawlee instance.
|
|
@@ -31,7 +31,7 @@ Allows fine-grained control over the underlying Crawlee instance.
|
|
|
31
31
|
|
|
32
32
|
> `optional` **id**: `string`
|
|
33
33
|
|
|
34
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
34
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:127](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L127)
|
|
35
35
|
|
|
36
36
|
Custom identifier for the storage.
|
|
37
37
|
If provided, multiple sessions can share the same storage by using the same ID.
|
|
@@ -43,7 +43,7 @@ If not provided, a unique session ID is used (strong isolation).
|
|
|
43
43
|
|
|
44
44
|
> `optional` **persist**: `boolean`
|
|
45
45
|
|
|
46
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
46
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:133](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L133)
|
|
47
47
|
|
|
48
48
|
Whether to persist storage to disk.
|
|
49
49
|
If true, uses Crawlee's disk persistence. If false, data might be stored in memory or temporary directory.
|
|
@@ -55,7 +55,7 @@ Corresponds to Crawlee's `persistStorage` configuration.
|
|
|
55
55
|
|
|
56
56
|
> `optional` **purge**: `boolean`
|
|
57
57
|
|
|
58
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
58
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:138](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L138)
|
|
59
59
|
|
|
60
60
|
Whether to delete the storage (RequestQueue and KeyValueStore) when the session is closed.
|
|
61
61
|
Defaults to true. Set to false if you want to keep data for future reuse with the same `id`.
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: SubmitActionOptions
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:107](https://github.com/isdk/web-fetcher.js/blob/
|
|
9
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:107](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/engine/base.ts#L107)
|
|
10
10
|
|
|
11
11
|
Options for the [FetchEngine.submit](../classes/FetchEngine.md#submit) action, configuring form submission behavior.
|
|
12
12
|
|
|
@@ -20,4 +20,4 @@ Specifies encoding type for form submissions, particularly relevant for JSON-bas
|
|
|
20
20
|
|
|
21
21
|
> `optional` **enctype**: `"application/x-www-form-urlencoded"` \| `"application/json"` \| `"multipart/form-data"`
|
|
22
22
|
|
|
23
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:108](https://github.com/isdk/web-fetcher.js/blob/
|
|
23
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:108](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/engine/base.ts#L108)
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: TrimActionOptions
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:129](https://github.com/isdk/web-fetcher.js/blob/
|
|
9
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:129](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/engine/base.ts#L129)
|
|
10
10
|
|
|
11
11
|
Options for the [FetchEngine.trim](../classes/FetchEngine.md#trim) action, specifying which elements to remove from the DOM.
|
|
12
12
|
|
|
@@ -16,7 +16,7 @@ Options for the [FetchEngine.trim](../classes/FetchEngine.md#trim) action, speci
|
|
|
16
16
|
|
|
17
17
|
> `optional` **presets**: [`TrimPreset`](../type-aliases/TrimPreset.md) \| [`TrimPreset`](../type-aliases/TrimPreset.md)[]
|
|
18
18
|
|
|
19
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:131](https://github.com/isdk/web-fetcher.js/blob/
|
|
19
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:131](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/engine/base.ts#L131)
|
|
20
20
|
|
|
21
21
|
***
|
|
22
22
|
|
|
@@ -24,4 +24,4 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:131](https://github.com/isd
|
|
|
24
24
|
|
|
25
25
|
> `optional` **selectors**: `string` \| `string`[]
|
|
26
26
|
|
|
27
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:130](https://github.com/isdk/web-fetcher.js/blob/
|
|
27
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:130](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/engine/base.ts#L130)
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: WaitForActionOptions
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:94](https://github.com/isdk/web-fetcher.js/blob/
|
|
9
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:94](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/engine/base.ts#L94)
|
|
10
10
|
|
|
11
11
|
Options for the [FetchEngine.waitFor](../classes/FetchEngine.md#waitfor) action, specifying conditions to wait for before continuing.
|
|
12
12
|
|
|
@@ -20,7 +20,7 @@ Controls timing behavior for interactions, allowing waiting for elements, time i
|
|
|
20
20
|
|
|
21
21
|
> `optional` **failOnTimeout**: `boolean`
|
|
22
22
|
|
|
23
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:98](https://github.com/isdk/web-fetcher.js/blob/
|
|
23
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:98](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/engine/base.ts#L98)
|
|
24
24
|
|
|
25
25
|
***
|
|
26
26
|
|
|
@@ -28,7 +28,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:98](https://github.com/isdk
|
|
|
28
28
|
|
|
29
29
|
> `optional` **ms**: `number`
|
|
30
30
|
|
|
31
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:95](https://github.com/isdk/web-fetcher.js/blob/
|
|
31
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:95](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/engine/base.ts#L95)
|
|
32
32
|
|
|
33
33
|
***
|
|
34
34
|
|
|
@@ -36,7 +36,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:95](https://github.com/isdk
|
|
|
36
36
|
|
|
37
37
|
> `optional` **networkIdle**: `boolean`
|
|
38
38
|
|
|
39
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:97](https://github.com/isdk/web-fetcher.js/blob/
|
|
39
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:97](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/engine/base.ts#L97)
|
|
40
40
|
|
|
41
41
|
***
|
|
42
42
|
|
|
@@ -44,4 +44,4 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:97](https://github.com/isdk
|
|
|
44
44
|
|
|
45
45
|
> `optional` **selector**: `string`
|
|
46
46
|
|
|
47
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:96](https://github.com/isdk/web-fetcher.js/blob/
|
|
47
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:96](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/engine/base.ts#L96)
|
|
@@ -8,4 +8,4 @@
|
|
|
8
8
|
|
|
9
9
|
> **BaseFetchActionOptions** = `RequireAtLeastOne`\<[`BaseFetchActionProperties`](../interfaces/BaseFetchActionProperties.md), `"id"` \| `"name"` \| `"action"`\>
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/web-fetcher/src/
|
|
11
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:64](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L64)
|
|
@@ -8,4 +8,4 @@
|
|
|
8
8
|
|
|
9
9
|
> **BaseFetchCollectorOptions** = `RequireAtLeastOne`\<[`BaseFetchCollectorActionProperties`](../interfaces/BaseFetchCollectorActionProperties.md), `"id"` \| `"name"` \| `"action"`\>
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/web-fetcher/src/
|
|
11
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:81](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L81)
|
|
@@ -8,4 +8,4 @@
|
|
|
8
8
|
|
|
9
9
|
> **BrowserEngine** = `"playwright"` \| `"puppeteer"`
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
11
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:104](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L104)
|
|
@@ -8,4 +8,4 @@
|
|
|
8
8
|
|
|
9
9
|
> **FetchActionCapabilities** = `{ [mode in FetchEngineType]?: FetchActionCapabilityMode }`
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/web-fetcher/src/action/fetch-action.ts:
|
|
11
|
+
Defined in: [packages/web-fetcher/src/action/fetch-action.ts:21](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/action/fetch-action.ts#L21)
|
|
@@ -8,4 +8,4 @@
|
|
|
8
8
|
|
|
9
9
|
> **FetchActionCapabilityMode** = `"native"` \| `"simulate"` \| `"noop"`
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/web-fetcher/src/
|
|
11
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:23](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L23)
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
[**@isdk/web-fetcher**](../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@isdk/web-fetcher](../globals.md) / FetchActionInContext
|
|
6
|
+
|
|
7
|
+
# Type Alias: FetchActionInContext
|
|
8
|
+
|
|
9
|
+
> **FetchActionInContext** = [`FetchActionOptions`](FetchActionOptions.md) & `object`
|
|
10
|
+
|
|
11
|
+
Defined in: [packages/web-fetcher/src/core/context.ts:17](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/context.ts#L17)
|
|
12
|
+
|
|
13
|
+
Represents the state of an action being executed within a context.
|
|
14
|
+
|
|
15
|
+
## Type Declaration
|
|
16
|
+
|
|
17
|
+
### depth?
|
|
18
|
+
|
|
19
|
+
> `optional` **depth**: `number`
|
|
20
|
+
|
|
21
|
+
The nesting depth of the action. Top-level actions (executed directly by the session) have a depth of 0.
|
|
22
|
+
|
|
23
|
+
### error?
|
|
24
|
+
|
|
25
|
+
> `optional` **error**: `Error`
|
|
26
|
+
|
|
27
|
+
Error encountered during action execution, if any.
|
|
28
|
+
|
|
29
|
+
### index?
|
|
30
|
+
|
|
31
|
+
> `optional` **index**: `number`
|
|
32
|
+
|
|
33
|
+
The 0-based index of the action in the execution sequence.
|
|
34
|
+
|
|
35
|
+
## Remarks
|
|
36
|
+
|
|
37
|
+
Extends the basic action properties with runtime metadata like execution index,
|
|
38
|
+
nesting depth, and any errors encountered during execution.
|
|
@@ -8,4 +8,4 @@
|
|
|
8
8
|
|
|
9
9
|
> **FetchActionOptions** = `RequireAtLeastOne`\<[`FetchActionProperties`](../interfaces/FetchActionProperties.md), `"id"` \| `"name"` \| `"action"`\>
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/web-fetcher/src/
|
|
11
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:90](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L90)
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **FetchEngineAction** = \{ `selector`: `string`; `type`: `"click"`; \} \| \{ `selector`: `string`; `type`: `"fill"`; `value`: `string`; \} \| \{ `params`: \{ `selector?`: `string`; `steps?`: `number`; `x?`: `number`; `y?`: `number`; \}; `type`: `"mouseMove"`; \} \| \{ `params`: \{ `button?`: `"left"` \| `"right"` \| `"middle"`; `clickCount?`: `number`; `delay?`: `number`; `steps?`: `number`; `x?`: `number`; `y?`: `number`; \}; `type`: `"mouseClick"`; \} \| \{ `params`: \{ `deltaX?`: `number`; `deltaY?`: `number`; `selector?`: `string`; `steps?`: `number`; `x?`: `number`; `y?`: `number`; \}; `type`: `"mouseWheel"`; \} \| \{ `params`: \{ `delay?`: `number`; `text`: `string`; \}; `type`: `"keyboardType"`; \} \| \{ `params`: \{ `delay?`: `number`; `key`: `string`; \}; `type`: `"keyboardPress"`; \} \| \{ `params`: \{ `selector`: `string`; \}; `type`: `"scrollIntoView"`; \} \| \{ `options?`: [`WaitForActionOptions`](../interfaces/WaitForActionOptions.md); `type`: `"waitFor"`; \} \| \{ `options?`: [`SubmitActionOptions`](../interfaces/SubmitActionOptions.md); `selector?`: `any`; `type`: `"submit"`; \} \| \{ `type`: `"getContent"`; \} \| \{ `opts?`: [`GotoActionOptions`](../interfaces/GotoActionOptions.md); `type`: `"navigate"`; `url`: `string`; \} \| \{ `schema`: `ExtractSchema`; `type`: `"extract"`; \} \| \{ `message?`: `string`; `type`: `"pause"`; \} \| \{ `options`: [`TrimActionOptions`](../interfaces/TrimActionOptions.md); `type`: `"trim"`; \} \| \{ `params`: [`EvaluateActionOptions`](../interfaces/EvaluateActionOptions.md); `type`: `"evaluate"`; \} \| \{ `type`: `"dispose"`; \}
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:210](https://github.com/isdk/web-fetcher.js/blob/
|
|
11
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:210](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/engine/base.ts#L210)
|
|
12
12
|
|
|
13
13
|
Union type representing all possible engine actions that can be dispatched.
|
|
14
14
|
|
|
@@ -8,4 +8,4 @@
|
|
|
8
8
|
|
|
9
9
|
> **FetchEngineType** = `"http"` \| `"browser"`
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
11
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:103](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L103)
|
|
@@ -8,4 +8,4 @@
|
|
|
8
8
|
|
|
9
9
|
> **FetchReturnType** = `"response"` \| `"context"` \| `"outputs"` \| `"any"` \| `"none"`
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/web-fetcher/src/core/fetch-return-type.ts:
|
|
11
|
+
Defined in: [packages/web-fetcher/src/core/fetch-return-type.ts:4](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/fetch-return-type.ts#L4)
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **FetchReturnTypeFor**\<`R`\> = `R` *extends* keyof [`FetchReturnTypeRegistry`](../interfaces/FetchReturnTypeRegistry.md) ? [`FetchReturnTypeRegistry`](../interfaces/FetchReturnTypeRegistry.md)\[`R`\] : `never`
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/web-fetcher/src/core/fetch-return-type.ts:
|
|
11
|
+
Defined in: [packages/web-fetcher/src/core/fetch-return-type.ts:26](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/fetch-return-type.ts#L26)
|
|
12
12
|
|
|
13
13
|
## Type Parameters
|
|
14
14
|
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **OnFetchPauseCallback** = (`options`) => `Promise`\<`void`\>
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
11
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:226](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L226)
|
|
12
12
|
|
|
13
13
|
## Parameters
|
|
14
14
|
|
|
@@ -8,4 +8,4 @@
|
|
|
8
8
|
|
|
9
9
|
> **ResourceType** = `"image"` \| `"stylesheet"` \| `"font"` \| `"script"` \| `"media"` \| `string`
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
11
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:107](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L107)
|
|
@@ -8,6 +8,6 @@
|
|
|
8
8
|
|
|
9
9
|
> **TrimPreset** = `"scripts"` \| `"styles"` \| `"svgs"` \| `"images"` \| `"comments"` \| `"hidden"` \| `"all"`
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:117](https://github.com/isdk/web-fetcher.js/blob/
|
|
11
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:117](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/engine/base.ts#L117)
|
|
12
12
|
|
|
13
13
|
Predefined cleanup groups for the [FetchEngine.trim](../classes/FetchEngine.md#trim) action.
|
|
@@ -8,4 +8,4 @@
|
|
|
8
8
|
|
|
9
9
|
> `const` **DefaultFetcherProperties**: [`BaseFetcherProperties`](../interfaces/BaseFetcherProperties.md)
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
11
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:268](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L268)
|
|
@@ -8,4 +8,4 @@
|
|
|
8
8
|
|
|
9
9
|
> `const` **FetcherOptionKeys**: `string`[]
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
11
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:306](https://github.com/isdk/web-fetcher.js/blob/4cd06ed0bedeb2fc8c9242e05d3d068c125ab8a8/src/core/types.ts#L306)
|