@isdk/web-fetcher 0.2.0

package/docs/globals.md

@@ -0,0 +1,72 @@
+[**@isdk/web-fetcher**](README.md)
+
+***
+
+# @isdk/web-fetcher
+
+## Enumerations
+
+- [FetchActionResultStatus](enumerations/FetchActionResultStatus.md)
+
+## Classes
+
+- [CheerioFetchEngine](classes/CheerioFetchEngine.md)
+- [ClickAction](classes/ClickAction.md)
+- [ExtractAction](classes/ExtractAction.md)
+- [FetchAction](classes/FetchAction.md)
+- [FetchEngine](classes/FetchEngine.md)
+- [FetchSession](classes/FetchSession.md)
+- [FillAction](classes/FillAction.md)
+- [GetContentAction](classes/GetContentAction.md)
+- [GotoAction](classes/GotoAction.md)
+- [PauseAction](classes/PauseAction.md)
+- [PlaywrightFetchEngine](classes/PlaywrightFetchEngine.md)
+- [SubmitAction](classes/SubmitAction.md)
+- [WaitForAction](classes/WaitForAction.md)
+- [WebFetcher](classes/WebFetcher.md)
+
+## Interfaces
+
+- [BaseFetchActionProperties](interfaces/BaseFetchActionProperties.md)
+- [BaseFetchCollectorActionProperties](interfaces/BaseFetchCollectorActionProperties.md)
+- [BaseFetcherProperties](interfaces/BaseFetcherProperties.md)
+- [Cookie](interfaces/Cookie.md)
+- [DispatchedEngineAction](interfaces/DispatchedEngineAction.md)
+- [ExtractActionProperties](interfaces/ExtractActionProperties.md)
+- [FetchActionInContext](interfaces/FetchActionInContext.md)
+- [FetchActionProperties](interfaces/FetchActionProperties.md)
+- [FetchActionResult](interfaces/FetchActionResult.md)
+- [FetchContext](interfaces/FetchContext.md)
+- [FetchEngineContext](interfaces/FetchEngineContext.md)
+- [FetcherOptions](interfaces/FetcherOptions.md)
+- [FetchMetadata](interfaces/FetchMetadata.md)
+- [FetchResponse](interfaces/FetchResponse.md)
+- [FetchReturnTypeRegistry](interfaces/FetchReturnTypeRegistry.md)
+- [FetchSite](interfaces/FetchSite.md)
+- [GotoActionOptions](interfaces/GotoActionOptions.md)
+- [PendingEngineRequest](interfaces/PendingEngineRequest.md)
+- [SubmitActionOptions](interfaces/SubmitActionOptions.md)
+- [WaitForActionOptions](interfaces/WaitForActionOptions.md)
+
+## Type Aliases
+
+- [BaseFetchActionOptions](type-aliases/BaseFetchActionOptions.md)
+- [BaseFetchCollectorOptions](type-aliases/BaseFetchCollectorOptions.md)
+- [BrowserEngine](type-aliases/BrowserEngine.md)
+- [FetchActionCapabilities](type-aliases/FetchActionCapabilities.md)
+- [FetchActionCapabilityMode](type-aliases/FetchActionCapabilityMode.md)
+- [FetchActionOptions](type-aliases/FetchActionOptions.md)
+- [FetchEngineAction](type-aliases/FetchEngineAction.md)
+- [FetchEngineType](type-aliases/FetchEngineType.md)
+- [FetchReturnType](type-aliases/FetchReturnType.md)
+- [FetchReturnTypeFor](type-aliases/FetchReturnTypeFor.md)
+- [OnFetchPauseCallback](type-aliases/OnFetchPauseCallback.md)
+- [ResourceType](type-aliases/ResourceType.md)
+
+## Variables
+
+- [DefaultFetcherProperties](variables/DefaultFetcherProperties.md)
+
+## Functions
+
+- [fetchWeb](functions/fetchWeb.md)

package/docs/interfaces/BaseFetchActionProperties.md

