@strong-roots-capital/indicator-record NPM

indicator-record

Interface for Records transformed by indicators

Install

npm install @strong-roots-capital/indicator-record

Use

import IndicatorRecord from '@strong-roots-capital/indicator-record'

The IndicatorRecord interface is defined as

/**
 * Collection of one or more indicator values derived from source
 * time-series record.
 */
interface IndicatorRecord<T = any> {
    /**
     * Context of record data.
     */
    context: RecordContext
    /**
     * Time-series record data.
     */
    record: Record
    /**
     * Map of indicator name and associated values (objects), in a
     * shape analogous to Records.
     */
    indicators: Map<string, T>
}