Skip to content
TotalFinance

Technical analysis · @insiderfinance/totalfinance

@insiderfinance/totalfinance/technical-analysis/volatility

import { … } from '@insiderfinance/totalfinance/technical-analysis/volatility'
stable-by-law (pre-1.0; not a 1.0 stability guarantee)iface 19class 11fn 25JSON ↗

Functions · 25

Classes · 11

Interfaces · 19

iface

AberrationParameters

#

Public declaration. Read the signature and member contracts below; no additional behaviour is inferred.

Signature
import type { AberrationParameters } from '@insiderfinance/totalfinance/technical-analysis/volatility';

// ───────────────────────── Aberration ─────────────────────────
export interface AberrationParameters {
    /** SMA length for the zero-line of HLC3. Default 5. */
    period?: number;
    /** ATR length for the band offset. Default 15. */
    atrPeriod?: number;
}
Fields, parameters and returned members (2)
Name · typeMeaning · unitRequired · default
atrPeriodnumber

ATR length for the band offset. Default 15.

unitless by name
OptionalNo @default declared
periodnumber

SMA length for the zero-line of HLC3. Default 5.

unitless by name
OptionalNo @default declared

Stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Units come from declared names; “unitless by name” means the name alone does not establish a unit. See conventions and errors and warnings.

iface

AberrationPoint

#

Public declaration. Read the signature and member contracts below; no additional behaviour is inferred.

Signature
import type { AberrationPoint } from '@insiderfinance/totalfinance/technical-analysis/volatility';

export interface AberrationPoint {
    /** Zero-line: SMA of HLC3. */
    zeroLine: number;
    /** Upper band: zeroLine + ATR. */
    upperBand: number;
    /** Lower band: zeroLine − ATR. */
    lowerBand: number;
    /** The ATR offset itself. */
    atr: number;
}
Fields, parameters and returned members (4)
Name · typeMeaning · unitRequired · default
atrnumber

The ATR offset itself.

unitless by name
RequiredNo @default declared
lowerBandnumber

Lower band: zeroLine − ATR.

unitless by name
RequiredNo @default declared
upperBandnumber

Upper band: zeroLine + ATR.

unitless by name
RequiredNo @default declared
zeroLinenumber

Zero-line: SMA of HLC3.

unitless by name
RequiredNo @default declared

Stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Units come from declared names; “unitless by name” means the name alone does not establish a unit. See conventions and errors and warnings.

iface

AccelerationBandsParameters

#

Public declaration. Read the signature and member contracts below; no additional behaviour is inferred.

Signature
import type { AccelerationBandsParameters } from '@insiderfinance/totalfinance/technical-analysis/volatility';

// ───────────────────────── Acceleration Bands ─────────────────────────
export interface AccelerationBandsParameters {
    period?: number;
    /** Width factor on the high−low/high+low ratio. Default 4. */
    multiplier?: number;
}
Fields, parameters and returned members (2)
Name · typeMeaning · unitRequired · default
multipliernumber

Width factor on the high−low/high+low ratio. Default 4.

unitless by name
OptionalNo @default declared
periodnumber—unitless by nameOptionalNo @default declared

Stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Units come from declared names; “unitless by name” means the name alone does not establish a unit. See conventions and errors and warnings.

iface

AtrBandsParameters

#

Public declaration. Read the signature and member contracts below; no additional behaviour is inferred.

Signature
import type { AtrBandsParameters } from '@insiderfinance/totalfinance/technical-analysis/volatility';

// ───────────────────────── ATR Bands ─────────────────────────
export interface AtrBandsParameters {
    period?: number;
    multiplier?: number;
}
Fields, parameters and returned members (2)
Name · typeMeaning · unitRequired · default
multipliernumber—unitless by nameOptionalNo @default declared
periodnumber—unitless by nameOptionalNo @default declared

Stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Units come from declared names; “unitless by name” means the name alone does not establish a unit. See conventions and errors and warnings.

class

BollingerBandFieldStream

#

Public declaration. Read the signature and member contracts below; no additional behaviour is inferred.

Signature
import { BollingerBandFieldStream } from '@insiderfinance/totalfinance/technical-analysis/volatility';

export declare class BollingerBandFieldStream implements IndicatorStream<number, number> {
  constructor(parameters: { period: number; standardDeviation: number; field: 'bandwidth' | 'percentB'; kind: string; });
  static restore(field: 'bandwidth' | 'percentB', kind: string): (s: TechnicalAnalysisSnapshot) => BollingerBandFieldStream;
  value: number | null;
  next(value: number): number | null;
  toJSON(): TechnicalAnalysisSnapshot;
}
Fields, parameters and returned members (18)

