Skip to content

EngineConfig ​

Defined in: js-xbbg/src/index.ts (declaration: index.d.ts:43)

Properties ​

auth? ​

optional auth?: AuthConfig

Defined in: js-xbbg/src/index.ts (declaration: index.d.ts:58)


autoRestartOnDisconnection? ​

optional autoRestartOnDisconnection?: boolean

Defined in: js-xbbg/src/index.ts (declaration: index.d.ts:61)


commandQueueSize? ​

optional commandQueueSize?: number

Defined in: js-xbbg/src/index.ts (declaration: index.d.ts:53)


fieldCachePath? ​

optional fieldCachePath?: string

Defined in: js-xbbg/src/index.ts (declaration: index.d.ts:57)


host? ​

optional host?: string

Defined in: js-xbbg/src/index.ts (declaration: index.d.ts:44)


keepAliveEnabled? ​

optional keepAliveEnabled?: boolean

Defined in: js-xbbg/src/index.ts (declaration: index.d.ts:71)

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


keepAliveInactivityMs? ​

optional keepAliveInactivityMs?: number

Defined in: js-xbbg/src/index.ts (declaration: index.d.ts:73)

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


keepAliveResponseTimeoutMs? ​

optional keepAliveResponseTimeoutMs?: number

Defined in: js-xbbg/src/index.ts (declaration: index.d.ts:75)

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


maxEventQueueSize? ​

optional maxEventQueueSize?: number

Defined in: js-xbbg/src/index.ts (declaration: index.d.ts:52)


numStartAttempts? ​

optional numStartAttempts?: number

Defined in: js-xbbg/src/index.ts (declaration: index.d.ts:60)


overflowPolicy? ​

optional overflowPolicy?: string

Defined in: js-xbbg/src/index.ts (declaration: index.d.ts:55)


port? ​

optional port?: number

Defined in: js-xbbg/src/index.ts (declaration: index.d.ts:45)


requestPoolSize? ​

optional requestPoolSize?: number

Defined in: js-xbbg/src/index.ts (declaration: index.d.ts:48)


requestTimeoutMs? ​

optional requestTimeoutMs?: number

Defined in: js-xbbg/src/index.ts (declaration: index.d.ts:64)

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


retryPolicy? ​

optional retryPolicy?: RetryPolicy

Defined in: js-xbbg/src/index.ts (declaration: index.d.ts:62)


sdkLogLevel? ​

optional sdkLogLevel?: string

Defined in: js-xbbg/src/index.ts (declaration: index.d.ts:80)


servers? ​

optional servers?: ServerAddress[]

Defined in: js-xbbg/src/index.ts (declaration: index.d.ts:46)


slowConsumerHiWaterMark? ​

optional slowConsumerHiWaterMark?: number

Defined in: js-xbbg/src/index.ts (declaration: index.d.ts:77)

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


slowConsumerLoWaterMark? ​

optional slowConsumerLoWaterMark?: number

Defined in: js-xbbg/src/index.ts (declaration: index.d.ts:79)

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


socks5? ​

optional socks5?: Socks5Config

Defined in: js-xbbg/src/index.ts (declaration: index.d.ts:81)


streamsDeactivatedWarnMs? ​

optional streamsDeactivatedWarnMs?: number

Defined in: js-xbbg/src/index.ts (declaration: index.d.ts:69)

Warn threshold for a subscription's streams staying deactivated, in ms. 0 disables. Default 30000.


subscriptionFlushThreshold? ​

optional subscriptionFlushThreshold?: number

Defined in: js-xbbg/src/index.ts (declaration: index.d.ts:51)


subscriptionPoolSize? ​

optional subscriptionPoolSize?: number

Defined in: js-xbbg/src/index.ts (declaration: index.d.ts:49)


subscriptionStreamCapacity? ​

optional subscriptionStreamCapacity?: number

Defined in: js-xbbg/src/index.ts (declaration: index.d.ts:54)


tls? ​

optional tls?: TlsConfig

Defined in: js-xbbg/src/index.ts (declaration: index.d.ts:59)


validationMode? ​

optional validationMode?: string

Defined in: js-xbbg/src/index.ts (declaration: index.d.ts:50)


warmupServices? ​

optional warmupServices?: string[]

Defined in: js-xbbg/src/index.ts (declaration: index.d.ts:56)


zfpRemote? ​

optional zfpRemote?: "8194" | "8196"

Defined in: js-xbbg/src/index.ts (declaration: index.d.ts:47)

Last updated:

xbbg is independent open-source software and is not affiliated with, endorsed by, sponsored by, or approved by Bloomberg Finance L.P.