@isdk/web-fetcher 0.2.0 → 0.2.1

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 (53) hide show
  1. package/README.reddit.md +248 -0
  2. package/README.v2ex.md +109 -0
  3. package/dist/index.js +1 -1
  4. package/dist/index.mjs +1 -1
  5. package/docs/classes/CheerioFetchEngine.md +56 -56
  6. package/docs/classes/ClickAction.md +23 -23
  7. package/docs/classes/ExtractAction.md +23 -23
  8. package/docs/classes/FetchAction.md +23 -23
  9. package/docs/classes/FetchEngine.md +56 -56
  10. package/docs/classes/FetchSession.md +8 -8
  11. package/docs/classes/FillAction.md +23 -23
  12. package/docs/classes/GetContentAction.md +23 -23
  13. package/docs/classes/GotoAction.md +23 -23
  14. package/docs/classes/PauseAction.md +23 -23
  15. package/docs/classes/PlaywrightFetchEngine.md +56 -56
  16. package/docs/classes/SubmitAction.md +23 -23
  17. package/docs/classes/WaitForAction.md +23 -23
  18. package/docs/classes/WebFetcher.md +5 -5
  19. package/docs/enumerations/FetchActionResultStatus.md +4 -4
  20. package/docs/functions/fetchWeb.md +2 -2
  21. package/docs/interfaces/BaseFetchActionProperties.md +9 -9
  22. package/docs/interfaces/BaseFetchCollectorActionProperties.md +13 -13
  23. package/docs/interfaces/BaseFetcherProperties.md +21 -21
  24. package/docs/interfaces/DispatchedEngineAction.md +4 -4
  25. package/docs/interfaces/ExtractActionProperties.md +9 -9
  26. package/docs/interfaces/FetchActionInContext.md +13 -13
  27. package/docs/interfaces/FetchActionProperties.md +10 -10
  28. package/docs/interfaces/FetchActionResult.md +6 -6
  29. package/docs/interfaces/FetchContext.md +31 -31
  30. package/docs/interfaces/FetchEngineContext.md +26 -26
  31. package/docs/interfaces/FetchMetadata.md +5 -5
  32. package/docs/interfaces/FetchResponse.md +13 -13
  33. package/docs/interfaces/FetchReturnTypeRegistry.md +7 -7
  34. package/docs/interfaces/FetchSite.md +24 -24
  35. package/docs/interfaces/FetcherOptions.md +23 -23
  36. package/docs/interfaces/GotoActionOptions.md +6 -6
  37. package/docs/interfaces/PendingEngineRequest.md +3 -3
  38. package/docs/interfaces/SubmitActionOptions.md +2 -2
  39. package/docs/interfaces/WaitForActionOptions.md +4 -4
  40. package/docs/type-aliases/BaseFetchActionOptions.md +1 -1
  41. package/docs/type-aliases/BaseFetchCollectorOptions.md +1 -1
  42. package/docs/type-aliases/BrowserEngine.md +1 -1
  43. package/docs/type-aliases/FetchActionCapabilities.md +1 -1
  44. package/docs/type-aliases/FetchActionCapabilityMode.md +1 -1
  45. package/docs/type-aliases/FetchActionOptions.md +1 -1
  46. package/docs/type-aliases/FetchEngineAction.md +1 -1
  47. package/docs/type-aliases/FetchEngineType.md +1 -1
  48. package/docs/type-aliases/FetchReturnType.md +1 -1
  49. package/docs/type-aliases/FetchReturnTypeFor.md +1 -1
  50. package/docs/type-aliases/OnFetchPauseCallback.md +1 -1
  51. package/docs/type-aliases/ResourceType.md +1 -1
  52. package/docs/variables/DefaultFetcherProperties.md +1 -1
  53. package/package.json +1 -1
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: PendingEngineRequest
8
8
 
