candlelit
TypeScript icon, indicating that this package has built-in type declarations

0.2.1 • Public • Published

GitHub npm npm Build Status

WIP: candlelit

Candlelit is a bundle of useful functions and patterns to help you build your own matches for entry points in any market. Developed by Rafael Correa Chaves and Guilherme Vitorino as a way to easily implement and detect graphical patterns in new projects, candlelit is a easy solution for any programmer. If you wish to contribute any patterns we miss, you can write an email to: rafael.correa@aposoftworks.com or a new issue to our github with the title: [NP] . We hope you like it and enjoy using it.

Installation

NPM

npm install --save candlelit

Yarn

yarn add candlelit

Usage

You can easily require our candle module to use with your graph and use it as a promise

import {analyzeCandle} from 'candlelit';
 
const graph = [/* graph data*/];
 
analyzeCandle(graph).then(response => {
    console.log(response);
});

You can also add your own patterns to the list

function customPattern(graph) {
    // it must return either undefined for not match
    // or the info about the pattern following the interface
}
 
analyzeCandle.add(graph);
 
// You can also get the entire list
console.log(analyzeCandle.list());
 
// Or clear it
analyzeCandle.reset();

Here is how you should build your candle graph pattern

const graph = [
    [
        1, // open
        1, // high
        1, // low
        1, // close
    ]
];

Patterns available

Remember that testing a large chart with many patterns can be a costy process, so avoid using it every change you make to the chart. Or scope to the patterns you actually care about.

Candlestick

3 Bar Play

Reversed 3 Bar Play

Package Sidebar

Install

npm i candlelit

Weekly Downloads

3

Version

0.2.1

License

BSD-3-Clause

Unpacked Size

57.2 kB

Total Files

61

Last publish

Collaborators

  • darklight98