AuctionStreamOptions

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

Extends

• Omit<StreamOptions, "aliases">

Properties

allFields?

optional allFields?: boolean

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

Inherited from

StreamOptions.allFields

---

conflate?

optional conflate?: boolean

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

Inherited from

StreamOptions.conflate

---

delivery?

optional delivery?: "state" | "deltas"

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

Strict deltas by default; state coalesces dirty topics into current-state batches.

Inherited from

StreamOptions.delivery

---

fields?

optional fields?: readonly string[]

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

Inherited from

StreamOptions.fields

---

flushThreshold?

optional flushThreshold?: number

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

Maximum number of already-queued updates (or dirty state topics) combined into one read batch. Default: the engine's subscriptionFlushThreshold (16). Reads never wait for a batch to fill.

Inherited from

StreamOptions.flushThreshold

---

isolated?

optional isolated?: boolean

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

Opt out of engine-local market-data feed sharing. Default false.

Inherited from

StreamOptions.isolated

---

onDelayed?

optional onDelayed?: "warn" | "raise" | "ignore"

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

Warn once per topic (default), reject delayed topics, or only record the flag.

Inherited from

StreamOptions.onDelayed

---

onFieldError?

optional onFieldError?: "warn" | "raise" | "ignore"

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

Rejected explicit fields: warn (default), fail the topic, or only record errors.

Inherited from

StreamOptions.onFieldError

---

options?

optional options?: readonly string[]

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

Inherited from

StreamOptions.options

---

overflowPolicy?

optional overflowPolicy?: "block" | "drop_newest" | "drop_oldest"

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

Inherited from

StreamOptions.overflowPolicy

---

pcsOverrides?

optional pcsOverrides?: Record<string, string>

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

---

rows?

optional rows?: boolean

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

Keep a materialized image without queuing rows. Default true.

Inherited from

StreamOptions.rows

---

streamCapacity?

optional streamCapacity?: number

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

Inherited from

StreamOptions.streamCapacity

---

zeroAsNull?

optional zeroAsNull?: readonly string[]

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

Numeric zero sentinels to materialize as null in latest() and state deliveries.

Inherited from

StreamOptions.zeroAsNull