9
- Defined in: [packages/web-fetcher/src/engine/base.ts:108](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/engine/base.ts#L108)
9
+ Defined in: [packages/web-fetcher/src/engine/base.ts:108](https://github.com/isdk/web-fetcher.js/blob/db611cb04a516e006310c5e147f90026827d6d80/src/engine/base.ts#L108)
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:110](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/engine/base.ts#L110)
23
+ Defined in: [packages/web-fetcher/src/engine/base.ts:110](https://github.com/isdk/web-fetcher.js/blob/db611cb04a516e006310c5e147f90026827d6d80/src/engine/base.ts#L110)
24
24
 
25
25
  #### Parameters
26
26
 
@@ -38,7 +38,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:110](https://github.com/isd
38
38
 
39
39
  > **resolve**: (`value`) => `void`
40
40
 
41
- Defined in: [packages/web-fetcher/src/engine/base.ts:109](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/engine/base.ts#L109)
41
+ Defined in: [packages/web-fetcher/src/engine/base.ts:109](https://github.com/isdk/web-fetcher.js/blob/db611cb04a516e006310c5e147f90026827d6d80/src/engine/base.ts#L109)
42
42
 
43
43
  #### Parameters
44
44
 
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: SubmitActionOptions
8
8
 
9
- Defined in: [packages/web-fetcher/src/engine/base.ts:67](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/engine/base.ts#L67)
9
+ Defined in: [packages/web-fetcher/src/engine/base.ts:67](https://github.com/isdk/web-fetcher.js/blob/db611cb04a516e006310c5e147f90026827d6d80/src/engine/base.ts#L67)
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:68](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/engine/base.ts#L68)
23
+ Defined in: [packages/web-fetcher/src/engine/base.ts:68](https://github.com/isdk/web-fetcher.js/blob/db611cb04a516e006310c5e147f90026827d6d80/src/engine/base.ts#L68)
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: WaitForActionOptions
8
8
 
9
- Defined in: [packages/web-fetcher/src/engine/base.ts:55](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/engine/base.ts#L55)
9
+ Defined in: [packages/web-fetcher/src/engine/base.ts:55](https://github.com/isdk/web-fetcher.js/blob/db611cb04a516e006310c5e147f90026827d6d80/src/engine/base.ts#L55)
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` **ms**: `number`
22
22
 
23
- Defined in: [packages/web-fetcher/src/engine/base.ts:56](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/engine/base.ts#L56)
23
+ Defined in: [packages/web-fetcher/src/engine/base.ts:56](https://github.com/isdk/web-fetcher.js/blob/db611cb04a516e006310c5e147f90026827d6d80/src/engine/base.ts#L56)
24
24
 
25
25
  ***
26
26
 
@@ -28,7 +28,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:56](https://github.com/isdk
28
28
 
29
29
  > `optional` **networkIdle**: `boolean`
30
30
 
31
- Defined in: [packages/web-fetcher/src/engine/base.ts:58](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/engine/base.ts#L58)
31
+ Defined in: [packages/web-fetcher/src/engine/base.ts:58](https://github.com/isdk/web-fetcher.js/blob/db611cb04a516e006310c5e147f90026827d6d80/src/engine/base.ts#L58)
32
32
 
33
33
  ***
34
34
 
@@ -36,4 +36,4 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:58](https://github.com/isdk
36
36
 
37
37
  > `optional` **selector**: `string`
38
38
 
39
- Defined in: [packages/web-fetcher/src/engine/base.ts:57](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/engine/base.ts#L57)
39
+ Defined in: [packages/web-fetcher/src/engine/base.ts:57](https://github.com/isdk/web-fetcher.js/blob/db611cb04a516e006310c5e147f90026827d6d80/src/engine/base.ts#L57)
@@ -8,4 +8,4 @@
8
8
 
9
9
  > **BaseFetchActionOptions** = `RequireAtLeastOne`\<[`BaseFetchActionProperties`](../interfaces/BaseFetchActionProperties.md), `"id"` \| `"name"`\>
10
10
 
11
- Defined in: [packages/web-fetcher/src/action/fetch-action.ts:59](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/action/fetch-action.ts#L59)
11
+ Defined in: [packages/web-fetcher/src/action/fetch-action.ts:59](https://github.com/isdk/web-fetcher.js/blob/db611cb04a516e006310c5e147f90026827d6d80/src/action/fetch-action.ts#L59)
@@ -8,4 +8,4 @@
8
8
 
9
9
  > **BaseFetchCollectorOptions** = `RequireAtLeastOne`\<[`BaseFetchCollectorActionProperties`](../interfaces/BaseFetchCollectorActionProperties.md), `"id"` \| `"name"`\>
10
10
 
11
- Defined in: [packages/web-fetcher/src/action/fetch-action.ts:72](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/action/fetch-action.ts#L72)
11
+ Defined in: [packages/web-fetcher/src/action/fetch-action.ts:72](https://github.com/isdk/web-fetcher.js/blob/db611cb04a516e006310c5e147f90026827d6d80/src/action/fetch-action.ts#L72)
@@ -8,4 +8,4 @@
8
8
 
9
9
  > **BrowserEngine** = `"playwright"` \| `"puppeteer"`
10
10
 
11
- Defined in: [packages/web-fetcher/src/core/types.ts:21](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/core/types.ts#L21)
11
+ Defined in: [packages/web-fetcher/src/core/types.ts:21](https://github.com/isdk/web-fetcher.js/blob/db611cb04a516e006310c5e147f90026827d6d80/src/core/types.ts#L21)
@@ -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:80](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/action/fetch-action.ts#L80)
11
+ Defined in: [packages/web-fetcher/src/action/fetch-action.ts:80](https://github.com/isdk/web-fetcher.js/blob/db611cb04a516e006310c5e147f90026827d6d80/src/action/fetch-action.ts#L80)
@@ -8,4 +8,4 @@
8
8
 
9
9
  > **FetchActionCapabilityMode** = `"native"` \| `"simulate"` \| `"noop"`
10
10
 
11
- Defined in: [packages/web-fetcher/src/action/fetch-action.ts:23](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/action/fetch-action.ts#L23)
11
+ Defined in: [packages/web-fetcher/src/action/fetch-action.ts:23](https://github.com/isdk/web-fetcher.js/blob/db611cb04a516e006310c5e147f90026827d6d80/src/action/fetch-action.ts#L23)
@@ -8,4 +8,4 @@
8
8
 
9
9
  > **FetchActionOptions** = `RequireAtLeastOne`\<[`FetchActionProperties`](../interfaces/FetchActionProperties.md), `"id"` \| `"name"`\>
10
10
 
11
- Defined in: [packages/web-fetcher/src/action/fetch-action.ts:78](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/action/fetch-action.ts#L78)
11
+ Defined in: [packages/web-fetcher/src/action/fetch-action.ts:78](https://github.com/isdk/web-fetcher.js/blob/db611cb04a516e006310c5e147f90026827d6d80/src/action/fetch-action.ts#L78)
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **FetchEngineAction** = \{ `selector`: `string`; `type`: `"click"`; \} \| \{ `selector`: `string`; `type`: `"fill"`; `value`: `string`; \} \| \{ `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"`; \} \| \{ `type`: `"dispose"`; \}
10
10
 
11
- Defined in: [packages/web-fetcher/src/engine/base.ts:78](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/engine/base.ts#L78)
11
+ Defined in: [packages/web-fetcher/src/engine/base.ts:78](https://github.com/isdk/web-fetcher.js/blob/db611cb04a516e006310c5e147f90026827d6d80/src/engine/base.ts#L78)
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:20](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/core/types.ts#L20)
11
+ Defined in: [packages/web-fetcher/src/core/types.ts:20](https://github.com/isdk/web-fetcher.js/blob/db611cb04a516e006310c5e147f90026827d6d80/src/core/types.ts#L20)
@@ -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:5](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/core/fetch-return-type.ts#L5)
11
+ Defined in: [packages/web-fetcher/src/core/fetch-return-type.ts:5](https://github.com/isdk/web-fetcher.js/blob/db611cb04a516e006310c5e147f90026827d6d80/src/core/fetch-return-type.ts#L5)
@@ -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:22](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/core/fetch-return-type.ts#L22)
11
+ Defined in: [packages/web-fetcher/src/core/fetch-return-type.ts:22](https://github.com/isdk/web-fetcher.js/blob/db611cb04a516e006310c5e147f90026827d6d80/src/core/fetch-return-type.ts#L22)
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:90](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/core/types.ts#L90)
11
+ Defined in: [packages/web-fetcher/src/core/types.ts:90](https://github.com/isdk/web-fetcher.js/blob/db611cb04a516e006310c5e147f90026827d6d80/src/core/types.ts#L90)
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:24](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/core/types.ts#L24)
11
+ Defined in: [packages/web-fetcher/src/core/types.ts:24](https://github.com/isdk/web-fetcher.js/blob/db611cb04a516e006310c5e147f90026827d6d80/src/core/types.ts#L24)
@@ -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:131](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/core/types.ts#L131)
11
+ Defined in: [packages/web-fetcher/src/core/types.ts:131](https://github.com/isdk/web-fetcher.js/blob/db611cb04a516e006310c5e147f90026827d6d80/src/core/types.ts#L131)
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@isdk/web-fetcher",
3
- "version": "0.2.0",
3
+ "version": "0.2.1",
4
4
  "author": "Riceball LEE <snowyu.lee@gmail.com>",
5
5
  "homepage": "https://github.com/isdk/web-fetcher.js",
6
6
  "repository": {