Code Monkey home page Code Monkey logo

is-doji's Introduction

is-doji Build Status npm npm version

Test if a Japanese candlestick qualifies as a doji

Install

npm install is-doji

Use

import { isDoji, Candle } from '../src/is-doji'

const dojiCandle: Candle = {
  open: 0,
  high: 100,
  low: 0,
  close: 8
}

const nonDojiCandle: Candle = {
  open: 0,
  high: 100,
  low: 0,
  close: 100
}

console.log(isDoji(dojiCandle))
//=> true

console.log(isDoji(nonDojiCandle))
//=> false

Index

Interfaces

Functions


Functions

isDoji

โ–ธ isDoji(candle: Candle, maximumBodyAsPercentOfSpread?: number): boolean

Defined in is-doji.ts:25

Returns true if candle qualifies as a doji.

Parameters:

Name Type Default value Description
candle Candle -
Default value maximumBodyAsPercentOfSpread number 8 Largest body:spread ratio to qualify as a doji.

Returns: boolean True if candle is a doji.


is-doji's People

Contributors

ericcrosson avatar

Watchers

 avatar  avatar  avatar

is-doji's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.