Interface TimeframeProviderOptions

Availability is provider knowledge, not inferred from the next observed candle.

interface TimeframeProviderOptions {
    historicalSnapshot?: (
        request: IndicatorSnapshotRequest,
    ) => Promise<RequestedBarsSnapshot>;
    now?: () => number;
    availability(
        bar: Readonly<Bar>,
        request: IndicatorSnapshotRequest,
    ): { at: null | number; confirmed: boolean };
}

Index

Properties

historicalSnapshot? now?

Methods

Properties

`Optional`historicalSnapshot

historicalSnapshot?: (
request: IndicatorSnapshotRequest,
) => Promise<RequestedBarsSnapshot>

Supply historical value versions, or replay requests are rejected.

`Optional`now

now?: () => number

UTC seconds, also used for the five-minute closed-history cache lifetime.

Methods

availability

availability(
bar: Readonly<Bar>,
request: IndicatorSnapshotRequest,
): { at: null | number; confirmed: boolean }
Parameters
- bar: Readonly<Bar>
- request: IndicatorSnapshotRequest
Returns { at: null | number; confirmed: boolean }
- Defined in src/indicators/timeframe-provider.ts:10