garch 1.2.3 → 1.2.4

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 (2) hide show
  1. package/package.json +6 -1
  2. package/types.d.ts +8 -0
package/package.json CHANGED
@@ -1,7 +1,12 @@
1
1
  {
2
2
  "name": "garch",
3
- "version": "1.2.3",
3
+ "version": "1.2.4",
4
4
  "description": "GARCH and EGARCH volatility models for TypeScript",
5
+ "funding": {
6
+ "type": "individual",
7
+ "url": "http://paypal.me/tripolskypetr"
8
+ },
9
+ "homepage": "https://backtest-kit.github.io/documents/article_07_ai_news_trading_signals.html",
5
10
  "type": "module",
6
11
  "main": "./build/index.cjs",
7
12
  "module": "./build/index.mjs",
package/types.d.ts CHANGED
@@ -498,13 +498,21 @@ declare function probit(confidence: number): number;
498
498
 
499
499
  type CandleInterval = '1m' | '3m' | '5m' | '15m' | '30m' | '1h' | '2h' | '4h' | '6h' | '8h';
500
500
  interface PredictionResult {
501
+ /** Reference price used to compute the corridor (last close or the value passed as `currentPrice`). */
501
502
  currentPrice: number;
503
+ /** One-period (or cumulative) volatility estimate, as a decimal log-return standard deviation (e.g. `0.012` = 1.2%). */
502
504
  sigma: number;
505
+ /** Upward expected move in price units: `upperPrice - currentPrice`. */
503
506
  move: number;
507
+ /** Upward expected move in percent (0–100 scale, e.g. `1.21` means 1.21%). Equal to `(exp(z·σ) - 1) * 100`. */
504
508
  movePercent: number;
509
+ /** Upper price band: `currentPrice · exp(+z·σ)`. */
505
510
  upperPrice: number;
511
+ /** Lower price band: `currentPrice · exp(-z·σ)`. Always positive. */
506
512
  lowerPrice: number;
513
+ /** Volatility model auto-selected by QLIKE. */
507
514
  modelType: 'garch' | 'egarch' | 'gjr-garch' | 'har-rv' | 'novas';
515
+ /** `true` when the model converged, persistence < 0.999, and Ljung-Box p-value ≥ 0.05. */
508
516
  reliable: boolean;
509
517
  }
510
518
  /**