@@ -0,0 +1,83 @@
+[**@isdk/web-fetcher**](../README.md)
+
+***
+
+[@isdk/web-fetcher](../globals.md) / BaseFetchActionProperties
+
+# Interface: BaseFetchActionProperties
+
+Defined in: [packages/web-fetcher/src/action/fetch-action.ts:44](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/action/fetch-action.ts#L44)
+
+## Extended by
+
+- [`BaseFetchCollectorActionProperties`](BaseFetchCollectorActionProperties.md)
+- [`FetchActionProperties`](FetchActionProperties.md)
+- [`ExtractActionProperties`](ExtractActionProperties.md)
+
+## Indexable
+
+\[`key`: `string`\]: `any`
+
+## Properties
+
+### failOnError?
+
+> `optional` **failOnError**: `boolean`
+
+Defined in: [packages/web-fetcher/src/action/fetch-action.ts:52](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/action/fetch-action.ts#L52)
+
+***
+
+### failOnTimeout?
+
+> `optional` **failOnTimeout**: `boolean`
+
+Defined in: [packages/web-fetcher/src/action/fetch-action.ts:54](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/action/fetch-action.ts#L54)
+
+***
+
+### id?
+
+> `optional` **id**: `string`
+
+Defined in: [packages/web-fetcher/src/action/fetch-action.ts:45](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/action/fetch-action.ts#L45)
+
+***
+
+### maxRetries?
+
+> `optional` **maxRetries**: `number`
+
+Defined in: [packages/web-fetcher/src/action/fetch-action.ts:56](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/action/fetch-action.ts#L56)
+
+***
+
+### name?
+
+> `optional` **name**: `string`
+
+Defined in: [packages/web-fetcher/src/action/fetch-action.ts:46](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/action/fetch-action.ts#L46)
+
+***
+
+### params?
+
+> `optional` **params**: `any`
+
+Defined in: [packages/web-fetcher/src/action/fetch-action.ts:47](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/action/fetch-action.ts#L47)
+
+***
+
+### storeAs?
+
+> `optional` **storeAs**: `string`
+
+Defined in: [packages/web-fetcher/src/action/fetch-action.ts:49](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/action/fetch-action.ts#L49)
+
+***
+
+### timeoutMs?
+
+> `optional` **timeoutMs**: `number`
+
+Defined in: [packages/web-fetcher/src/action/fetch-action.ts:55](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/action/fetch-action.ts#L55)

package/docs/interfaces/BaseFetchCollectorActionProperties.md

@@ -0,0 +1,145 @@
+[**@isdk/web-fetcher**](../README.md)
+
+***
+
+[@isdk/web-fetcher](../globals.md) / BaseFetchCollectorActionProperties
+
+# Interface: BaseFetchCollectorActionProperties
+
+Defined in: [packages/web-fetcher/src/action/fetch-action.ts:61](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/action/fetch-action.ts#L61)
+
+## Extends
+
+- [`BaseFetchActionProperties`](BaseFetchActionProperties.md)
+
+## Indexable
+
+\[`key`: `string`\]: `any`
+
+## Properties
+
+### activateOn?
+
+> `optional` **activateOn**: `string` \| `RegExp` \| (`string` \| `RegExp`)[]
+
+Defined in: [packages/web-fetcher/src/action/fetch-action.ts:63](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/action/fetch-action.ts#L63)
+
+***
+
+### background?
+
+> `optional` **background**: `boolean`
+
+Defined in: [packages/web-fetcher/src/action/fetch-action.ts:69](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/action/fetch-action.ts#L69)
+
+***
+
+### collectOn?
+
+> `optional` **collectOn**: `string` \| `RegExp` \| (`string` \| `RegExp`)[]
+
+Defined in: [packages/web-fetcher/src/action/fetch-action.ts:67](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/action/fetch-action.ts#L67)
+
+***
+
+### deactivateOn?
+
+> `optional` **deactivateOn**: `string` \| `RegExp` \| (`string` \| `RegExp`)[]
+
+Defined in: [packages/web-fetcher/src/action/fetch-action.ts:65](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/action/fetch-action.ts#L65)
+
+***
+
+### failOnError?
+
+> `optional` **failOnError**: `boolean`
+
+Defined in: [packages/web-fetcher/src/action/fetch-action.ts:52](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/action/fetch-action.ts#L52)
+
+#### Inherited from
+
+[`BaseFetchActionProperties`](BaseFetchActionProperties.md).[`failOnError`](BaseFetchActionProperties.md#failonerror)
+
+***
+
+### failOnTimeout?
+
+> `optional` **failOnTimeout**: `boolean`
+
+Defined in: [packages/web-fetcher/src/action/fetch-action.ts:54](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/action/fetch-action.ts#L54)
+
+#### Inherited from
+
+[`BaseFetchActionProperties`](BaseFetchActionProperties.md).[`failOnTimeout`](BaseFetchActionProperties.md#failontimeout)
+
+***
+
+### id?
+
+> `optional` **id**: `string`
+
+Defined in: [packages/web-fetcher/src/action/fetch-action.ts:45](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/action/fetch-action.ts#L45)
+
+#### Inherited from
+
+[`BaseFetchActionProperties`](BaseFetchActionProperties.md).[`id`](BaseFetchActionProperties.md#id)
+
+***
+
+### maxRetries?
+
+> `optional` **maxRetries**: `number`
+
+Defined in: [packages/web-fetcher/src/action/fetch-action.ts:56](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/action/fetch-action.ts#L56)
+
+#### Inherited from
+
+[`BaseFetchActionProperties`](BaseFetchActionProperties.md).[`maxRetries`](BaseFetchActionProperties.md#maxretries)
+
+***
+
+### name?
+
+> `optional` **name**: `string`
+
+Defined in: [packages/web-fetcher/src/action/fetch-action.ts:46](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/action/fetch-action.ts#L46)
+
+#### Inherited from
+
+[`BaseFetchActionProperties`](BaseFetchActionProperties.md).[`name`](BaseFetchActionProperties.md#name)
+
+***
+
+### params?
+
+> `optional` **params**: `any`
+
+Defined in: [packages/web-fetcher/src/action/fetch-action.ts:47](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/action/fetch-action.ts#L47)
+
+#### Inherited from
+
+[`BaseFetchActionProperties`](BaseFetchActionProperties.md).[`params`](BaseFetchActionProperties.md#params)
+
+***
+
+### storeAs?
+
+> `optional` **storeAs**: `string`
+
+Defined in: [packages/web-fetcher/src/action/fetch-action.ts:49](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/action/fetch-action.ts#L49)
+
+#### Inherited from
+
+[`BaseFetchActionProperties`](BaseFetchActionProperties.md).[`storeAs`](BaseFetchActionProperties.md#storeas)
+
+***
+
+### timeoutMs?
+
+> `optional` **timeoutMs**: `number`
+
+Defined in: [packages/web-fetcher/src/action/fetch-action.ts:55](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/action/fetch-action.ts#L55)
+
+#### Inherited from
+
+[`BaseFetchActionProperties`](BaseFetchActionProperties.md).[`timeoutMs`](BaseFetchActionProperties.md#timeoutms)

package/docs/interfaces/BaseFetcherProperties.md

@@ -0,0 +1,206 @@
+[**@isdk/web-fetcher**](../README.md)
+
+***
+
+[@isdk/web-fetcher](../globals.md) / BaseFetcherProperties
+
+# Interface: BaseFetcherProperties
+
+Defined in: [packages/web-fetcher/src/core/types.ts:26](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/core/types.ts#L26)
+
+## Extended by
+
+- [`FetchSite`](FetchSite.md)
+- [`FetcherOptions`](FetcherOptions.md)
+- [`FetchEngineContext`](FetchEngineContext.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)
+
+***
+
+### 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)
+
+***
+
+### 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"`
+
+***
+
+### 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)
+
+***
+
+### 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)
+
+***
+
+### 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)
+
+***
+
+### 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.
+
+***
+
+### 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)
+
+***
+
+### 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"`
+
+***
+
+### 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)
+
+***
+
+### 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)
+
+***
+
+### 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)
+
+***
+
+### 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)
+
+***
+
+### 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)
+
+***
+
+### 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)
+
+***
+
+### 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)
+
+***
+
+### 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)
+
+***
+
+### 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)
+
+***
+
+### url?
+
+> `optional` **url**: `string`
+
+Defined in: [packages/web-fetcher/src/core/types.ts:76](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/core/types.ts#L76)
+
+***
+
+### 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)

package/docs/interfaces/Cookie.md

@@ -0,0 +1,142 @@
+[**@isdk/web-fetcher**](../README.md)
+
+***
+
+[@isdk/web-fetcher](../globals.md) / Cookie
+
+# Interface: Cookie
+
+Defined in: node\_modules/.pnpm/@crawlee+types@3.15.1/node\_modules/@crawlee/types/browser.d.ts:2
+
+## Properties
+
+### domain?
+
+> `optional` **domain**: `string`
+
+Defined in: node\_modules/.pnpm/@crawlee+types@3.15.1/node\_modules/@crawlee/types/browser.d.ts:19
+
+Cookie domain.
+
+***
+
+### expires?
+
+> `optional` **expires**: `number`
+
+Defined in: node\_modules/.pnpm/@crawlee+types@3.15.1/node\_modules/@crawlee/types/browser.d.ts:39
+
+Cookie expiration date, session cookie if not set
+
+***
+
+### httpOnly?
+
+> `optional` **httpOnly**: `boolean`
+
+Defined in: node\_modules/.pnpm/@crawlee+types@3.15.1/node\_modules/@crawlee/types/browser.d.ts:31
+
+True if cookie is http-only.
+
+***
+
+### name
+
+> **name**: `string`
+
+Defined in: node\_modules/.pnpm/@crawlee+types@3.15.1/node\_modules/@crawlee/types/browser.d.ts:6
+
+Cookie name.
+
+***
+
+### path?
+
+> `optional` **path**: `string`
+
+Defined in: node\_modules/.pnpm/@crawlee+types@3.15.1/node\_modules/@crawlee/types/browser.d.ts:23
+
+Cookie path.
+
+***
+
+### priority?
+
+> `optional` **priority**: `"Low"` \| `"Medium"` \| `"High"`
+
+Defined in: node\_modules/.pnpm/@crawlee+types@3.15.1/node\_modules/@crawlee/types/browser.d.ts:43
+
+Cookie Priority.
+
+***
+
+### sameParty?
+
+> `optional` **sameParty**: `boolean`
+
+Defined in: node\_modules/.pnpm/@crawlee+types@3.15.1/node\_modules/@crawlee/types/browser.d.ts:47
+
+True if cookie is SameParty.
+
+***
+
+### sameSite?
+
+> `optional` **sameSite**: `"Strict"` \| `"Lax"` \| `"None"`
+
+Defined in: node\_modules/.pnpm/@crawlee+types@3.15.1/node\_modules/@crawlee/types/browser.d.ts:35
+
+Cookie SameSite type.
+
+***
+
+### secure?
+
+> `optional` **secure**: `boolean`
+
+Defined in: node\_modules/.pnpm/@crawlee+types@3.15.1/node\_modules/@crawlee/types/browser.d.ts:27
+
+True if cookie is secure.
+
+***
+
+### sourcePort?
+
+> `optional` **sourcePort**: `number`
+
+Defined in: node\_modules/.pnpm/@crawlee+types@3.15.1/node\_modules/@crawlee/types/browser.d.ts:57
+
+Cookie source port. Valid values are `-1` or `1-65535`, `-1` indicates an unspecified port.
+An unspecified port value allows protocol clients to emulate legacy cookie scope for the port.
+This is a temporary ability and it will be removed in the future.
+
+***
+
+### sourceScheme?
+
+> `optional` **sourceScheme**: `"Unset"` \| `"NonSecure"` \| `"Secure"`
+
+Defined in: node\_modules/.pnpm/@crawlee+types@3.15.1/node\_modules/@crawlee/types/browser.d.ts:51
+
+Cookie source scheme type.
+
+***
+
+### url?
+
+> `optional` **url**: `string`
+
+Defined in: node\_modules/.pnpm/@crawlee+types@3.15.1/node\_modules/@crawlee/types/browser.d.ts:15
+
+The request-URI to associate with the setting of the cookie. This value can affect the
+default domain, path, source port, and source scheme values of the created cookie.
+
+***
+
+### value
+
+> **value**: `string`
+
+Defined in: node\_modules/.pnpm/@crawlee+types@3.15.1/node\_modules/@crawlee/types/browser.d.ts:10
+
+Cookie value.