Loading 18 members…

Stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Units come from declared names; “unitless by name” means the name alone does not establish a unit. See conventions and errors and warnings.

iface

BollingerParameters

#

Public declaration. Read the signature and member contracts below; no additional behaviour is inferred.

Signature
import type { BollingerParameters } from '@insiderfinance/totalfinance/technical-analysis/volatility';

// ───────────────────────── Bollinger Width & %B ─────────────────────────
export interface BollingerParameters {
    period: number;
    standardDeviation?: number;
}
Fields, parameters and returned members (2)
Name · typeMeaning · unitRequired · default
periodnumber—unitless by nameRequiredNo @default declared
standardDeviationnumber—unitless by nameOptionalNo @default declared

Stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Units come from declared names; “unitless by name” means the name alone does not establish a unit. See conventions and errors and warnings.

iface

ChaikinVolatilityParameters

#

Public declaration. Read the signature and member contracts below; no additional behaviour is inferred.

Signature
import type { ChaikinVolatilityParameters } from '@insiderfinance/totalfinance/technical-analysis/volatility';

// ───────────────────────── Chaikin Volatility ─────────────────────────
export interface ChaikinVolatilityParameters {
    period: number;
    rocPeriod?: number;
}
Fields, parameters and returned members (2)
Name · typeMeaning · unitRequired · default
periodnumber—unitless by nameRequiredNo @default declared
rocPeriodnumber—unitless by nameOptionalNo @default declared

Stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Units come from declared names; “unitless by name” means the name alone does not establish a unit. See conventions and errors and warnings.

class

ChaikinVolatilityStream

#

Public declaration. Read the signature and member contracts below; no additional behaviour is inferred.

Signature
import { ChaikinVolatilityStream } from '@insiderfinance/totalfinance/technical-analysis/volatility';

export declare class ChaikinVolatilityStream implements IndicatorStream<BarInput, number> {
  constructor(parameters: { period: number; rocPeriod: number; });
  static fromJSON(snapshot: TechnicalAnalysisSnapshot): ChaikinVolatilityStream;
  value: number | null;
  next(bar: BarInput): number | null;
  toJSON(): TechnicalAnalysisSnapshot;
}
Fields, parameters and returned members (26)

Loading 26 members…

Stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Units come from declared names; “unitless by name” means the name alone does not establish a unit. See conventions and errors and warnings.

iface

ChannelPoint

#

Public declaration. Read the signature and member contracts below; no additional behaviour is inferred.

Signature
import type { ChannelPoint } from '@insiderfinance/totalfinance/technical-analysis/volatility';

export interface ChannelPoint {
    upper: number;
    middle: number;
    lower: number;
}
Fields, parameters and returned members (3)
Name · typeMeaning · unitRequired · default
lowernumber—unitless by nameRequiredNo @default declared
middlenumber—unitless by nameRequiredNo @default declared
uppernumber—unitless by nameRequiredNo @default declared

Stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Units come from declared names; “unitless by name” means the name alone does not establish a unit. See conventions and errors and warnings.

class

DonchianStream

#

Public declaration. Read the signature and member contracts below; no additional behaviour is inferred.

Signature
import { DonchianStream } from '@insiderfinance/totalfinance/technical-analysis/volatility';

export declare class DonchianStream implements IndicatorStream<BarInput, ChannelPoint> {
  constructor(period: number);
  static fromJSON(snapshot: TechnicalAnalysisSnapshot): DonchianStream;
  value: ChannelPoint | null;
  next(bar: BarInput): ChannelPoint | null;
  toJSON(): TechnicalAnalysisSnapshot;
}
Fields, parameters and returned members (36)

Loading 36 members…

Stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Units come from declared names; “unitless by name” means the name alone does not establish a unit. See conventions and errors and warnings.

iface

ElderThermometerParameters

#

Public declaration. Read the signature and member contracts below; no additional behaviour is inferred.

Signature
import type { ElderThermometerParameters } from '@insiderfinance/totalfinance/technical-analysis/volatility';

// ───────────────────────── Elder's Market Thermometer ─────────────────────────
export interface ElderThermometerParameters {
    period?: number;
    /** "Quiet market" factor — thermo below `movingAverage·long` flags a long-friendly regime. Default 2. */
    long?: number;
    /** "Hot market" factor — thermo above `movingAverage·short` flags volatility. Default 0.5. */
    short?: number;
}
Fields, parameters and returned members (3)
Name · typeMeaning · unitRequired · default
longnumber

