SessionOptions

Index

Properties

• cookieJar
• createdAt
• errorScore
• errorScoreDecrement
• expiresAt
• fingerprint
• id
• log
• maxAgeSecs
• maxErrorScore
• maxUsageCount
• proxyInfo
• retired
• usageCount
• userData

Properties

optionalcookieJar

cookieJar?: CookieJar

optionalcreatedAt

createdAt?: Date

Date of creation.

optionalerrorScore

errorScore?: number

optionalerrorScoreDecrement

errorScoreDecrement?: number = 0.5

It is used for healing the session. For example: if your session is marked bad two times, but it is successful on the third attempt it's errorScore is decremented by this number.

optionalexpiresAt

expiresAt?: Date = Date

Date of expiration.

optionalfingerprint

fingerprint?: SessionFingerprint

Browser / HTTP client fingerprint tied to this session. Backends use this to make repeated requests with the same session look consistent (same user-agent, headers, TLS profile). See SessionFingerprint.

optionalid

id?: string

Id of session used for generating fingerprints. It is used as proxy session name.

optionallog

log?: CrawleeLogger

optionalmaxAgeSecs

maxAgeSecs?: number = 3000

Number of seconds after which the session is considered as expired.

optionalmaxErrorScore

maxErrorScore?: number = 3

Maximum number of marking session as blocked usage. If the errorScore reaches the maxErrorScore session is marked as block and it is thrown away. It starts at 0. Calling the markBad function increases the errorScore by 1. Calling the markGood will decrease the errorScore by errorScoreDecrement

optionalmaxUsageCount

maxUsageCount?: number = 50

Session should be used only a limited amount of times. This number indicates how many times the session is going to be used, before it is thrown away.

optionalproxyInfo

proxyInfo?: ProxyInfo

optionalretired

retired?: boolean = false

Marks the session as already retired. Used when restoring a previously persisted session so that isUsable() reflects the terminal state regardless of error score or usage count.

optionalusageCount

usageCount?: number = 0

Indicates how many times the session has been used.

optionaluserData

userData?: Dictionary

Object where custom user data can be stored. For example custom headers.