Skip to content
This repository has been archived by the owner on Dec 30, 2023. It is now read-only.

strong-roots-capital/record-context

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

10 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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