trading-signals 7.4.3 → 8.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (279) hide show
  1. package/README.md +80 -160
  2. package/dist/base/BandsResult.type.d.ts +5 -0
  3. package/dist/base/BandsResult.type.js +2 -0
  4. package/dist/base/BandsResult.type.js.map +1 -0
  5. package/dist/base/Candle.type.d.ts +14 -0
  6. package/dist/base/Candle.type.js +2 -0
  7. package/dist/base/Candle.type.js.map +1 -0
  8. package/dist/base/Indicator.d.ts +44 -0
  9. package/dist/base/Indicator.js +70 -0
  10. package/dist/base/Indicator.js.map +1 -0
  11. package/dist/base/Period.d.ts +18 -0
  12. package/dist/base/Period.js +35 -0
  13. package/dist/base/Period.js.map +1 -0
  14. package/dist/base/SignalThresholds.type.d.ts +4 -0
  15. package/dist/base/SignalThresholds.type.js +2 -0
  16. package/dist/base/SignalThresholds.type.js.map +1 -0
  17. package/dist/base/index.d.ts +5 -0
  18. package/dist/base/index.js +6 -0
  19. package/dist/base/index.js.map +1 -0
  20. package/dist/error/NotEnoughDataError.d.ts +3 -0
  21. package/dist/error/NotEnoughDataError.js +8 -0
  22. package/dist/error/NotEnoughDataError.js.map +1 -0
  23. package/dist/error/index.d.ts +1 -0
  24. package/dist/error/index.js +2 -0
  25. package/dist/error/index.js.map +1 -0
  26. package/dist/index.d.ts +7 -0
  27. package/dist/index.js +8 -0
  28. package/dist/index.js.map +1 -0
  29. package/dist/momentum/AC/AC.d.ts +17 -0
  30. package/dist/momentum/AC/AC.js +49 -0
  31. package/dist/momentum/AC/AC.js.map +1 -0
  32. package/dist/momentum/AO/AO.d.ts +14 -0
  33. package/dist/momentum/AO/AO.js +43 -0
  34. package/dist/momentum/AO/AO.js.map +1 -0
  35. package/dist/momentum/CCI/CCI.d.ts +11 -0
  36. package/dist/momentum/CCI/CCI.js +55 -0
  37. package/dist/momentum/CCI/CCI.js.map +1 -0
  38. package/dist/momentum/CG/CG.d.ts +13 -0
  39. package/dist/momentum/CG/CG.js +55 -0
  40. package/dist/momentum/CG/CG.js.map +1 -0
  41. package/dist/momentum/CMO/CMO.d.ts +10 -0
  42. package/dist/momentum/CMO/CMO.js +55 -0
  43. package/dist/momentum/CMO/CMO.js.map +1 -0
  44. package/dist/momentum/ER/ER.d.ts +13 -0
  45. package/dist/momentum/ER/ER.js +45 -0
  46. package/dist/momentum/ER/ER.js.map +1 -0
  47. package/dist/momentum/MACD/MACD.d.ts +27 -0
  48. package/dist/momentum/MACD/MACD.js +61 -0
  49. package/dist/momentum/MACD/MACD.js.map +1 -0
  50. package/dist/momentum/MFI/MFI.d.ts +11 -0
  51. package/dist/momentum/MFI/MFI.js +56 -0
  52. package/dist/momentum/MFI/MFI.js.map +1 -0
  53. package/dist/momentum/MOM/MOM.d.ts +9 -0
  54. package/dist/momentum/MOM/MOM.js +37 -0
  55. package/dist/momentum/MOM/MOM.js.map +1 -0
  56. package/dist/momentum/OBV/OBV.d.ts +10 -0
  57. package/dist/momentum/OBV/OBV.js +43 -0
  58. package/dist/momentum/OBV/OBV.js.map +1 -0
  59. package/dist/momentum/PPO/PPO.d.ts +14 -0
  60. package/dist/momentum/PPO/PPO.js +42 -0
  61. package/dist/momentum/PPO/PPO.js.map +1 -0
  62. package/dist/momentum/REI/REI.d.ts +11 -0
  63. package/dist/momentum/REI/REI.js +84 -0
  64. package/dist/momentum/REI/REI.js.map +1 -0
  65. package/dist/momentum/ROC/ROC.d.ts +10 -0
  66. package/dist/momentum/ROC/ROC.js +37 -0
  67. package/dist/momentum/ROC/ROC.js.map +1 -0
  68. package/dist/momentum/RSI/RSI.d.ts +11 -0
  69. package/dist/momentum/RSI/RSI.js +64 -0
  70. package/dist/momentum/RSI/RSI.js.map +1 -0
  71. package/dist/momentum/STOCH/StochasticOscillator.d.ts +30 -0
  72. package/dist/momentum/STOCH/StochasticOscillator.js +75 -0
  73. package/dist/momentum/STOCH/StochasticOscillator.js.map +1 -0
  74. package/dist/momentum/STOCHRSI/StochasticRSI.d.ts +19 -0
  75. package/dist/momentum/STOCHRSI/StochasticRSI.js +66 -0
  76. package/dist/momentum/STOCHRSI/StochasticRSI.js.map +1 -0
  77. package/dist/momentum/TDS/TDS.d.ts +9 -0
  78. package/dist/momentum/TDS/TDS.js +63 -0
  79. package/dist/momentum/TDS/TDS.js.map +1 -0
  80. package/dist/momentum/TRIX/TRIX.d.ts +9 -0
  81. package/dist/momentum/TRIX/TRIX.js +56 -0
  82. package/dist/momentum/TRIX/TRIX.js.map +1 -0
  83. package/dist/momentum/ULTOSC/UltimateOscillator.d.ts +18 -0
  84. package/dist/momentum/ULTOSC/UltimateOscillator.js +72 -0
  85. package/dist/momentum/ULTOSC/UltimateOscillator.js.map +1 -0
  86. package/dist/momentum/WILLR/WilliamsR.d.ts +12 -0
  87. package/dist/momentum/WILLR/WilliamsR.js +55 -0
  88. package/dist/momentum/WILLR/WilliamsR.js.map +1 -0
  89. package/dist/momentum/index.d.ts +20 -0
  90. package/dist/momentum/index.js +21 -0
  91. package/dist/momentum/index.js.map +1 -0
  92. package/dist/trend/ADX/ADX.d.ts +12 -0
  93. package/dist/trend/ADX/ADX.js +34 -0
  94. package/dist/trend/ADX/ADX.js.map +1 -0
  95. package/dist/trend/AROON/Aroon.d.ts +16 -0
  96. package/dist/trend/AROON/Aroon.js +34 -0
  97. package/dist/trend/AROON/Aroon.js.map +1 -0
  98. package/dist/trend/BREAKOUT_BAR_LOW/BreakoutBarLow.d.ts +11 -0
  99. package/dist/trend/BREAKOUT_BAR_LOW/BreakoutBarLow.js +37 -0
  100. package/dist/trend/BREAKOUT_BAR_LOW/BreakoutBarLow.js.map +1 -0
  101. package/dist/trend/CE/ChandelierExit.d.ts +21 -0
  102. package/dist/trend/CE/ChandelierExit.js +40 -0
  103. package/dist/trend/CE/ChandelierExit.js.map +1 -0
  104. package/dist/trend/DEMA/DEMA.d.ts +9 -0
  105. package/dist/trend/DEMA/DEMA.js +25 -0
  106. package/dist/trend/DEMA/DEMA.js.map +1 -0
  107. package/dist/trend/DMA/DMA.d.ts +18 -0
  108. package/dist/trend/DMA/DMA.js +29 -0
  109. package/dist/trend/DMA/DMA.js.map +1 -0
  110. package/dist/trend/DX/DX.d.ts +12 -0
  111. package/dist/trend/DX/DX.js +66 -0
  112. package/dist/trend/DX/DX.js.map +1 -0
  113. package/dist/trend/EMA/EMA.d.ts +10 -0
  114. package/dist/trend/EMA/EMA.js +43 -0
  115. package/dist/trend/EMA/EMA.js.map +1 -0
  116. package/dist/trend/HIGHER_LOW_TRAIL/HigherLowTrail.d.ts +12 -0
  117. package/dist/trend/HIGHER_LOW_TRAIL/HigherLowTrail.js +38 -0
  118. package/dist/trend/HIGHER_LOW_TRAIL/HigherLowTrail.js.map +1 -0
  119. package/dist/trend/HMA/HMA.d.ts +7 -0
  120. package/dist/trend/HMA/HMA.js +29 -0
  121. package/dist/trend/HMA/HMA.js.map +1 -0
  122. package/dist/trend/KAMA/KAMA.d.ts +6 -0
  123. package/dist/trend/KAMA/KAMA.js +29 -0
  124. package/dist/trend/KAMA/KAMA.js.map +1 -0
  125. package/dist/trend/LINREG/LinearRegression.d.ts +15 -0
  126. package/dist/trend/LINREG/LinearRegression.js +62 -0
  127. package/dist/trend/LINREG/LinearRegression.js.map +1 -0
  128. package/dist/trend/MA/MovingAverage.d.ts +5 -0
  129. package/dist/trend/MA/MovingAverage.js +9 -0
  130. package/dist/trend/MA/MovingAverage.js.map +1 -0
  131. package/dist/trend/MA/MovingAverageTypes.d.ts +7 -0
  132. package/dist/trend/MA/MovingAverageTypes.js +2 -0
  133. package/dist/trend/MA/MovingAverageTypes.js.map +1 -0
  134. package/dist/trend/PSAR/PSAR.d.ts +21 -0
  135. package/dist/trend/PSAR/PSAR.js +121 -0
  136. package/dist/trend/PSAR/PSAR.js.map +1 -0
  137. package/dist/trend/RMA/RMA.d.ts +10 -0
  138. package/dist/trend/RMA/RMA.js +43 -0
  139. package/dist/trend/RMA/RMA.js.map +1 -0
  140. package/dist/trend/SMA/SMA.d.ts +6 -0
  141. package/dist/trend/SMA/SMA.js +17 -0
  142. package/dist/trend/SMA/SMA.js.map +1 -0
  143. package/dist/trend/SMA15/SMA15.d.ts +7 -0
  144. package/dist/trend/SMA15/SMA15.js +24 -0
  145. package/dist/trend/SMA15/SMA15.js.map +1 -0
  146. package/dist/trend/SUPERTREND/SuperTrend.d.ts +21 -0
  147. package/dist/trend/SUPERTREND/SuperTrend.js +57 -0
  148. package/dist/trend/SUPERTREND/SuperTrend.js.map +1 -0
  149. package/dist/trend/SWING_HIGH/SwingHigh.d.ts +11 -0
  150. package/dist/trend/SWING_HIGH/SwingHigh.js +36 -0
  151. package/dist/trend/SWING_HIGH/SwingHigh.js.map +1 -0
  152. package/dist/trend/SWING_LOW/SwingLookback.d.ts +4 -0
  153. package/dist/trend/SWING_LOW/SwingLookback.js +5 -0
  154. package/dist/trend/SWING_LOW/SwingLookback.js.map +1 -0
  155. package/dist/trend/SWING_LOW/SwingLow.d.ts +11 -0
  156. package/dist/trend/SWING_LOW/SwingLow.js +36 -0
  157. package/dist/trend/SWING_LOW/SwingLow.js.map +1 -0
  158. package/dist/trend/TEMA/TEMA.d.ts +8 -0
  159. package/dist/trend/TEMA/TEMA.js +32 -0
  160. package/dist/trend/TEMA/TEMA.js.map +1 -0
  161. package/dist/trend/VSTOP/VolatilityStop.d.ts +18 -0
  162. package/dist/trend/VSTOP/VolatilityStop.js +52 -0
  163. package/dist/trend/VSTOP/VolatilityStop.js.map +1 -0
  164. package/dist/trend/VWAP/VWAP.d.ts +8 -0
  165. package/dist/trend/VWAP/VWAP.js +33 -0
  166. package/dist/trend/VWAP/VWAP.js.map +1 -0
  167. package/dist/trend/WMA/WMA.d.ts +8 -0
  168. package/dist/trend/WMA/WMA.js +27 -0
  169. package/dist/trend/WMA/WMA.js.map +1 -0
  170. package/dist/trend/WSMA/WSMA.d.ts +8 -0
  171. package/dist/trend/WSMA/WSMA.js +32 -0
  172. package/dist/trend/WSMA/WSMA.js.map +1 -0
  173. package/dist/trend/ZIGZAG/ZigZag.d.ts +11 -0
  174. package/dist/trend/ZIGZAG/ZigZag.js +48 -0
  175. package/dist/trend/ZIGZAG/ZigZag.js.map +1 -0
  176. package/dist/trend/index.d.ts +27 -0
  177. package/dist/trend/index.js +28 -0
  178. package/dist/trend/index.js.map +1 -0
  179. package/dist/util/addPercentageChange.d.ts +1 -0
  180. package/dist/util/addPercentageChange.js +4 -0
  181. package/dist/util/addPercentageChange.js.map +1 -0
  182. package/dist/util/getAverage.d.ts +1 -0
  183. package/dist/util/getAverage.js +4 -0
  184. package/dist/util/getAverage.js.map +1 -0
  185. package/dist/util/getGrid.d.ts +8 -0
  186. package/dist/util/getGrid.js +21 -0
  187. package/dist/util/getGrid.js.map +1 -0
  188. package/dist/util/getMaximum.d.ts +1 -0
  189. package/dist/util/getMaximum.js +10 -0
  190. package/dist/util/getMaximum.js.map +1 -0
  191. package/dist/util/getMedian.d.ts +1 -0
  192. package/dist/util/getMedian.js +11 -0
  193. package/dist/util/getMedian.js.map +1 -0
  194. package/dist/util/getMinimum.d.ts +1 -0
  195. package/dist/util/getMinimum.js +10 -0
  196. package/dist/util/getMinimum.js.map +1 -0
  197. package/dist/util/getPercentageChange.d.ts +1 -0
  198. package/dist/util/getPercentageChange.js +7 -0
  199. package/dist/util/getPercentageChange.js.map +1 -0
  200. package/dist/util/getQuartile.d.ts +1 -0
  201. package/dist/util/getQuartile.js +20 -0
  202. package/dist/util/getQuartile.js.map +1 -0
  203. package/dist/util/getShare.d.ts +1 -0
  204. package/dist/util/getShare.js +7 -0
  205. package/dist/util/getShare.js.map +1 -0
  206. package/dist/util/getStandardDeviation.d.ts +1 -0
  207. package/dist/util/getStandardDeviation.js +8 -0
  208. package/dist/util/getStandardDeviation.js.map +1 -0
  209. package/dist/util/getStreaks.d.ts +5 -0
  210. package/dist/util/getStreaks.js +28 -0
  211. package/dist/util/getStreaks.js.map +1 -0
  212. package/dist/util/getWeekday.d.ts +7 -0
  213. package/dist/util/getWeekday.js +28 -0
  214. package/dist/util/getWeekday.js.map +1 -0
  215. package/dist/util/index.d.ts +13 -0
  216. package/dist/util/index.js +14 -0
  217. package/dist/util/index.js.map +1 -0
  218. package/dist/util/pushUpdate.d.ts +1 -0
  219. package/dist/util/pushUpdate.js +13 -0
  220. package/dist/util/pushUpdate.js.map +1 -0
  221. package/dist/volatility/ABANDS/AccelerationBands.d.ts +22 -0
  222. package/dist/volatility/ABANDS/AccelerationBands.js +73 -0
  223. package/dist/volatility/ABANDS/AccelerationBands.js.map +1 -0
  224. package/dist/volatility/ATR/ATR.d.ts +10 -0
  225. package/dist/volatility/ATR/ATR.js +26 -0
  226. package/dist/volatility/ATR/ATR.js.map +1 -0
  227. package/dist/volatility/BBANDS/BollingerBands.d.ts +20 -0
  228. package/dist/volatility/BBANDS/BollingerBands.js +63 -0
  229. package/dist/volatility/BBANDS/BollingerBands.js.map +1 -0
  230. package/dist/volatility/BBW/BollingerBandsWidth.d.ts +8 -0
  231. package/dist/volatility/BBW/BollingerBandsWidth.js +19 -0
  232. package/dist/volatility/BBW/BollingerBandsWidth.js.map +1 -0
  233. package/dist/volatility/IQR/IQR.d.ts +8 -0
  234. package/dist/volatility/IQR/IQR.js +29 -0
  235. package/dist/volatility/IQR/IQR.js.map +1 -0
  236. package/dist/volatility/MAD/MAD.d.ts +9 -0
  237. package/dist/volatility/MAD/MAD.js +39 -0
  238. package/dist/volatility/MAD/MAD.js.map +1 -0
  239. package/dist/volatility/NATR/NATR.d.ts +10 -0
  240. package/dist/volatility/NATR/NATR.js +23 -0
  241. package/dist/volatility/NATR/NATR.js.map +1 -0
  242. package/dist/volatility/TR/TR.d.ts +7 -0
  243. package/dist/volatility/TR/TR.js +26 -0
  244. package/dist/volatility/TR/TR.js.map +1 -0
  245. package/dist/volatility/index.d.ts +8 -0
  246. package/dist/volatility/index.js +9 -0
  247. package/dist/volatility/index.js.map +1 -0
  248. package/dist/volume/AD/AD.d.ts +8 -0
  249. package/dist/volume/AD/AD.js +42 -0
  250. package/dist/volume/AD/AD.js.map +1 -0
  251. package/dist/volume/ADOSC/ADOSC.d.ts +15 -0
  252. package/dist/volume/ADOSC/ADOSC.js +45 -0
  253. package/dist/volume/ADOSC/ADOSC.js.map +1 -0
  254. package/dist/volume/CMF/CMF.d.ts +10 -0
  255. package/dist/volume/CMF/CMF.js +45 -0
  256. package/dist/volume/CMF/CMF.js.map +1 -0
  257. package/dist/volume/EMV/EMV.d.ts +10 -0
  258. package/dist/volume/EMV/EMV.js +50 -0
  259. package/dist/volume/EMV/EMV.js.map +1 -0
  260. package/dist/volume/PVT/PVT.d.ts +8 -0
  261. package/dist/volume/PVT/PVT.js +40 -0
  262. package/dist/volume/PVT/PVT.js.map +1 -0
  263. package/dist/volume/RVOL/RVOL.d.ts +7 -0
  264. package/dist/volume/RVOL/RVOL.js +48 -0
  265. package/dist/volume/RVOL/RVOL.js.map +1 -0
  266. package/dist/volume/VROC/VROC.d.ts +9 -0
  267. package/dist/volume/VROC/VROC.js +40 -0
  268. package/dist/volume/VROC/VROC.js.map +1 -0
  269. package/dist/volume/VWMA/VWMA.d.ts +11 -0
  270. package/dist/volume/VWMA/VWMA.js +51 -0
  271. package/dist/volume/VWMA/VWMA.js.map +1 -0
  272. package/dist/volume/index.d.ts +8 -0
  273. package/dist/volume/index.js +9 -0
  274. package/dist/volume/index.js.map +1 -0
  275. package/package.json +26 -51
  276. package/dist/index.cjs +0 -2131
  277. package/dist/index.d.cts +0 -579
  278. package/dist/index.d.mts +0 -579
  279. package/dist/index.mjs +0 -2074