"Quiet market" factor — thermo below movingAverage·long flags a long-friendly regime. Default 2.

unitless by name
OptionalNo @default declared
periodnumber—unitless by nameOptionalNo @default declared
shortnumber

"Hot market" factor — thermo above movingAverage·short flags volatility. Default 0.5.

unitless by name
OptionalNo @default declared

Stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Units come from declared names; “unitless by name” means the name alone does not establish a unit. See conventions and errors and warnings.

iface

ElderThermometerPoint

#

Public declaration. Read the signature and member contracts below; no additional behaviour is inferred.

Signature
import type { ElderThermometerPoint } from '@insiderfinance/totalfinance/technical-analysis/volatility';

export interface ElderThermometerPoint {
    thermo: number;
    movingAverage: number;
    /** 1 when thermo < movingAverage·long (calm). */
    long: number;
    /** 1 when thermo > movingAverage·short (active). */
    short: number;
}
Fields, parameters and returned members (4)
Name · typeMeaning · unitRequired · default
longnumber

1 when thermo < movingAverage·long (calm).

unitless by name
RequiredNo @default declared
movingAveragenumber—unitless by nameRequiredNo @default declared
shortnumber

1 when thermo > movingAverage·short (active).

unitless by name
RequiredNo @default declared
thermonumber—unitless by nameRequiredNo @default declared

Stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Units come from declared names; “unitless by name” means the name alone does not establish a unit. See conventions and errors and warnings.

iface

HistoricalVolatilityParameters

#

Public declaration. Read the signature and member contracts below; no additional behaviour is inferred.

Signature
import type { HistoricalVolatilityParameters } from '@insiderfinance/totalfinance/technical-analysis/volatility';

// ───────────────────────── close-to-close historical volatility ─────────────────────────
export interface HistoricalVolatilityParameters {
    period: number;
    /** Bars per year: multiplies the per-bar σ by √annualization (252 daily, 52 weekly, 12 monthly); `1` = per-bar σ. Required. */
    annualization: number;
}
Fields, parameters and returned members (2)
Name · typeMeaning · unitRequired · default
annualizationnumber

Bars per year: multiplies the per-bar σ by √annualization (252 daily, 52 weekly, 12 monthly); 1 = per-bar σ. Required.

unitless by name
RequiredNo @default declared
periodnumber—unitless by nameRequiredNo @default declared

Stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Units come from declared names; “unitless by name” means the name alone does not establish a unit. See conventions and errors and warnings.

class

HistoricalVolatilityStream

#

Public declaration. Read the signature and member contracts below; no additional behaviour is inferred.

Signature
import { HistoricalVolatilityStream } from '@insiderfinance/totalfinance/technical-analysis/volatility';

export declare class HistoricalVolatilityStream implements IndicatorStream<number, number> {
  constructor(parameters: { period: number; scale: number; });
  static fromJSON(snapshot: TechnicalAnalysisSnapshot): HistoricalVolatilityStream;
  value: number | null;
  next(value: number): number | null;
  toJSON(): TechnicalAnalysisSnapshot;
}
Fields, parameters and returned members (21)

Loading 21 members…

Stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Units come from declared names; “unitless by name” means the name alone does not establish a unit. See conventions and errors and warnings.

iface

HoltWinterChannelParameters

#

Public declaration. Read the signature and member contracts below; no additional behaviour is inferred.

Signature
import type { HoltWinterChannelParameters } from '@insiderfinance/totalfinance/technical-analysis/volatility';

// ───────────────────────── Holt-Winters Channel ─────────────────────────
export interface HoltWinterChannelParameters {
    /** Level smoothing. Default 0.2. */
    levelSmoothing?: number;
    /** Trend smoothing. Default 0.1. */
    trendSmoothing?: number;
    /** Acceleration smoothing. Default 0.1. */
    accelerationSmoothing?: number;
    /** Variance smoothing for the channel width. Default 0.1. */
    varianceSmoothing?: number;
    /** Standard-deviation multiplier for the bands. Default 1. */
    scalar?: number;
}
Fields, parameters and returned members (5)
Name · typeMeaning · unitRequired · default
accelerationSmoothingnumber

Acceleration smoothing. Default 0.1.

unitless by name
OptionalNo @default declared
levelSmoothingnumber

Level smoothing. Default 0.2.

unitless by name
OptionalNo @default declared
scalarnumber

Standard-deviation multiplier for the bands. Default 1.

