Skip to content

EngineConfig

Defined in: js-xbbg/src/types.ts:66

optional auth?: AuthConfig

Defined in: js-xbbg/src/types.ts:81


optional autoRestartOnDisconnection?: boolean

Defined in: js-xbbg/src/types.ts:84


optional commandQueueSize?: number

Defined in: js-xbbg/src/types.ts:76


optional fieldCachePath?: string

Defined in: js-xbbg/src/types.ts:80


optional host?: string

Defined in: js-xbbg/src/types.ts:67


optional keepAliveEnabled?: boolean

Defined in: js-xbbg/src/types.ts:91

Enable BLPAPI keep-alive pings. SDK default: true.


optional keepAliveInactivityMs?: number

Defined in: js-xbbg/src/types.ts:93

Milliseconds of inactivity before keep-alive ping. SDK default: 20000.


optional keepAliveResponseTimeoutMs?: number

Defined in: js-xbbg/src/types.ts:95

Milliseconds to wait for a keep-alive response. SDK default: 10000.


optional maxEventQueueSize?: number

Defined in: js-xbbg/src/types.ts:75


optional numStartAttempts?: number

Defined in: js-xbbg/src/types.ts:83


optional overflowPolicy?: string

Defined in: js-xbbg/src/types.ts:78


optional port?: number

Defined in: js-xbbg/src/types.ts:68


optional requestPoolSize?: number

Defined in: js-xbbg/src/types.ts:71


optional requestTimeoutMs?: number

Defined in: js-xbbg/src/types.ts:87

Hard per-request timeout in ms; 0 disables. Default 0.


optional retryPolicy?: RetryPolicy

Defined in: js-xbbg/src/types.ts:85


optional sdkLogLevel?: string

Defined in: js-xbbg/src/types.ts:100


optional servers?: ServerAddress[]

Defined in: js-xbbg/src/types.ts:69


optional slowConsumerHiWaterMark?: number

Defined in: js-xbbg/src/types.ts:97

Slow-consumer hi water mark as fraction of maxEventQueueSize. SDK default: 0.75.


optional slowConsumerLoWaterMark?: number

Defined in: js-xbbg/src/types.ts:99

Slow-consumer lo water mark as fraction of maxEventQueueSize. SDK default: 0.5.


optional socks5?: Socks5Config

Defined in: js-xbbg/src/types.ts:101


optional streamsDeactivatedWarnMs?: number

Defined in: js-xbbg/src/types.ts:89

Warn threshold for streams staying deactivated, in ms. 0 disables. Default 30000.


optional subscriptionFlushThreshold?: number

Defined in: js-xbbg/src/types.ts:74


optional subscriptionPoolSize?: number

Defined in: js-xbbg/src/types.ts:72


optional subscriptionStreamCapacity?: number

Defined in: js-xbbg/src/types.ts:77


optional tls?: TlsConfig

Defined in: js-xbbg/src/types.ts:82


optional validationMode?: string

Defined in: js-xbbg/src/types.ts:73


optional warmupServices?: string[]

Defined in: js-xbbg/src/types.ts:79


optional zfpRemote?: "8194" | "8196"

Defined in: js-xbbg/src/types.ts:70