SessionPoolOptions

Index

Properties

• blockedStatusCodes
• createSessionFunction
• maxPoolSize
• persistenceOptions
• persistStateKey
• persistStateKeyValueStoreId
• sessionOptions

Properties

optionalblockedStatusCodes

blockedStatusCodes?: number[] = [401, 403, 429]

Specifies which response status codes are considered as blocked. Session connected to such request will be marked as retired.

optionalcreateSessionFunction

createSessionFunction?: CreateSession

Custom function that should return Session instance. Any error thrown from this function will terminate the process. Function receives SessionPool instance as a parameter

optionalmaxPoolSize

maxPoolSize?: number = 1000

Maximum size of the pool. Indicates how many sessions are rotated.

optionalpersistenceOptions

persistenceOptions?: PersistenceOptions

Control how and when to persist the state of the session pool.

optionalpersistStateKey

persistStateKey?: string = SESSION_POOL_STATE

Session pool persists it's state under this key in Key value store.

optionalpersistStateKeyValueStoreId

persistStateKeyValueStoreId?: string

Name or Id of KeyValueStore where is the SessionPool state stored.

optionalsessionOptions

sessionOptions?: SessionOptions

The configuration options for Session instances.