UNPKG

@ldrick/trade-indicators

Version:
18 lines (17 loc) 773 B
import { either as E, readonlyNonEmptyArray as RNEA } from 'fp-ts/lib'; import { HighLowClose, ReadonlyRecordNonEmptyArray } from '../types.js'; type ADXReturn = ReadonlyRecordNonEmptyArray<number | null> & { readonly adx: RNEA.ReadonlyNonEmptyArray<number | null>; readonly mdi: RNEA.ReadonlyNonEmptyArray<number>; readonly pdi: RNEA.ReadonlyNonEmptyArray<number>; }; /** * 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. * * @public */ export declare const adx: (values: HighLowClose<number>, period?: number) => E.Either<Error, ADXReturn>; export {};