1.0.1 • Published 5 years ago

@strong-roots-capital/record-context v1.0.1

Weekly downloads
1
License
ISC
Repository
github
Last release
5 years ago

record-context Build status npm version

Interface definition of the context of a timeseries-record

Install

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

Use

import RecordContext from '@strong-roots-capital/record-context'

The RecordContext interface is defined as

/**
 * Context of a timeseries `Record`.
 */
export default interface RecordContext {
    /**
     * Timeframe of `Record` denominated in minutes.
     */
    timeframe: number
    /**
     * Concatenation of both asset-names available for trade.
     *
     * @remarks
     * The second asset-name in `tradepair` will be the same units in
     * which associated `Record`s prices are valued.
     */
    tradepair: string
    /**
     * Name of exchange from which `Record` was collected.
     */
    exchange: string
}

Related