syidaxchart
Home Pricing Settings

API REFERENCE

CandlestickStreamSource

The CandlestickStreamSource type declaration and related types. Optional fields are marked with ?.

Markdown source Components

Type declaration

typescript
export interface CandlestickStreamSource {
  push(bar: CandlestickBarInput): void;
  pushBatch(bars: ReadonlyArray<CandlestickBarInput>): void;
  shift(count: number): void;
  replace(bars: ReadonlyArray<CandlestickBarInput>): void;
  snapshot(): CandlestickBar[];
  latest(): CandlestickBar | undefined;
  subscribe(listener: (event: CandlestickStreamEvent) => void): () => void;
  readonly length: number;
  readonly capacity: number;
  readonly dropped: number;
}