charton

Appearance

charton API

charton API / @chart-on/core / index / PollingDataSourceOptions

Interface: PollingDataSourceOptions ​

Defined in: packages/core/src/data/adapters.ts:163

Options for the polling data source: the history source it polls, the pause between polls, and bars asked for per poll.

Properties ​

history ​

history: Pick<DataSource, "symbol" | "search" | "history">

Defined in: packages/core/src/data/adapters.ts:165

Symbol lookup and history, e.g. a REST data source; polls go through its history.

limit? ​

optional limit?: number

Defined in: packages/core/src/data/adapters.ts:172

Bars asked for per poll, the limit of each request (default and minimum 2: the bar sent last, to see whether it changed, and a new one).

pollMs ​

pollMs: number

Defined in: packages/core/src/data/adapters.ts:167

Milliseconds between the end of one poll and the start of the next.