Class BarCache

Broker-agnostic market-data source. The chart depends only on this. subscribeBars is optional: a history-only feed (e.g. OpenAlgoDataFeed) omits it, while a live feed (OpenAlgoLiveDataFeed, or your own) implements it.

Implements

Constructors

constructor

Properties

dataVariants? getBarsPage? searchSymbols? source subscribeBars? subscribeDepth?

Methods

clear getBars getCachedBars invalidate stats

Constructors

constructor

Properties

OptionaldataVariants

dataVariants?: (
    query: DataVariantQuery,
) => DataVariantCapabilities | Promise<DataVariantCapabilities>

The variants this provider serves for an instrument and interval. Without it the feed serves only its default series, and a request for any other variant is reported unsupported rather than sent.

OptionalgetBarsPage

getBarsPage?: (req: BarsPageRequest) => Promise<BarsPage>

OptionalsearchSymbols

searchSymbols?: (request: SymbolSearchRequest) => Promise<SymbolMatch[]>

Instruments matching what the user typed, closest first. A widget given this feed and no symbolSearch callback looks symbols up through it.

Readonlysource

source: DataFeed

The wrapped feed, for callers that need something this wrapper does not forward.

OptionalsubscribeBars

subscribeBars?: (
    req: BarsRequest,
    onBar: (bar: Bar, meta?: LiveBarMeta) => void,
    ...rest: unknown[],
) => UnsubscribeFn

OptionalsubscribeDepth

subscribeDepth?: (
    req: BarsRequest,
    onDepth: (depth: MarketDepth) => void,
    ...rest: unknown[],
) => UnsubscribeFn

opts.depthLevel requests a book depth (broker-dependent: 5/20/30/50). Named on the interface so a caller holding a DataFeed can ask for one; an implementation is free to ignore it and send the broker's default.

Methods

clear

getBars

getCachedBars

invalidate

  • invalidate(
        req?: Pick<BarsRequest, "symbol" | "variant" | "exchange" | "interval">,
    ): Promise<void>

  • Drop one series, or (with no argument) everything this cache knows of. "Knows of" is literal with an injected persistent store: recency and size are tracked in memory, so keys written by an earlier session are dropped when they are next read and found expired, not by clear(). A store that outlives the process is responsible for its own overall quota.

    Parameters

    • Optionalreq: Pick<BarsRequest, "symbol" | "variant" | "exchange" | "interval">

    Returns Promise<void>

stats

Settings

Member Visibility

On This Page

Constructors
Properties
Methods