@crawlee/types

Index

Scaling

• ISession
• ISessionPool

Other

• CrawleeLogger
• CrawleeLoggerOptions
• IBrowserPool
• NewPageOptions
• StorageBackend
• StorageIdentifier
• BaseHttpClient
• BatchAddRequestsResult
• BrowserLikeResponse
• Cookie
• CookieJar
• CookieJarGetCookiesOptions
• CookieJarSetCookieOptions
• DatasetBackend
• DatasetBackendListOptions
• DatasetInfo
• HttpRequest
• HttpRequestOptions
• KeyValueStoreBackend
• KeyValueStoreInfo
• KeyValueStoreInputRecord
• KeyValueStoreItemData
• KeyValueStoreListKeysOptions
• KeyValueStoreListKeysResult
• KeyValueStoreRecord
• PageState
• PaginatedList
• ProcessedRequest
• ProxyInfo
• QueueOperationInfo
• RequestQueueBackend
• RequestQueueInfo
• RequestQueueOperationOptions
• RequestSchema
• SendRequestOptions
• SerializedCookieJar
• SessionCookie
• SessionFingerprint
• SessionState
• SetStatusMessageOptions
• StreamOptions
• UnprocessedRequest
• UpdateRequestSchema
• AllowedHttpMethods
• Dictionary
• KeyValueStoreRecordInputValue
• RedirectHandler
• SearchParams

Other

CrawleeLogger

Re-exports CrawleeLogger

CrawleeLoggerOptions

Re-exports CrawleeLoggerOptions

IBrowserPool

Re-exports IBrowserPool

NewPageOptions

Re-exports NewPageOptions

StorageBackend

Re-exports StorageBackend

StorageIdentifier

Re-exports StorageIdentifier

AllowedHttpMethods

AllowedHttpMethods: GET | HEAD | POST | PUT | DELETE | TRACE | OPTIONS | CONNECT | PATCH | get | head | post | put | delete | trace | options | connect | patch

Dictionary

Dictionary<T>: Record<PropertyKey, T>

Type parameters

• T = any

KeyValueStoreRecordInputValue

KeyValueStoreRecordInputValue: Buffer | ArrayBuffer | ArrayBufferView | string | NodeJS.ReadableStream | ReadableStream

The value a serialized record carries on the way into a storage backend (setValue).

The KeyValueStore frontend has already serialized by this point, so it is a pre-serialized string, raw bytes (Buffer / ArrayBuffer / typed array), or a stream the client drains.

RedirectHandler

RedirectHandler: (redirectResponse, updatedRequest) => void

Type of a function called when an HTTP redirect takes place. It is allowed to mutate the updatedRequest argument.

---

Type declaration

• • (redirectResponse, updatedRequest): void

  • Parameters

    • redirectResponse: Response

    • updatedRequest: { headers: Headers; url?: string | URL }

    • headers: Headers

    • optionalurl: string | URL

    Returns void

SearchParams

SearchParams: string | URLSearchParams | Record<string, string | number | boolean | null | undefined>