Interface TimeframeFeed

Opt-in resampling, with ownership limited to this wrapper's requests and streams.

interface TimeframeFeed {
    dataVariants(
        query: DataVariantQuery,
    ): DataVariantCapabilities | Promise<DataVariantCapabilities>;
    destroy(): void;
    getBars(req: BarsRequest): Promise<Bar[]>;
    getBarsPage(req: BarsPageRequest): Promise<BarsPage>;
    getCachedBars(req: BarsRequest): Promise<undefined | Bar[]>;
    resolve(request: BarsRequest): TimeframePlan;
    searchSymbols(request: SymbolSearchRequest): Promise<SymbolMatch[]>;
    subscribeBars(
        req: BarsRequest,
        onBar: (bar: Bar, meta?: LiveBarMeta) => void,
        opts?: BarSubscriptionOptions,
    ): UnsubscribeFn;
    subscribeDepth(
        req: BarsRequest,
        onDepth: (depth: MarketDepth) => void,
        opts?: { depthLevel?: number },
    ): UnsubscribeFn;
}

Hierarchy (View Summary)

DataFeed
- TimeframeFeed

Index

Methods

dataVariants? destroy getBars getBarsPage? getCachedBars? resolve searchSymbols? subscribeBars? subscribeDepth?

Methods

`Optional`dataVariants

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.
Parameters
- query: DataVariantQuery
Returns DataVariantCapabilities | Promise<DataVariantCapabilities>
Inherited from DataFeed.dataVariants
- Defined in src/feed/types.ts:86

destroy

destroy(): void
Returns void
- Defined in src/feed/timeframe-feed.ts:19

getBars

getBars(req: BarsRequest): Promise<Bar[]>
Parameters
- req: BarsRequest
Returns Promise<Bar[]>
Inherited from DataFeed.getBars
- Defined in src/feed/types.ts:79

`Optional`getBarsPage

getBarsPage(req: BarsPageRequest): Promise<BarsPage>
Parameters
- req: BarsPageRequest
Returns Promise<BarsPage>
Inherited from DataFeed.getBarsPage
- Defined in src/feed/types.ts:80

`Optional`getCachedBars

getCachedBars(req: BarsRequest): Promise<undefined | Bar[]>
Read a closed-bar snapshot without initiating a network request.
Parameters
- req: BarsRequest
Returns Promise<undefined | Bar[]>
Inherited from DataFeed.getCachedBars
- Defined in src/feed/types.ts:88

resolve

resolve(request: BarsRequest): TimeframePlan
Parameters
- request: BarsRequest
Returns TimeframePlan
- Defined in src/feed/timeframe-feed.ts:18

`Optional`searchSymbols

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.
Parameters
- request: SymbolSearchRequest
Returns Promise<SymbolMatch[]>
Inherited from DataFeed.searchSymbols
- Defined in src/feed/types.ts:100

`Optional`subscribeBars

subscribeBars(
    req: BarsRequest,
    onBar: (bar: Bar, meta?: LiveBarMeta) => void,
    opts?: BarSubscriptionOptions,
): UnsubscribeFn
Parameters
- req: BarsRequest
- onBar: (bar: Bar, meta?: LiveBarMeta) => void
- Optionalopts: BarSubscriptionOptions
Returns UnsubscribeFn
Inherited from DataFeed.subscribeBars
- Defined in src/feed/types.ts:89

`Optional`subscribeDepth

subscribeDepth(
    req: BarsRequest,
    onDepth: (depth: MarketDepth) => void,
    opts?: { depthLevel?: number },
): 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.
Parameters
- req: BarsRequest
- onDepth: (depth: MarketDepth) => void
- Optionalopts: { depthLevel?: number }
Returns UnsubscribeFn
Inherited from DataFeed.subscribeDepth
- Defined in src/feed/types.ts:95