SessionOptions

Index

Properties

• cookieJar
• createdAt
• errorScore
• errorScoreDecrement
• expiresAt
• id
• log
• maxAgeSecs
• maxErrorScore
• maxUsageCount
• sessionPool
• usageCount
• userData

Properties

optionalcookieJar

cookieJar?: CookieJar

optionalcreatedAt

createdAt?: Date

Date of creation.

optionalerrorScore

errorScore?: number

optionalerrorScoreDecrement

errorScoreDecrement?: number = <p>0.5</p>

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 of expiration.

optionalid

id?: string

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

optionallog

log?: Log

optionalmaxAgeSecs

maxAgeSecs?: number = <p>3000</p>

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

optionalmaxErrorScore

maxErrorScore?: number = <p>3</p>

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 = <p>50</p>

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.

optionalsessionPool

sessionPool?: SessionPool

SessionPool instance. Session will emit the sessionRetired event on this instance.

optionalusageCount

usageCount?: number = <p>0</p>

Indicates how many times the session has been used.

optionaluserData

userData?: Dictionary<any>

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