Skip to content

charton API


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

Interface: BarsRequest ​

Defined in: packages/core/src/data/types.ts:92

A history request to a data source: why it is made, the time range, how many bars at most, and an abort signal.

Properties ​

from? ​

optional from?: number

Defined in: packages/core/src/data/types.ts:96

Oldest bar time wanted (inclusive); omitted = no lower bound.


kind ​

kind: BarsRequestKind

Defined in: packages/core/src/data/types.ts:94

What the request is for; see BarsRequestKind.


limit ​

limit: number

Defined in: packages/core/src/data/types.ts:103

Return at most this many bars, the newest within the range. Named for what it is, an upper bound: a source may return fewer.


signal ​

signal: AbortSignal

Defined in: packages/core/src/data/types.ts:105

Aborted when the request is no longer needed (symbol or interval switch).


to? ​

optional to?: number

Defined in: packages/core/src/data/types.ts:98

Bars strictly older than this; omitted = up to the newest bar.