@isdk/web-fetcher 0.2.0

package/docs/interfaces/FetchEngineContext.md

@@ -0,0 +1,328 @@
+[**@isdk/web-fetcher**](../README.md)
+
+***
+
+[@isdk/web-fetcher](../globals.md) / FetchEngineContext
+
+# Interface: FetchEngineContext
+
+Defined in: [packages/web-fetcher/src/core/context.ts:24](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/core/context.ts#L24)
+
+## Extends
+
+- [`BaseFetcherProperties`](BaseFetcherProperties.md)
+
+## Extended by
+
+- [`FetchContext`](FetchContext.md)
+
+## Properties
+
+### antibot?
+
+> `optional` **antibot**: `boolean`
+
+Defined in: [packages/web-fetcher/src/core/types.ts:37](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/core/types.ts#L37)
+
+#### Inherited from
+
+[`BaseFetcherProperties`](BaseFetcherProperties.md).[`antibot`](BaseFetcherProperties.md#antibot)
+
+***
+
+### blockResources?
+
+> `optional` **blockResources**: `string`[]
+
+Defined in: [packages/web-fetcher/src/core/types.ts:46](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/core/types.ts#L46)
+
+#### Inherited from
+
+[`BaseFetcherProperties`](BaseFetcherProperties.md).[`blockResources`](BaseFetcherProperties.md#blockresources)
+
+***
+
+### browser?
+
+> `optional` **browser**: `object`
+
+Defined in: [packages/web-fetcher/src/core/types.ts:52](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/core/types.ts#L52)
+
+#### engine?
+
+> `optional` **engine**: [`BrowserEngine`](../type-aliases/BrowserEngine.md)
+
+浏览器引擎，默认为 playwright
+
+- `playwright`: 使用 Playwright 引擎
+- `puppeteer`: 使用 Puppeteer 引擎
+
+#### headless?
+
+> `optional` **headless**: `boolean`
+
+#### waitUntil?
+
+> `optional` **waitUntil**: `"load"` \| `"domcontentloaded"` \| `"networkidle"` \| `"commit"`
+
+#### Inherited from
+
+[`BaseFetcherProperties`](BaseFetcherProperties.md).[`browser`](BaseFetcherProperties.md#browser)
+
+***
+
+### cookies?
+
+> `optional` **cookies**: [`Cookie`](Cookie.md)[]
+
+Defined in: [packages/web-fetcher/src/core/types.ts:40](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/core/types.ts#L40)
+
+#### Inherited from
+
+[`BaseFetcherProperties`](BaseFetcherProperties.md).[`cookies`](BaseFetcherProperties.md#cookies)
+
+***
+
+### delayBetweenRequestsMs?
+
+> `optional` **delayBetweenRequestsMs**: `number`
+
+Defined in: [packages/web-fetcher/src/core/types.ts:72](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/core/types.ts#L72)
+
+#### Inherited from
+
+[`BaseFetcherProperties`](BaseFetcherProperties.md).[`delayBetweenRequestsMs`](BaseFetcherProperties.md#delaybetweenrequestsms)
+
+***
+
+### enableSmart?
+
+> `optional` **enableSmart**: `boolean`
+
+Defined in: [packages/web-fetcher/src/core/types.ts:35](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/core/types.ts#L35)
+
+#### Inherited from
+
+[`BaseFetcherProperties`](BaseFetcherProperties.md).[`enableSmart`](BaseFetcherProperties.md#enablesmart)
+
+***
+
+### engine?
+
+> `optional` **engine**: `string`
+
+Defined in: [packages/web-fetcher/src/core/types.ts:34](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/core/types.ts#L34)
+
+抓取模式
+
+- `http`: 使用 HTTP 进行抓取
+- `browser`: 使用浏览器进行抓取
+- `auto`: auto 会走“智能探测”选择 http 或 browser, 但是如果没有启用 smart，并且在站点注册表中没有，那么则等价为 http.
+
+#### Inherited from
+
+[`BaseFetcherProperties`](BaseFetcherProperties.md).[`engine`](BaseFetcherProperties.md#engine)
+
+***
+
+### finalUrl?
+
+> `optional` **finalUrl**: `string`
+
+Defined in: [packages/web-fetcher/src/core/context.ts:27](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/core/context.ts#L27)
+
+***
+
+### headers?
+
+> `optional` **headers**: `Record`\<`string`, `string`\>
+
+Defined in: [packages/web-fetcher/src/core/types.ts:39](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/core/types.ts#L39)
+
+#### Inherited from
+
+[`BaseFetcherProperties`](BaseFetcherProperties.md).[`headers`](BaseFetcherProperties.md#headers)
+
+***
+
+### http?
+
+> `optional` **http**: `object`
+
+Defined in: [packages/web-fetcher/src/core/types.ts:64](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/core/types.ts#L64)
+
+#### body?
+
+> `optional` **body**: `any`
+
+#### method?
+
+> `optional` **method**: `"GET"` \| `"POST"` \| `"PUT"` \| `"DELETE"` \| `"PATCH"`
+
+#### Inherited from
+
+[`BaseFetcherProperties`](BaseFetcherProperties.md).[`http`](BaseFetcherProperties.md#http)
+
+***
+
+### id
+
+> **id**: `string`
+
+Defined in: [packages/web-fetcher/src/core/context.ts:25](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/core/context.ts#L25)
+
+***
+
+### ignoreSslErrors?
+
+> `optional` **ignoreSslErrors**: `boolean`
+
+Defined in: [packages/web-fetcher/src/core/types.ts:50](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/core/types.ts#L50)
+
+#### Inherited from
+
+[`BaseFetcherProperties`](BaseFetcherProperties.md).[`ignoreSslErrors`](BaseFetcherProperties.md#ignoresslerrors)
+
+***
+
+### internal
+
+> **internal**: `BaseFetchContextInteralState`
+
+Defined in: [packages/web-fetcher/src/core/context.ts:32](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/core/context.ts#L32)
+
+***
+
+### lastResponse?
+
+> `optional` **lastResponse**: [`FetchResponse`](FetchResponse.md)
+
+Defined in: [packages/web-fetcher/src/core/context.ts:29](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/core/context.ts#L29)
+
+***
+
+### lastResult?
+
+> `optional` **lastResult**: [`FetchActionResult`](FetchActionResult.md)\<[`FetchReturnType`](../type-aliases/FetchReturnType.md)\>
+
+Defined in: [packages/web-fetcher/src/core/context.ts:30](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/core/context.ts#L30)
+
+***
+
+### maxConcurrency?
+
+> `optional` **maxConcurrency**: `number`
+
+Defined in: [packages/web-fetcher/src/core/types.ts:70](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/core/types.ts#L70)
+
+#### Inherited from
+
+[`BaseFetcherProperties`](BaseFetcherProperties.md).[`maxConcurrency`](BaseFetcherProperties.md#maxconcurrency)
+
+***
+
+### maxRequestsPerMinute?
+
+> `optional` **maxRequestsPerMinute**: `number`
+
+Defined in: [packages/web-fetcher/src/core/types.ts:71](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/core/types.ts#L71)
+
+#### Inherited from
+
+[`BaseFetcherProperties`](BaseFetcherProperties.md).[`maxRequestsPerMinute`](BaseFetcherProperties.md#maxrequestsperminute)
+
+***
+
+### proxy?
+
+> `optional` **proxy**: `string` \| `string`[]
+
+Defined in: [packages/web-fetcher/src/core/types.ts:44](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/core/types.ts#L44)
+
+#### Inherited from
+
+[`BaseFetcherProperties`](BaseFetcherProperties.md).[`proxy`](BaseFetcherProperties.md#proxy)
+
+***
+
+### retries?
+
+> `optional` **retries**: `number`
+
+Defined in: [packages/web-fetcher/src/core/types.ts:73](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/core/types.ts#L73)
+
+#### Inherited from
+
+[`BaseFetcherProperties`](BaseFetcherProperties.md).[`retries`](BaseFetcherProperties.md#retries)
+
+***
+
+### reuseCookies?
+
+> `optional` **reuseCookies**: `boolean`
+
+Defined in: [packages/web-fetcher/src/core/types.ts:41](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/core/types.ts#L41)
+
+#### Inherited from
+
+[`BaseFetcherProperties`](BaseFetcherProperties.md).[`reuseCookies`](BaseFetcherProperties.md#reusecookies)
+
+***
+
+### sites?
+
+> `optional` **sites**: [`FetchSite`](FetchSite.md)[]
+
+Defined in: [packages/web-fetcher/src/core/types.ts:75](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/core/types.ts#L75)
+
+#### Inherited from
+
+[`BaseFetcherProperties`](BaseFetcherProperties.md).[`sites`](BaseFetcherProperties.md#sites)
+
+***
+
+### throwHttpErrors?
+
+> `optional` **throwHttpErrors**: `boolean`
+
+Defined in: [packages/web-fetcher/src/core/types.ts:42](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/core/types.ts#L42)
+
+#### Inherited from
+
+[`BaseFetcherProperties`](BaseFetcherProperties.md).[`throwHttpErrors`](BaseFetcherProperties.md#throwhttperrors)
+
+***
+
+### timeoutMs?
+
+> `optional` **timeoutMs**: `number`
+
+Defined in: [packages/web-fetcher/src/core/types.ts:69](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/core/types.ts#L69)
+
+#### Inherited from
+
+[`BaseFetcherProperties`](BaseFetcherProperties.md).[`timeoutMs`](BaseFetcherProperties.md#timeoutms)
+
+***
+
+### url?
+
+> `optional` **url**: `string`
+
+Defined in: [packages/web-fetcher/src/core/context.ts:26](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/core/context.ts#L26)
+
+#### Overrides
+
+[`BaseFetcherProperties`](BaseFetcherProperties.md).[`url`](BaseFetcherProperties.md#url)
+
+***
+
+### useSiteRegistry?
+
+> `optional` **useSiteRegistry**: `boolean`
+
+Defined in: [packages/web-fetcher/src/core/types.ts:36](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/core/types.ts#L36)
+
+#### Inherited from
+
+[`BaseFetcherProperties`](BaseFetcherProperties.md).[`useSiteRegistry`](BaseFetcherProperties.md#usesiteregistry)

package/docs/interfaces/FetchMetadata.md

@@ -0,0 +1,73 @@
+[**@isdk/web-fetcher**](../README.md)
+
+***
+
+[@isdk/web-fetcher](../globals.md) / FetchMetadata
+
+# Interface: FetchMetadata
+
+Defined in: [packages/web-fetcher/src/core/types.ts:99](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/core/types.ts#L99)
+
+## Indexable
+
+\[`key`: `string`\]: `any`
+
+## Properties
+
+### engine?
+
+> `optional` **engine**: [`BrowserEngine`](../type-aliases/BrowserEngine.md)
+
+Defined in: [packages/web-fetcher/src/core/types.ts:101](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/core/types.ts#L101)
+
+***
+
+### mode
+
+> **mode**: [`FetchEngineType`](../type-aliases/FetchEngineType.md)
+
+Defined in: [packages/web-fetcher/src/core/types.ts:100](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/core/types.ts#L100)
+
+***
+
+### proxy?
+
+> `optional` **proxy**: `string`
+
+Defined in: [packages/web-fetcher/src/core/types.ts:111](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/core/types.ts#L111)
+
+***
+
+### timings?
+
+> `optional` **timings**: `object`
+
+Defined in: [packages/web-fetcher/src/core/types.ts:102](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/core/types.ts#L102)
+
+#### dns?
+
+> `optional` **dns**: `number`
+
+#### download?
+
+> `optional` **download**: `number`
+
+#### firstByte?
+
+> `optional` **firstByte**: `number`
+
+#### start
+
+> **start**: `number`
+
+#### tcp?
+
+> `optional` **tcp**: `number`
+
+#### total
+
+> **total**: `number`
+
+#### ttfb?
+
+> `optional` **ttfb**: `number`

package/docs/interfaces/FetchResponse.md

@@ -0,0 +1,105 @@
+[**@isdk/web-fetcher**](../README.md)
+
+***
+
+[@isdk/web-fetcher](../globals.md) / FetchResponse
+
+# Interface: FetchResponse
+
+Defined in: [packages/web-fetcher/src/core/types.ts:116](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/core/types.ts#L116)
+
+## Properties
+
+### body?
+
+> `optional` **body**: `string` \| `Buffer`\<`ArrayBufferLike`\>
+
+Defined in: [packages/web-fetcher/src/core/types.ts:123](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/core/types.ts#L123)
+
+***
+
+### contentType?
+
+> `optional` **contentType**: `string`
+
+Defined in: [packages/web-fetcher/src/core/types.ts:122](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/core/types.ts#L122)
+
+***
+
+### cookies?
+
+> `optional` **cookies**: [`Cookie`](Cookie.md)[]
+
+Defined in: [packages/web-fetcher/src/core/types.ts:127](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/core/types.ts#L127)
+
+***
+
+### finalUrl
+
+> **finalUrl**: `string`
+
+Defined in: [packages/web-fetcher/src/core/types.ts:118](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/core/types.ts#L118)
+
+***
+
+### headers
+
+> **headers**: `Record`\<`string`, `string`\>
+
+Defined in: [packages/web-fetcher/src/core/types.ts:121](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/core/types.ts#L121)
+
+***
+
+### html?
+
+> `optional` **html**: `string`
+
+Defined in: [packages/web-fetcher/src/core/types.ts:124](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/core/types.ts#L124)
+
+***
+
+### json?
+
+> `optional` **json**: `any`
+
+Defined in: [packages/web-fetcher/src/core/types.ts:126](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/core/types.ts#L126)
+
+***
+
+### metadata?
+
+> `optional` **metadata**: [`FetchMetadata`](FetchMetadata.md)
+
+Defined in: [packages/web-fetcher/src/core/types.ts:128](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/core/types.ts#L128)
+
+***
+
+### statusCode?
+
+> `optional` **statusCode**: `number`
+
+Defined in: [packages/web-fetcher/src/core/types.ts:119](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/core/types.ts#L119)
+
+***
+
+### statusText?
+
+> `optional` **statusText**: `string`
+
+Defined in: [packages/web-fetcher/src/core/types.ts:120](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/core/types.ts#L120)
+
+***
+
+### text?
+
+> `optional` **text**: `string`
+
+Defined in: [packages/web-fetcher/src/core/types.ts:125](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/core/types.ts#L125)
+
+***
+
+### url
+
+> **url**: `string`
+
+Defined in: [packages/web-fetcher/src/core/types.ts:117](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/core/types.ts#L117)

package/docs/interfaces/FetchReturnTypeRegistry.md

@@ -0,0 +1,57 @@
+[**@isdk/web-fetcher**](../README.md)
+
+***
+
+[@isdk/web-fetcher](../globals.md) / FetchReturnTypeRegistry
+
+# Interface: FetchReturnTypeRegistry
+
+Defined in: [packages/web-fetcher/src/core/fetch-return-type.ts:7](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/core/fetch-return-type.ts#L7)
+
+## Properties
+
+### any
+
+> **any**: `any`
+
+Defined in: [packages/web-fetcher/src/core/fetch-return-type.ts:12](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/core/fetch-return-type.ts#L12)
+
+***
+
+### context
+
+> **context**: [`FetchContext`](FetchContext.md)
+
+Defined in: [packages/web-fetcher/src/core/fetch-return-type.ts:9](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/core/fetch-return-type.ts#L9)
+
+***
+
+### none
+
+> **none**: `void`
+
+Defined in: [packages/web-fetcher/src/core/fetch-return-type.ts:13](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/core/fetch-return-type.ts#L13)
+
+***
+
+### outputs
+
+> **outputs**: `Record`\<`string`, `any`\>
+
+Defined in: [packages/web-fetcher/src/core/fetch-return-type.ts:11](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/core/fetch-return-type.ts#L11)
+
+***
+
+### response
+
+> **response**: [`FetchResponse`](FetchResponse.md)
+
+Defined in: [packages/web-fetcher/src/core/fetch-return-type.ts:8](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/core/fetch-return-type.ts#L8)
+
+***
+
+### result
+
+> **result**: `undefined` \| [`FetchActionResult`](FetchActionResult.md)\<`any`\>
+
+Defined in: [packages/web-fetcher/src/core/fetch-return-type.ts:10](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/core/fetch-return-type.ts#L10)