rsi.ts overview


Exports Grouped by Category


incremental

incrementalRsi

Incremental Relative Strength Index (RSI), see rsi. value is null as long as rsi returns null for that position.

Example

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

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

let indicator = created.value
const outputs: (null | number)[] = []
for (const input of [1, 2, 1, 3, 1]) {
  const pushed = indicator.push(input)
  assert.ok(pushed.ok)
  indicator = pushed.value
  outputs.push(indicator.value)
}
assert.deepStrictEqual(outputs, [null, null, 50, 250 / 3, 250 / 7])

Signature

declare const incrementalRsi: (period?: number) => Result<Incremental<number, null | number>>

Source

Since v0.9.0

indicators

rsi

The Relative Strength Index (RSI) by J. Welles Wilder is a momentum oscillator between 0 and 100, comparing the smoothed average gains with the smoothed average losses. Values above 70 are commonly seen as overbought, below 30 as oversold. A series without any change yields the neutral value 50.

Requires at least period + 1 values. Returns one value per input value; the first period are null.

Example

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

const result = rsi([1, 2, 1, 3, 1], 2)
assert.ok(result.ok)
assert.deepStrictEqual(
  result.value.map((v) => v?.toFixed(2) ?? null),
  [null, null, "50.00", "83.33", "35.71"]
)

Signature

declare const rsi: (values: readonly number[], period?: number) => Result<NonEmptyArray<null | number>>

Source

Since v0.9.0


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