adx.ts overview


Exports Grouped by Category


incremental

incrementalAdx

Incremental Average Directional Index (ADX), see adx. Takes one candle per push.

Example

import assert from "node:assert"
import { incrementalAdx } from "@ldrick/trade-indicators"

const created = incrementalAdx(2)
assert.ok(created.ok)

const candles = [
  { close: 9, high: 10, low: 8 },
  { close: 11, high: 12, low: 9 },
  { close: 10, high: 11, low: 9 },
  { close: 13, high: 14, low: 11 },
  { close: 12, high: 13, low: 10 },
  { close: 15, high: 16, low: 13 }
]
let indicator = created.value
for (const candle of candles) {
  const pushed = indicator.push(candle)
  assert.ok(pushed.ok)
  indicator = pushed.value
}
const { adx, mdi, pdi } = indicator.value
assert.deepStrictEqual(
  [pdi, mdi, adx].map((v) => v?.toFixed(2)),
  ["56.14", "7.02", "72.22"]
)

Signature

declare const incrementalAdx: (period?: number) => Result<Incremental<Candle, ADXValue>>

Source

Since v0.9.0

indicators

adx

The Average Directional Index (ADX) determines trend strength. It also delivers Plus Directional Movement Indicator (PDI) and Minus Directional Movement Indicator (MDI). Crossings of these three values can be used to determine trend changes.

high, low and close must have the same length (otherwise UnequalArraySizesError) of at least 2 * period. All three series have one value per input value within 0 and 100: the first period values of pdi and mdi and the first 2 * period - 1 values of adx are null.

Example

import assert from "node:assert"
import { adx } from "@ldrick/trade-indicators"

const result = adx(
  {
    close: [9, 11, 10, 13, 12, 15],
    high: [10, 12, 11, 14, 13, 16],
    low: [8, 9, 9, 11, 10, 13]
  },
  2
)
assert.ok(result.ok)

const round = (values: readonly (null | number)[]) => values.map((v) => v?.toFixed(2) ?? null)
assert.deepStrictEqual(round(result.value.pdi), [null, null, "40.00", "61.54", "32.00", "56.14"])
assert.deepStrictEqual(round(result.value.mdi), [null, null, "0.00", "0.00", "16.00", "7.02"])
assert.deepStrictEqual(round(result.value.adx), [null, null, null, "100.00", "66.67", "72.22"])

Signature

declare const adx: (values: HighLowClose<number>, period?: number) => Result<ADXReturn>

Source

Since v0.2.0

models

ADXReturn (interface)

Result of adx. All three series have the length of the input values.

Signature

export interface ADXReturn {
  adx: NonEmptyArray<null | number>
  mdi: NonEmptyArray<null | number>
  pdi: NonEmptyArray<null | number>
}

Source

Since v0.9.0

ADXValue (interface)

Output of incrementalAdx for one candle; each field is null as long as the batch adx returns null at that position.

Signature

export interface ADXValue {
  readonly adx: null | number
  readonly mdi: null | number
  readonly pdi: null | number
}

Source

Since v0.9.0


This site uses Just the Docs, a documentation theme for Jekyll.