Class CandleBuilder

Index

Constructors

Methods

bucketStart current onTick seed

Constructors

constructor

new CandleBuilder(options?: Partial<CandleBuilderOptions>): CandleBuilder
Parameters
- options: Partial<CandleBuilderOptions> = {}
Returns CandleBuilder
- Defined in src/feed/candle-builder.ts:54

Methods

bucketStart

bucketStart(time: number): number
Bucket-start (bar-open) time for a tick, aligned to the session anchor.
Parameters
- time: number
Returns number
- Defined in src/feed/candle-builder.ts:73

current

current(): null | Bar
Returns null | Bar
- Defined in src/feed/candle-builder.ts:68

onTick

onTick(tick: Tick): null | CandleUpdate
Feed one tick. Returns the affected bar (mutated current or a fresh one), or null if the tick was dropped by the late-tick policy.
Parameters
- tick: Tick
Returns null | CandleUpdate
- Defined in src/feed/candle-builder.ts:83

seed

seed(lastBar: Bar, cumDayVolumeSoFar?: number): void
Seed with the last historical bar so the first live tick continues it.
Parameters
- lastBar: Bar
- OptionalcumDayVolumeSoFar: number
Returns void
- Defined in src/feed/candle-builder.ts:59