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

strong-roots-capital/d3fc-candle

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

9 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

d3fc-candle Build status npm version

Interface for d3fc candle data

Install

npm install d3fc-candle

Use

import Candle from 'd3fc-candle'

The Candle interface is defined as

/**
 * An atomic unit of d3fc financial time-series data.
 *
 * This interface was extracted from
 * https://github.com/d3fc/d3fc/tree/master/packages/d3fc-random-data
 */
interface Candle {
    /**
     * Date of Candle open.
     */
    date: Date,
    /**
     * Opening value of Candle.
     */
    open: number,
    /**
     * Highest value observed during Candle.
     */
    high: number,
    /**
     * Lowest value observed during Candle.
     */
    low: number
    /**
     * Closing value of Candle.
     */
    close: number,
    /**
     * Volume observed in Candle.
     */
    volume: number
}

Related