Engine
Defined in: js-xbbg/index.d.ts:254
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new Engine(
host?,port?):Engine
Defined in: js-xbbg/index.d.ts:255
Parameters
Section titled “Parameters”string
number
Returns
Section titled “Returns”Engine
Methods
Section titled “Methods”bcurves()
Section titled “bcurves()”bcurves(
ticker,options?):Promise<Table<any>>
Defined in: js-xbbg/index.d.ts:329
Parameters
Section titled “Parameters”ticker
Section titled “ticker”string
options?
Section titled “options?”Returns
Section titled “Returns”Promise<Table<any>>
bdh(
tickers,fields,options?):Promise<Table<any>>
Defined in: js-xbbg/index.d.ts:269
Parameters
Section titled “Parameters”tickers
Section titled “tickers”string[]
fields
Section titled “fields”string[]
options?
Section titled “options?”Returns
Section titled “Returns”Promise<Table<any>>
bdib()
Section titled “bdib()”bdib(
ticker,options?):Promise<Table<any>>
Defined in: js-xbbg/index.d.ts:274
Parameters
Section titled “Parameters”ticker
Section titled “ticker”string
options?
Section titled “options?”Returns
Section titled “Returns”Promise<Table<any>>
bdp(
tickers,fields,options?):Promise<Table<any>>
Defined in: js-xbbg/index.d.ts:259
Parameters
Section titled “Parameters”tickers
Section titled “tickers”string[]
fields
Section titled “fields”string[]
options?
Section titled “options?”Returns
Section titled “Returns”Promise<Table<any>>
bds(
tickers,fields,options?):Promise<Table<any>>
Defined in: js-xbbg/index.d.ts:264
Parameters
Section titled “Parameters”tickers
Section titled “tickers”string[]
fields
Section titled “fields”string[]
options?
Section titled “options?”Returns
Section titled “Returns”Promise<Table<any>>
bdtick()
Section titled “bdtick()”bdtick(
ticker,options?):Promise<Table<any>>
Defined in: js-xbbg/index.d.ts:275
Parameters
Section titled “Parameters”ticker
Section titled “ticker”string
options?
Section titled “options?”Returns
Section titled “Returns”Promise<Table<any>>
beqs()
Section titled “beqs()”beqs(
screen,options?):Promise<Table<any>>
Defined in: js-xbbg/index.d.ts:315
Parameters
Section titled “Parameters”screen
Section titled “screen”string
options?
Section titled “options?”Returns
Section titled “Returns”Promise<Table<any>>
bflds()
Section titled “bflds()”bflds(
options):Promise<Table<any>>
Defined in: js-xbbg/index.d.ts:322
Parameters
Section titled “Parameters”options
Section titled “options”Returns
Section titled “Returns”Promise<Table<any>>
bgovts()
Section titled “bgovts()”bgovts(
ticker,options?):Promise<Table<any>>
Defined in: js-xbbg/index.d.ts:330
Parameters
Section titled “Parameters”ticker
Section titled “ticker”string
options?
Section titled “options?”Returns
Section titled “Returns”Promise<Table<any>>
blkp()
Section titled “blkp()”blkp(
query,options?):Promise<Table<any>>
Defined in: js-xbbg/index.d.ts:323
Parameters
Section titled “Parameters”string
options?
Section titled “options?”Returns
Section titled “Returns”Promise<Table<any>>
bops()
Section titled “bops()”bops(
service):Promise<string[]>
Defined in: js-xbbg/index.d.ts:344
Parameters
Section titled “Parameters”service
Section titled “service”string
Returns
Section titled “Returns”Promise<string[]>
bport()
Section titled “bport()”bport(
portfolio,fields,options?):Promise<Table<any>>
Defined in: js-xbbg/index.d.ts:324
Parameters
Section titled “Parameters”portfolio
Section titled “portfolio”string
fields
Section titled “fields”string | string[]
options?
Section titled “options?”Returns
Section titled “Returns”Promise<Table<any>>
bql(
query,options?):Promise<Table<any>>
Defined in: js-xbbg/index.d.ts:314
Parameters
Section titled “Parameters”string
options?
Section titled “options?”Returns
Section titled “Returns”Promise<Table<any>>
bqr(
ticker,options?):Promise<Table<any>>
Defined in: js-xbbg/index.d.ts:348
Parameters
Section titled “Parameters”ticker
Section titled “ticker”string
options?
Section titled “options?”Returns
Section titled “Returns”Promise<Table<any>>
bschema()
Section titled “bschema()”bschema(
service,operation?):Promise<unknown>
Defined in: js-xbbg/index.d.ts:345
Parameters
Section titled “Parameters”service
Section titled “service”string
operation?
Section titled “operation?”string
Returns
Section titled “Returns”Promise<unknown>
bsrch()
Section titled “bsrch()”bsrch(
searchSpec,options?):Promise<Table<any>>
Defined in: js-xbbg/index.d.ts:316
Parameters
Section titled “Parameters”searchSpec
Section titled “searchSpec”string
options?
Section titled “options?”Returns
Section titled “Returns”Promise<Table<any>>
bta(
ticker,study,options?):Promise<Table<any>>
Defined in: js-xbbg/index.d.ts:317
Parameters
Section titled “Parameters”ticker
Section titled “ticker”string
string | Record<string, unknown>
options?
Section titled “options?”Returns
Section titled “Returns”Promise<Table<any>>
chains()
Section titled “chains()”chains(
ticker,options?):Promise<Subscription>
Defined in: js-xbbg/index.d.ts:343
Parameters
Section titled “Parameters”ticker
Section titled “ticker”string
options?
Section titled “options?”Returns
Section titled “Returns”Promise<Subscription>
clearFieldCache()
Section titled “clearFieldCache()”clearFieldCache():
void
Defined in: js-xbbg/index.d.ts:282
Returns
Section titled “Returns”void
clearSchemaCache()
Section titled “clearSchemaCache()”clearSchemaCache():
void
Defined in: js-xbbg/index.d.ts:291
Returns
Section titled “Returns”void
depth()
Section titled “depth()”depth(
ticker,options?):Promise<Subscription>
Defined in: js-xbbg/index.d.ts:342
Parameters
Section titled “Parameters”ticker
Section titled “ticker”string
options?
Section titled “options?”Returns
Section titled “Returns”Promise<Subscription>
fieldInfo()
Section titled “fieldInfo()”fieldInfo(
fields,options?):Promise<Table<any>>
Defined in: js-xbbg/index.d.ts:346
Parameters
Section titled “Parameters”fields
Section titled “fields”string | string[]
options?
Section titled “options?”Returns
Section titled “Returns”Promise<Table<any>>
fieldSearch()
Section titled “fieldSearch()”fieldSearch(
searchSpec,options?):Promise<Table<any>>
Defined in: js-xbbg/index.d.ts:347
Parameters
Section titled “Parameters”searchSpec
Section titled “searchSpec”string
options?
Section titled “options?”Returns
Section titled “Returns”Promise<Table<any>>
getCachedSchema()
Section titled “getCachedSchema()”getCachedSchema(
service):unknown
Defined in: js-xbbg/index.d.ts:289
Parameters
Section titled “Parameters”service
Section titled “service”string
Returns
Section titled “Returns”unknown
getEnumValues()
Section titled “getEnumValues()”getEnumValues(
service,operation,element):Promise<string[] |null>
Defined in: js-xbbg/index.d.ts:293
Parameters
Section titled “Parameters”service
Section titled “service”string
operation
Section titled “operation”string
element
Section titled “element”string
Returns
Section titled “Returns”Promise<string[] | null>
getFieldInfo()
Section titled “getFieldInfo()”getFieldInfo(
field):FieldInfo|null
Defined in: js-xbbg/index.d.ts:281
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”FieldInfo | null
getOperation()
Section titled “getOperation()”getOperation(
service,operation):Promise<unknown>
Defined in: js-xbbg/index.d.ts:287
Parameters
Section titled “Parameters”service
Section titled “service”string
operation
Section titled “operation”string
Returns
Section titled “Returns”Promise<unknown>
getSchema()
Section titled “getSchema()”getSchema(
service):Promise<unknown>
Defined in: js-xbbg/index.d.ts:286
Parameters
Section titled “Parameters”service
Section titled “service”string
Returns
Section titled “Returns”Promise<unknown>
invalidateSchema()
Section titled “invalidateSchema()”invalidateSchema(
service):void
Defined in: js-xbbg/index.d.ts:290
Parameters
Section titled “Parameters”service
Section titled “service”string
Returns
Section titled “Returns”void
isAvailable()
Section titled “isAvailable()”isAvailable():
boolean
Defined in: js-xbbg/index.d.ts:313
Returns
Section titled “Returns”boolean
isFieldValidationEnabled()
Section titled “isFieldValidationEnabled()”isFieldValidationEnabled():
boolean
Defined in: js-xbbg/index.d.ts:285
Returns
Section titled “Returns”boolean
listCachedSchemas()
Section titled “listCachedSchemas()”listCachedSchemas():
string[]
Defined in: js-xbbg/index.d.ts:292
Returns
Section titled “Returns”string[]
listOperations()
Section titled “listOperations()”listOperations(
service):Promise<string[]>
Defined in: js-xbbg/index.d.ts:288
Parameters
Section titled “Parameters”service
Section titled “service”string
Returns
Section titled “Returns”Promise<string[]>
listValidElements()
Section titled “listValidElements()”listValidElements(
service,operation):Promise<string[] |null>
Defined in: js-xbbg/index.d.ts:298
Parameters
Section titled “Parameters”service
Section titled “service”string
operation
Section titled “operation”string
Returns
Section titled “Returns”Promise<string[] | null>
mktbar()
Section titled “mktbar()”mktbar(
ticker,options?):Promise<Subscription>
Defined in: js-xbbg/index.d.ts:341
Parameters
Section titled “Parameters”ticker
Section titled “ticker”string
options?
Section titled “options?”Returns
Section titled “Returns”Promise<Subscription>
request()
Section titled “request()”request(
params):Promise<Table<any>>
Defined in: js-xbbg/index.d.ts:257
Parameters
Section titled “Parameters”params
Section titled “params”Returns
Section titled “Returns”Promise<Table<any>>
requestRaw()
Section titled “requestRaw()”requestRaw(
params):Promise<Buffer<ArrayBufferLike>>
Defined in: js-xbbg/index.d.ts:258
Parameters
Section titled “Parameters”params
Section titled “params”Returns
Section titled “Returns”Promise<Buffer<ArrayBufferLike>>
resolveFieldTypes()
Section titled “resolveFieldTypes()”resolveFieldTypes(
fields,overrides?,defaultType?):Promise<Record<string,string>>
Defined in: js-xbbg/index.d.ts:276
Parameters
Section titled “Parameters”fields
Section titled “fields”string[]
overrides?
Section titled “overrides?”Record<string, string | number | boolean>
defaultType?
Section titled “defaultType?”string
Returns
Section titled “Returns”Promise<Record<string, string>>
saveFieldCache()
Section titled “saveFieldCache()”saveFieldCache():
void
Defined in: js-xbbg/index.d.ts:283
Returns
Section titled “Returns”void
signalShutdown()
Section titled “signalShutdown()”signalShutdown():
void
Defined in: js-xbbg/index.d.ts:312
Returns
Section titled “Returns”void
stream()
Section titled “stream()”stream(
tickers,fields,options?):Promise<Subscription>
Defined in: js-xbbg/index.d.ts:331
Parameters
Section titled “Parameters”tickers
Section titled “tickers”string[]
fields
Section titled “fields”string[]
options?
Section titled “options?”Returns
Section titled “Returns”Promise<Subscription>
subscribe()
Section titled “subscribe()”subscribe(
tickers,fields):Promise<Subscription>
Defined in: js-xbbg/index.d.ts:302
Parameters
Section titled “Parameters”tickers
Section titled “tickers”string[]
fields
Section titled “fields”string[]
Returns
Section titled “Returns”Promise<Subscription>
subscribeWithOptions()
Section titled “subscribeWithOptions()”subscribeWithOptions(
service,tickers,fields,options?,flushThreshold?,overflowPolicy?,streamCapacity?):Promise<Subscription>
Defined in: js-xbbg/index.d.ts:303
Parameters
Section titled “Parameters”service
Section titled “service”string
tickers
Section titled “tickers”string[]
fields
Section titled “fields”string[]
options?
Section titled “options?”string[]
flushThreshold?
Section titled “flushThreshold?”number
overflowPolicy?
Section titled “overflowPolicy?”string
streamCapacity?
Section titled “streamCapacity?”number
Returns
Section titled “Returns”Promise<Subscription>
validateFields()
Section titled “validateFields()”validateFields(
fields):Promise<string[]>
Defined in: js-xbbg/index.d.ts:284
Parameters
Section titled “Parameters”fields
Section titled “fields”string[]
Returns
Section titled “Returns”Promise<string[]>
vwap()
Section titled “vwap()”vwap(
tickers,fields,options?):Promise<Subscription>
Defined in: js-xbbg/index.d.ts:336
Parameters
Section titled “Parameters”tickers
Section titled “tickers”string[]
fields
Section titled “fields”string[]
options?
Section titled “options?”Returns
Section titled “Returns”Promise<Subscription>
withConfig()
Section titled “withConfig()”
staticwithConfig(config?):Engine
Defined in: js-xbbg/index.d.ts:256
Parameters
Section titled “Parameters”config?
Section titled “config?”Returns
Section titled “Returns”Engine