package/README.md CHANGED
@@ -8,6 +8,8 @@ Technical indicators and overlays to run [technical analysis](https://en.wikiped
8
8
 
9
9
  The "trading-signals" library provides a TypeScript implementation for common technical indicators. It is well-suited for algorithmic trading, allowing developers to perform signal computations for automated trading strategies.
10
10
 
11
+ Financial trading does not require Python or C, so the goal here is to provide renowned technical indicators in TypeScript. Results are checked against reference data like [Tulip Indicators](https://tulipindicators.org/).
12
+
11
13
  All indicators can be updated over time by streaming data (prices or [candles](https://en.wikipedia.org/wiki/Candlestick_chart)) to the `add` method. Some indicators also provide `static` batch methods for further performance improvements when providing data up-front during a backtest or historical data import. You can try it out streaming input data by running the provided [demo script](./src/start/demo.ts) with `npm start`, which uses a keyboard input stream.
12
14
 
13
15
  ## Features
@@ -20,6 +22,78 @@ All indicators can be updated over time by streaming data (prices or [candles](h
20
22
  - **Zero Runtime Dependencies:** Minimal bundle size
21
23
  - **Type Safety:** Full TypeScript with strict mode
22
24
 
25
+ ## Supported Technical Indicators
26
+
27
+ 1. Acceleration Bands (ABANDS)
28
+ 1. Accelerator Oscillator (AC)
29
+ 1. Accumulation/Distribution (AD)
30
+ 1. Aroon (AROON)
31
+ 1. Average Directional Index (ADX)
32
+ 1. Average True Range (ATR)
33
+ 1. Awesome Oscillator (AO)
34
+ 1. Bollinger Bands (BBANDS)
35
+ 1. Bollinger Bands Width (BBW)
36
+ 1. Center of Gravity (CG)
37
+ 1. Chaikin Money Flow (CMF)
38
+ 1. Chaikin Oscillator (ADOSC)
39
+ 1. Chande Momentum Oscillator (CMO)
40
+ 1. Chandelier Exit (CE)
41
+ 1. Commodity Channel Index (CCI)
42
+ 1. Directional Movement Index (DMI / DX)
43
+ 1. Double Exponential Moving Average (DEMA)
44
+ 1. Dual Moving Average (DMA)
45
+ 1. Ease of Movement (EMV)
46
+ 1. Exponential Moving Average (EMA)
47
+ 1. Efficiency Ratio (ER)
48
+ 1. Hull Moving Average (HMA)
49
+ 1. Interquartile Range (IQR)
50
+ 1. Kaufman's Adaptive Moving Average (KAMA)
51
+ 1. Linear Regression (LINREG)
52
+ 1. Mean Absolute Deviation (MAD)
53
+ 1. Momentum (MOM / MTM)
54
+ 1. Money Flow Index (MFI)
55
+ 1. Moving Average Convergence Divergence (MACD)
56
+ 1. Normalized Average True Range (NATR)
57
+ 1. On-Balance Volume (OBV)
58
+ 1. Parabolic SAR (PSAR)
59
+ 1. Percentage Price Oscillator (PPO)
60
+ 1. Price Volume Trend (PVT)
61
+ 1. Range Expansion Index (REI)
62
+ 1. Rate-of-Change (ROC)
63
+ 1. Relative Moving Average (RMA)
64
+ 1. Relative Strength Index (RSI)
65
+ 1. Relative Volume (RVOL)
66
+ 1. Simple Moving Average (SMA)
67
+ 1. Spencer's 15-Point Moving Average (SMA15)
68
+ 1. Stochastic Oscillator (STOCH)
69
+ 1. Stochastic RSI (STOCHRSI)
70
+ 1. SuperTrend (SUPERTREND)
71
+ 1. Tom Demark's Sequential Indicator (TDS)
72
+ 1. Triple Exponential Moving Average (TEMA)
73
+ 1. Triple Smoothed EMA Rate of Change (TRIX)
74
+ 1. True Range (TR)
75
+ 1. Ultimate Oscillator (ULTOSC)
76
+ 1. Volatility Stop (VSTOP)
77
+ 1. Volume Rate of Change (VROC)
78
+ 1. Volume-Weighted Average Price (VWAP)
79
+ 1. Volume Weighted Moving Average (VWMA)
80
+ 1. Weighted Moving Average (WMA)
81
+ 1. Wilder's Smoothed Moving Average (WSMA / WWS / SMMA / MEMA)
82
+ 1. Williams %R (WILLR)
83
+ 1. Zig Zag Indicator (ZigZag)
84
+
85
+ Utility Methods:
86
+
87
+ 1. Average / Mean
88
+ 1. Grid Sizing (for [grid trading bots](https://b2broker.com/news/understanding-grid-trading-purpose-pros-cons/))
89
+ 1. Maximum
90
+ 1. Median
91
+ 1. Minimum
92
+ 1. Quartile
93
+ 1. Standard Deviation
94
+ 1. Streaks
95
+ 1. Weekday
96
+
23
97
  ## Installation
24
98
 
25
99
  ```bash
@@ -28,16 +102,16 @@ npm install trading-signals
28
102
 
29
103
  ## Usage
30
104
 
31
- **CommonJS:**
105
+ The library is published as ESM:
32
106
 
33
107
  ```ts
34
- const {SMA} = require('trading-signals');
108
+ import {SMA} from 'trading-signals';
35
109
  ```
36
110
 
37
- **ESM:**
111
+ CommonJS projects can load it via [`require(esm)`](https://nodejs.org/api/modules.html#loading-ecmascript-modules-using-require) on Node.js 20.19+:
38
112
 
39
113
  ```ts
40
- import {SMA} from 'trading-signals';
114
+ const {SMA} = require('trading-signals');
41
115
  ```
42
116
 
43
117
  **Example:**
@@ -61,10 +135,10 @@ sma.replace(40);
61
135
  // You can check if an indicator is stable:
62
136
  console.log(sma.isStable); // true
63
137
 
64
- // If an indicator is stable, you can get its result:
138
+ // You can read the result as "number | null", which is null until the indicator is stable:
65
139
  console.log(sma.getResult()); // 50.0003
66
140
 
67
- // You can also get the result without optional chaining:
141
+ // Or you can read it as "number" and let it throw while the indicator is not stable yet:
68
142
  console.log(sma.getResultOrThrow()); // 50.0003
69
143
 
70
144
  // Various precisions are available too:
@@ -76,77 +150,6 @@ console.log(sma.lowest?.toFixed(2)); // "23.33"
76
150
  console.log(sma.highest?.toFixed(2)); // "53.33"
77
151
  ```
78
152
 
79
- ### When to use `add(...)`?
80
-
81
- To input data, you need to call the indicator's `add` method. Depending on whether the minimum required input data for the interval has been reached, the `add` method may or may not return a result from the indicator.
82
-
83
- ### When to use `getResultOrThrow()`?
84
-
85
- You can call `getResultOrThrow()` at any point in time, but it throws errors unless an indicator has received the minimum amount of data. If you call `getResultOrThrow()` before an indicator has received the required amount of input values, a `NotEnoughDataError` will be thrown.
86
-
87
- **Example:**
88
-
89
- ```ts
90
- import {SMA} from 'trading-signals';
91
-
92
- // Our interval is 3, so we need 3 input values
93
- const sma = new SMA(3);
94
-
95
- // We supply 2 input values
96
- sma.add(10);
97
- sma.add(40);
98
-
99
- try {
100
- // We will get an error, because the minimum amount of inputs is 3
101
- sma.getResultOrThrow();
102
- } catch (error) {
103
- console.log(error.constructor.name); // "NotEnoughDataError"
104
- }
105
-
106
- // We will supply the 3rd input value
107
- sma.add(70);
108
-
109
- // Now, we will receive a proper result
110
- console.log(sma.getResultOrThrow()); // 40
111
- ```
112
-
113
- Most of the time, the minimum amount of data depends on the interval / time period used. If you're not sure, take a look at the test files for the indicator to see examples of correct usage.
114
-
115
- ### When to use `getRequiredInputs()`?
116
-
117
- Every indicator provides a `getRequiredInputs()` method that returns the minimum number of input values needed before the indicator becomes stable and can produce results. This is useful for validation and understanding when an indicator will start producing return values.
118
-
119
- **Example:**
120
-
121
- ```ts
122
- import {SMA, EMA, RSI} from 'trading-signals';
123
-
124
- const sma = new SMA(5);
125
- console.log(sma.getRequiredInputs()); // 5
126
- ```
127
-
128
- The required inputs often depend on the indicator's configuration (like interval/period) and its internal calculation requirements. Some indicators like **MACD** or **Stochastic Oscillator** may require more inputs than their primary period because they use multiple moving averages or lookback periods internally.
129
-
130
- ### When to use `getSignal()`?
131
-
132
- Many momentum and trend indicators provide a `getSignal()` method that returns the current trading signal state along with change detection. This is useful for identifying potential trading opportunities.
133
-
134
- **Example:**
135
-
136
- ```ts
137
- import {RSI} from 'trading-signals';
138
-
139
- const rsi = new RSI(14);
140
-
141
- // Add price data
142
- // ...
143
-
144
- // Get the trading signal
145
- const signal = rsi.getSignal();
146
- console.log(signal.state); // "BEARISH", "BULLISH", "SIDEWAYS", or "UNKNOWN"
147
- console.log(signal.hasChanged); // true if the signal state changed from the previous value
148
- ```
149
-
150
153
  ## Technical Indicator Types
151
154
 
152
155
  ### Indicator Function
@@ -173,74 +176,6 @@ console.log(signal.hasChanged); // true if the signal state changed from the pre
173
176
  - Indicators: Have no upper or lower limits
174
177
  - Oscillators: Move within a fixed range (e.g. 0-100, –1 to +1)
175
178
 
176
- ## Supported Technical Indicators
177
-
178
- 1. Acceleration Bands (ABANDS)
179
- 1. Accelerator Oscillator (AC)
180
- 1. Average Directional Index (ADX)
181
- 1. Average True Range (ATR)
182
- 1. Awesome Oscillator (AO)
183
- 1. Bollinger Bands (BBANDS)
184
- 1. Bollinger Bands Width (BBW)
185
- 1. Center of Gravity (CG)
186
- 1. Commodity Channel Index (CCI)
187
- 1. Directional Movement Index (DMI / DX)
188
- 1. Double Exponential Moving Average (DEMA)
189
- 1. Dual Moving Average (DMA)
190
- 1. Exponential Moving Average (EMA)
191
- 1. Interquartile Range (IQR)
192
- 1. Linear Regression (LINREG)
193
- 1. Mean Absolute Deviation (MAD)
194
- 1. Momentum (MOM / MTM)
195
- 1. Moving Average Convergence Divergence (MACD)
196
- 1. On-Balance Volume (OBV)
197
- 1. Parabolic SAR (PSAR)
198
- 1. Range Expansion Index (REI)
199
- 1. Rate-of-Change (ROC)
200
- 1. Relative Moving Average (RMA)
201
- 1. Relative Strength Index (RSI)
202
- 1. Simple Moving Average (SMA)
203
- 1. Spencer's 15-Point Moving Average (SMA15)
204
- 1. Stochastic Oscillator (STOCH)
205
- 1. Stochastic RSI (STOCHRSI)
206
- 1. Tom Demark's Sequential Indicator (TDS)
207
- 1. True Range (TR)
208
- 1. Volume-Weighted Average Price (VWAP)
209
- 1. Weighted Moving Average (WMA)
210
- 1. Wilder's Smoothed Moving Average (WSMA / WWS / SMMA / MEMA)
211
- 1. Williams %R (WILLR)
212
- 1. Zig Zag Indicator (ZigZag)
213
-
214
- Utility Methods:
215
-
216
- 1. Average / Mean
217
- 1. Grid Sizing (for [grid trading bots](https://b2broker.com/news/understanding-grid-trading-purpose-pros-cons/))
218
- 1. Maximum
219
- 1. Median
220
- 1. Minimum
221
- 1. Quartile
222
- 1. Standard Deviation
223
- 1. Streaks
224
- 1. Weekday
225
-
226
- ## Performance
227
-
228
- ### Floating-point arithmetic caveats
229
-
230
- JavaScript uses double-precision floating-point arithmetic. For example, `0.1 + 0.2` yields `0.30000000000000004` due to binary floating-point representation.
231
-
232
- ![JavaScript arithmetic](https://raw.githubusercontent.com/bennycode/trading-signals/main/packages/trading-signals/js-arithmetic.png)
233
-
234
- While this isn’t perfectly accurate, it usually doesn’t matter in practice since indicators often work with averages, which already smooth out precision. In test cases, you can control precision by using Vitest’s [toBeCloseTo](https://vitest.dev/api/expect.html#tobecloseto) assertion.
235
-
236
- Earlier versions of this library (up to version 6) used [big.js][1] for arbitrary-precision arithmetic, but that made calculations about 100x slower on average. For this reason, support for [big.js][1] was removed starting with version 7.
237
-
238
- ## Disclaimer
239
-
240
- The information and publications of [trading-signals](https://github.com/bennycode/trading-signals) do not constitute financial advice, investment advice, trading advice or any other form of advice. All results from [trading-signals](https://github.com/bennycode/trading-signals) are intended for information purposes only.
241
-
242
- It is very important to do your own analysis before making any investment based on your own personal circumstances. If you need financial advice or further advice in general, it is recommended that you identify a relevantly qualified individual in your jurisdiction who can advise you accordingly.
243
-
244
179
  ## Alternatives
245
180
 
246
181
  - [Cloud9Trader Indicators (JavaScript)](https://github.com/Cloud9Trader/TechnicalIndicators)
@@ -260,25 +195,10 @@ It is very important to do your own analysis before making any investment based
260
195
  - [Technical Analysis Library using Pandas and Numpy (Python)](https://github.com/bukosabino/ta)
261
196
  - [Tulip Indicators (ANSI C)](https://github.com/TulipCharts/tulipindicators)
262
197
 
263
- ## Documentation
264
-
265
- Build and run the documentation:
266
-
267
- ```bash
268
- npm run docs
269
- ```
270
-
271
198
  ## Maintainers
272
199
 
273
200
  [![Benny Neugebauer on Stack Exchange][stack_exchange_bennycode_badge]][stack_exchange_bennycode_url]
274
201
 
275
- ## ⭐️ Become a TypeScript rockstar! ⭐️
276
-
277
- This package was built by Benny Neugebauer. Checkout my [**TypeScript course**](https://typescript.tv/) to become a coding rockstar!
278
-
279
- [<img src="https://raw.githubusercontent.com/bennycode/trading-signals/main/packages/trading-signals/tstv.png">](https://typescript.tv/)
280
-
281
- [1]: http://mikemcl.github.io/big.js/
282
202
  [stack_exchange_bennycode_badge]: https://stackexchange.com/users/flair/203782.png?theme=default
283
203
  [stack_exchange_bennycode_url]: https://stackexchange.com/users/203782/benny-neugebauer?tab=accounts
284
204
 
@@ -0,0 +1,5 @@
1
+ export type BandsResult = {
2
+ lower: number;
3
+ middle: number;
4
+ upper: number;
5
+ };
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=BandsResult.type.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"BandsResult.type.js","sourceRoot":"","sources":["../../src/base/BandsResult.type.ts"],"names":[],"mappings":""}
@@ -0,0 +1,14 @@
1
+ export type HighLow<T = number> = {
2
+ high: T;
3
+ low: T;
4
+ };
5
+ export type HighLowClose<T = number> = HighLow<T> & {
6
+ close: T;
7
+ };
8
+ export type OpenHighLowClose<T = number> = HighLowClose<T> & {
9
+ open: T;
10
+ };
11
+ export type OpenHighLowCloseVolume<T = number> = OpenHighLowClose<T> & {
12
+ volume: T;
13
+ };
14
+ export type HighLowCloseVolume<T = number> = Omit<OpenHighLowCloseVolume<T>, 'open'>;
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=Candle.type.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"Candle.type.js","sourceRoot":"","sources":["../../src/base/Candle.type.ts"],"names":[],"mappings":""}
@@ -0,0 +1,44 @@
1
+ type Nullable<Result> = Result | null;
2
+ interface Indicator<Result = number, Input = number> {
3
+ isStable: boolean;
4
+ add(input: Input): Nullable<Result>;
5
+ getRequiredInputs(): number;
6
+ getResult(): Nullable<Result>;
7
+ getResultOrThrow(): Result;
8
+ replace(input: Input): Nullable<Result>;
9
+ update(input: Input, replace: boolean): Nullable<Result>;
10
+ updates(input: Input[], replace: boolean): Nullable<Result>[];
11
+ }
12
+ export declare const TradingSignal: {
13
+ readonly BEARISH: 'BEARISH';
14
+ readonly BULLISH: 'BULLISH';
15
+ readonly SIDEWAYS: 'SIDEWAYS';
16
+ readonly UNKNOWN: 'UNKNOWN';
17
+ };
18
+ export type TradingSignals = (typeof TradingSignal)[keyof typeof TradingSignal];
19
+ export declare abstract class TechnicalIndicator<Result, Input> implements Indicator<Result, Input> {
20
+ protected result: Result | undefined;
21
+ abstract getRequiredInputs(): number;
22
+ getResult(): (Result & {}) | null;
23
+ getResultOrThrow(): Result & ({} | null);
24
+ get isStable(): boolean;
25
+ add(input: Input): Result | null;
26
+ replace(input: Input): Result | null;
27
+ abstract update(input: Input, replace: boolean): Result | null;
28
+ updates(inputs: readonly Input[], replace?: boolean): (Result | null)[];
29
+ }
30
+ export declare abstract class IndicatorSeries<Input = number> extends TechnicalIndicator<number, Input> {
31
+ protected previousResult?: number;
32
+ protected setResult(value: number, replace: boolean): number;
33
+ protected rollbackLastResult(): void;
34
+ }
35
+ export declare abstract class TrendIndicatorSeries<Input = number, SignalState = TradingSignals> extends IndicatorSeries<Input> {
36
+ #private;
37
+ protected abstract calculateSignalState(result?: number | null | undefined): SignalState;
38
+ protected setResult(value: number, replace: boolean): number;
39
+ getSignal(): {
40
+ state: SignalState;
41
+ hasChanged: boolean;
42
+ };
43
+ }
44
+ export {};
@@ -0,0 +1,70 @@
1
+ import { NotEnoughDataError } from '../error/NotEnoughDataError.js';
2
+ export const TradingSignal = {
3
+ BEARISH: 'BEARISH',
4
+ BULLISH: 'BULLISH',
5
+ SIDEWAYS: 'SIDEWAYS',
6
+ UNKNOWN: 'UNKNOWN',
7
+ };
8
+ export class TechnicalIndicator {
9
+ result;
10
+ getResult() {
11
+ try {
12
+ return this.getResultOrThrow();
13
+ }
14
+ catch {
15
+ return null;
16
+ }
17
+ }
18
+ getResultOrThrow() {
19
+ if (this.result === undefined) {
20
+ throw new NotEnoughDataError(this.getRequiredInputs());
21
+ }
22
+ return this.result;
23
+ }
24
+ get isStable() {
25
+ return this.result !== undefined;
26
+ }
27
+ add(input) {
28
+ return this.update(input, false);
29
+ }
30
+ replace(input) {
31
+ return this.update(input, true);
32
+ }
33
+ updates(inputs, replace = false) {
34
+ return inputs.map(input => this.update(input, replace));
35
+ }
36
+ }
37
+ export class IndicatorSeries extends TechnicalIndicator {
38
+ previousResult;
39
+ setResult(value, replace) {
40
+ if (replace) {
41
+ this.result = this.previousResult;
42
+ }
43
+ this.previousResult = this.result;
44
+ return (this.result = value);
45
+ }
46
+ rollbackLastResult() {
47
+ this.result = this.previousResult;
48
+ }
49
+ }
50
+ export class TrendIndicatorSeries extends IndicatorSeries {
51
+ #previousSignalState;
52
+ setResult(value, replace) {
53
+ if (replace && this.previousResult !== undefined) {
54
+ this.#previousSignalState = this.calculateSignalState(this.previousResult);
55
+ }
56
+ else if (!replace) {
57
+ this.#previousSignalState = this.calculateSignalState(this.result);
58
+ }
59
+ return super.setResult(value, replace);
60
+ }
61
+ getSignal() {
62
+ const currentState = this.calculateSignalState(this.getResult());
63
+ const hasChanged = this.#previousSignalState !== undefined && this.#previousSignalState !== currentState;
64
+ return {
65
+ hasChanged,
66
+ state: currentState,
67
+ };
68
+ }
69
+ }
70
+ //# sourceMappingURL=Indicator.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"Indicator.js","sourceRoot":"","sources":["../../src/base/Indicator.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,kBAAkB,EAAC,MAAM,gCAAgC,CAAC;AAelE,MAAM,CAAC,MAAM,aAAa,GAAG;IAC3B,OAAO,EAAE,SAAS;IAClB,OAAO,EAAE,SAAS;IAClB,QAAQ,EAAE,UAAU;IACpB,OAAO,EAAE,SAAS;CACV,CAAC;AAOX,MAAM,OAAgB,kBAAkB;IAC5B,MAAM,CAAqB;IAIrC,SAAS;QACP,IAAI,CAAC;YACH,OAAO,IAAI,CAAC,gBAAgB,EAAE,CAAC;QACjC,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,IAAI,CAAC;QACd,CAAC;IACH,CAAC;IAED,gBAAgB;QACd,IAAI,IAAI,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;YAC9B,MAAM,IAAI,kBAAkB,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC,CAAC;QACzD,CAAC;QAED,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED,IAAI,QAAQ;QACV,OAAO,IAAI,CAAC,MAAM,KAAK,SAAS,CAAC;IACnC,CAAC;IAED,GAAG,CAAC,KAAY;QACd,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;IACnC,CAAC;IAED,OAAO,CAAC,KAAY;QAClB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;IAClC,CAAC;IAID,OAAO,CAAC,MAAwB,EAAE,OAAO,GAAY,KAAK;QACxD,OAAO,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC,CAAC;IAC1D,CAAC;CACF;AAKD,MAAM,OAAgB,eAAgC,SAAQ,kBAAiC;IACnF,cAAc,CAAU;IAExB,SAAS,CAAC,KAAa,EAAE,OAAgB;QAEjD,IAAI,OAAO,EAAE,CAAC;YACZ,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,cAAc,CAAC;QACpC,CAAC;QAGD,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,MAAM,CAAC;QAGlC,OAAO,CAAC,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC,CAAC;IAC/B,CAAC;IAQS,kBAAkB;QAC1B,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,cAAc,CAAC;IACpC,CAAC;CACF;AAKD,MAAM,OAAgB,oBAGpB,SAAQ,eAAsB;IAE9B,oBAAoB,CAAe;IAEhB,SAAS,CAAC,KAAa,EAAE,OAAgB;QAE1D,IAAI,OAAO,IAAI,IAAI,CAAC,cAAc,KAAK,SAAS,EAAE,CAAC;YACjD,IAAI,CAAC,oBAAoB,GAAG,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QAC7E,CAAC;aAAM,IAAI,CAAC,OAAO,EAAE,CAAC;YAEpB,IAAI,CAAC,oBAAoB,GAAG,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACrE,CAAC;QAED,OAAO,KAAK,CAAC,SAAS,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;IACzC,CAAC;IAED,SAAS;QAIP,MAAM,YAAY,GAAG,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC,CAAC;QACjE,MAAM,UAAU,GAAG,IAAI,CAAC,oBAAoB,KAAK,SAAS,IAAI,IAAI,CAAC,oBAAoB,KAAK,YAAY,CAAC;QAEzG,OAAO;YACL,UAAU;YACV,KAAK,EAAE,YAAY;SACpB,CAAC;IACJ,CAAC;CACF"}
@@ -0,0 +1,18 @@
1
+ import { TechnicalIndicator } from './Indicator.js';
2
+ export type PeriodResult = {
3
+ highest: number;
4
+ lowest: number;
5
+ };
6
+ export declare class Period extends TechnicalIndicator<PeriodResult, number> {
7
+ #private;
8
+ values: number[];
9
+ get highest(): number | undefined;
10
+ get lowest(): number | undefined;
11
+ readonly interval: number;
12
+ constructor(interval: number);
13
+ getRequiredInputs(): number;
14
+ update(value: number, replace: boolean): {
15
+ highest: number;
16
+ lowest: number;
17
+ } | null;
18
+ }
@@ -0,0 +1,35 @@
1
+ import { TechnicalIndicator } from './Indicator.js';
2
+ import { pushUpdate } from '../util/pushUpdate.js';
3
+ export class Period extends TechnicalIndicator {
4
+ values;
5
+ #highest;
6
+ #lowest;
7
+ get highest() {
8
+ return this.#highest;
9
+ }
10
+ get lowest() {
11
+ return this.#lowest;
12
+ }
13
+ interval;
14
+ constructor(interval) {
15
+ super();
16
+ this.interval = interval;
17
+ this.values = [];
18
+ }
19
+ getRequiredInputs() {
20
+ return this.interval;
21
+ }
22
+ update(value, replace) {
23
+ pushUpdate(this.values, replace, value, this.interval);
24
+ if (this.values.length === this.interval) {
25
+ this.#lowest = Math.min(...this.values);
26
+ this.#highest = Math.max(...this.values);
27
+ return (this.result = {
28
+ highest: this.#highest,
29
+ lowest: this.#lowest,
30
+ });
31
+ }
32
+ return null;
33
+ }
34
+ }
35
+ //# sourceMappingURL=Period.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"Period.js","sourceRoot":"","sources":["../../src/base/Period.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,kBAAkB,EAAC,MAAM,gBAAgB,CAAC;AAClD,OAAO,EAAC,UAAU,EAAC,MAAM,uBAAuB,CAAC;AAOjD,MAAM,OAAO,MAAO,SAAQ,kBAAwC;IAC3D,MAAM,CAAW;IAExB,QAAQ,CAAU;IAElB,OAAO,CAAU;IAEjB,IAAI,OAAO;QACT,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAED,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAEe,QAAQ,CAAS;IAEjC,YAAY,QAAgB;QAC1B,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,MAAM,GAAG,EAAE,CAAC;IACnB,CAAC;IAEQ,iBAAiB;QACxB,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAED,MAAM,CAAC,KAAa,EAAE,OAAgB;QACpC,UAAU,CAAC,IAAI,CAAC,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;QAEvD,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,KAAK,IAAI,CAAC,QAAQ,EAAE,CAAC;YACzC,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC;YACxC,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC;YACzC,OAAO,CAAC,IAAI,CAAC,MAAM,GAAG;gBACpB,OAAO,EAAE,IAAI,CAAC,QAAQ;gBACtB,MAAM,EAAE,IAAI,CAAC,OAAO;aACrB,CAAC,CAAC;QACL,CAAC;QAED,OAAO,IAAI,CAAC;IACd,CAAC;CACF"}
@@ -0,0 +1,4 @@
1
+ export type SignalThresholds = {
2
+ overbought?: number;
3
+ oversold?: number;
4
+ };
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=SignalThresholds.type.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"SignalThresholds.type.js","sourceRoot":"","sources":["../../src/base/SignalThresholds.type.ts"],"names":[],"mappings":""}
@@ -0,0 +1,5 @@
1
+ export * from './BandsResult.type.js';
2
+ export * from './Candle.type.js';
3
+ export * from './Indicator.js';
4
+ export * from './Period.js';
5
+ export * from './SignalThresholds.type.js';
@@ -0,0 +1,6 @@
1
+ export * from './BandsResult.type.js';
2
+ export * from './Candle.type.js';
3
+ export * from './Indicator.js';
4
+ export * from './Period.js';
5
+ export * from './SignalThresholds.type.js';
6
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/base/index.ts"],"names":[],"mappings":"AAAA,cAAc,uBAAuB,CAAC;AACtC,cAAc,kBAAkB,CAAC;AACjC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,aAAa,CAAC;AAC5B,cAAc,4BAA4B,CAAC"}
@@ -0,0 +1,3 @@
1
+ export declare class NotEnoughDataError extends Error {
2
+ constructor(requiredAmount: number);
3
+ }
@@ -0,0 +1,8 @@
1
+ export class NotEnoughDataError extends Error {
2
+ constructor(requiredAmount) {
3
+ super(`Not enough data. A minimum of "${requiredAmount}" inputs is required to perform the computation.`);
4
+ Object.setPrototypeOf(this, new.target.prototype);
5
+ this.name = 'NotEnoughDataError';
6
+ }
7
+ }
8
+ //# sourceMappingURL=NotEnoughDataError.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"NotEnoughDataError.js","sourceRoot":"","sources":["../../src/error/NotEnoughDataError.ts"],"names":[],"mappings":"AAAA,MAAM,OAAO,kBAAmB,SAAQ,KAAK;IAC3C,YAAY,cAAsB;QAChC,KAAK,CAAC,kCAAkC,cAAc,kDAAkD,CAAC,CAAC;QAC1G,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,IAAI,MAAM,CAAC,SAAS,CAAC,CAAC;QAClD,IAAI,CAAC,IAAI,GAAG,oBAAoB,CAAC;IACnC,CAAC;CACF"}
@@ -0,0 +1 @@
1
+ export * from './NotEnoughDataError.js';
@@ -0,0 +1,2 @@
1
+ export * from './NotEnoughDataError.js';
2
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/error/index.ts"],"names":[],"mappings":"AAAA,cAAc,yBAAyB,CAAC"}
@@ -0,0 +1,7 @@
1
+ export * from './error/index.js';
2
+ export * from './momentum/index.js';
3
+ export * from './trend/index.js';
4
+ export * from './base/index.js';
5
+ export * from './util/index.js';
6
+ export * from './volatility/index.js';
7
+ export * from './volume/index.js';
package/dist/index.js ADDED
@@ -0,0 +1,8 @@
1
+ export * from './error/index.js';
2
+ export * from './momentum/index.js';
3
+ export * from './trend/index.js';
4
+ export * from './base/index.js';
5
+ export * from './util/index.js';
6
+ export * from './volatility/index.js';
7
+ export * from './volume/index.js';
8
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,kBAAkB,CAAC;AACjC,cAAc,qBAAqB,CAAC;AACpC,cAAc,kBAAkB,CAAC;AACjC,cAAc,iBAAiB,CAAC;AAChC,cAAc,iBAAiB,CAAC;AAChC,cAAc,uBAAuB,CAAC;AACtC,cAAc,mBAAmB,CAAC"}
@@ -0,0 +1,17 @@
1
+ import { SMA } from '../../trend/SMA/SMA.js';
2
+ import type { HighLow } from '../../base/Candle.type.js';
3
+ import { TrendIndicatorSeries } from '../../base/Indicator.js';
4
+ import { AO } from '../AO/AO.js';
5
+ import { MOM } from '../MOM/MOM.js';
6
+ export declare class AC extends TrendIndicatorSeries<HighLow<number>> {
7
+ readonly ao: AO;
8
+ readonly momentum: MOM;
9
+ readonly signal: SMA;
10
+ readonly shortAO: number;
11
+ readonly longAO: number;
12
+ readonly signalInterval: number;
13
+ constructor(shortAO: number, longAO: number, signalInterval: number);
14
+ getRequiredInputs(): number;
15
+ update(input: HighLow<number>, replace: boolean): number | null;
16
+ protected calculateSignalState(result: number | null | undefined): "BEARISH" | "BULLISH" | "UNKNOWN";
17
+ }