unitless by name
OptionalNo @default declared
trendSmoothingnumber

Trend smoothing. Default 0.1.

unitless by name
OptionalNo @default declared
varianceSmoothingnumber

Variance smoothing for the channel width. Default 0.1.

unitless by name
OptionalNo @default declared

Stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Units come from declared names; “unitless by name” means the name alone does not establish a unit. See conventions and errors and warnings.

iface

KeltnerParameters

#

Public declaration. Read the signature and member contracts below; no additional behaviour is inferred.

Signature
import type { KeltnerParameters } from '@insiderfinance/totalfinance/technical-analysis/volatility';

// ───────────────────────── Keltner Channels ─────────────────────────
export interface KeltnerParameters {
    /** EMA midline lookback. Defaults to 20 (the standard Keltner channel); echoed via `.explain()`. */
    period?: number;
    atrPeriod?: number;
    multiplier?: number;
}
Fields, parameters and returned members (3)
Name · typeMeaning · unitRequired · default
atrPeriodnumber—unitless by nameOptionalNo @default declared
multipliernumber—unitless by nameOptionalNo @default declared
periodnumber

EMA midline lookback. Defaults to 20 (the standard Keltner channel); echoed via .explain().

unitless by name
OptionalNo @default declared

Stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Units come from declared names; “unitless by name” means the name alone does not establish a unit. See conventions and errors and warnings.

class

KeltnerStream

#

Public declaration. Read the signature and member contracts below; no additional behaviour is inferred.

Signature
import { KeltnerStream } from '@insiderfinance/totalfinance/technical-analysis/volatility';

export declare class KeltnerStream implements IndicatorStream<BarInput, ChannelPoint> {
  constructor(parameters: { period: number; atrPeriod: number; mult: number; });
  static fromJSON(snapshot: TechnicalAnalysisSnapshot): KeltnerStream;
  value: ChannelPoint | null;
  next(bar: BarInput): ChannelPoint | null;
  toJSON(): TechnicalAnalysisSnapshot;
}
Fields, parameters and returned members (39)

Loading 39 members…

Stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Units come from declared names; “unitless by name” means the name alone does not establish a unit. See conventions and errors and warnings.

iface

MassIndexParameters

#

Public declaration. Read the signature and member contracts below; no additional behaviour is inferred.

Signature
import type { MassIndexParameters } from '@insiderfinance/totalfinance/technical-analysis/volatility';

// ───────────────────────── Mass Index ─────────────────────────
export interface MassIndexParameters {
    /** EMA length for the high−low range and its re-smoothing. Default 9. */
    fast?: number;
    /** Summation window for the EMA ratio. Default 25. */
    slow?: number;
}
Fields, parameters and returned members (2)
Name · typeMeaning · unitRequired · default
fastnumber

EMA length for the high−low range and its re-smoothing. Default 9.

unitless by name
OptionalNo @default declared
slownumber

Summation window for the EMA ratio. Default 25.

unitless by name
OptionalNo @default declared

Stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Units come from declared names; “unitless by name” means the name alone does not establish a unit. See conventions and errors and warnings.

class

MomentStream

#

Public declaration. Read the signature and member contracts below; no additional behaviour is inferred.

Signature
import { MomentStream } from '@insiderfinance/totalfinance/technical-analysis/volatility';

export declare class MomentStream implements IndicatorStream<number, number> {
  constructor(parameters: { period: number; sample: boolean; variance: boolean; kind: MomentKind; });
  static fromJSON(snapshot: TechnicalAnalysisSnapshot): MomentStream;
  value: number | null;
  next(value: number): number | null;
  toJSON(): TechnicalAnalysisSnapshot;
}
Fields, parameters and returned members (23)

Loading 23 members…

Stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Units come from declared names; “unitless by name” means the name alone does not establish a unit. See conventions and errors and warnings.

class

NatrStream

#

Public declaration. Read the signature and member contracts below; no additional behaviour is inferred.

Signature
import { NatrStream } from '@insiderfinance/totalfinance/technical-analysis/volatility';

export declare class NatrStream implements IndicatorStream<BarInput, number> {
  constructor(period: number);
  static fromJSON(snapshot: TechnicalAnalysisSnapshot): NatrStream;
  value: number | null;
  next(bar: BarInput): number | null;
  toJSON(): TechnicalAnalysisSnapshot;
}
Fields, parameters and returned members (24)

Loading 24 members…

Stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Units come from declared names; “unitless by name” means the name alone does not establish a unit. See conventions and errors and warnings.