The finance developer workbenchSearch the reference Development · 0.1.4 · unpublished

Public API / @insiderfinance/totalfinance

@insiderfinance/totalfinance/technical-analysis/moving-averages

import from '@insiderfinance/totalfinance/technical-analysis/moving-averages'

Every public export in this entry point, including type-only declarations. Search by name or concept.

Jump to an export (49)

AlmaParameters · AlmaStream · AnchoredVwapParameters · AnchoredVwapStream · DemaStream · EmaStream · FramaParameters · FramaStream · HmaStream · KamaParameters · KamaStream · MamaParameters · MamaPoint · MamaStream · McGinleyStream · PeriodParameters · RmaStream · RollingVwapStream · SmaStream · SuperSmootherStream · T3Parameters · T3Stream · TemaStream · TrimaStream · VidyaParameters · VidyaStream · VwmaStream · WmaStream · ZlemaStream · alma · anchoredVwap · dema · ema · frama · hma · kama · mama · mcginley · rma · rollingVwap · sma · superSmoother · t3 · tema · trima · vidya · vwma · wma · zlema

interface

AlmaParameters

Public declaration. Read the signature and parameter/member contracts below; no additional behavior is inferred.

// ───────────────────────── ALMA (Arnaud Legoux) ─────────────────────────
export interface AlmaParameters {
    period: number;
    /** Phase offset 0–1 (1 = responsive, 0 = smooth). Default 0.85. */
    offset?: number;
    /** Gaussian width. Default 6. */
    sigma?: number;
}
Fields, parameters & returned members (3)
Name / typeMeaning & unitOptional / default
offset
number		Phase offset 0–1 (1 = responsive, 0 = smooth). Default 0.85.
unitless by name		Optional
No @default declared; consult the signature and description.
period
number
unitless by name		Required / declared member
No @default declared; consult the signature and description.
sigma
number		Gaussian width. Default 6.
unitless by name		Optional
No @default declared; consult the signature and description.
Stability, warnings & conventions
stable-by-law (pre-1.0; not a 1.0 stability guarantee)

Declared field units are shown above. “Unitless by name” means the name alone does not establish a unit, not that a financial quantity has none. Check source descriptions, conventions, and the returned diagnostics. Errors and warnings are part of the result contract.

class

AlmaStream

Public declaration. Read the signature and parameter/member contracts below; no additional behavior is inferred.

export declare class AlmaStream implements IndicatorStream<number, number> {
  constructor(parameters: { period: number; offset: number; sigma: number; });
  static fromJSON(snapshot: TechnicalAnalysisSnapshot): AlmaStream;
  value: number | null;
  next(value: number): number | null;
  toJSON(): TechnicalAnalysisSnapshot;
}
Fields, parameters & returned members (22)
Name / typeMeaning & unitOptional / default
(parameters)
{ period: number; offset: number; sigma: number; }
unitless by name		Required / declared member
No @default declared; consult the signature and description.
(parameters).offset
number
unitless by name		Required / declared member
No @default declared; consult the signature and description.
(parameters).period
number
unitless by name		Required / declared member
No @default declared; consult the signature and description.
(parameters).sigma
number
unitless by name		Required / declared member
No @default declared; consult the signature and description.
fromJSON
(snapshot: TechnicalAnalysisSnapshot) => AlmaStream
unitless by name		Required / declared member
No @default declared; consult the signature and description.
fromJSON().return.next
(value: number) => number | null
unitless by name		Required / declared member
No @default declared; consult the signature and description.
fromJSON().return.toJSON
() => TechnicalAnalysisSnapshot
unitless by name		Required / declared member
No @default declared; consult the signature and description.
fromJSON().return.value
number | null
unitless by name		Required / declared member
No @default declared; consult the signature and description.
fromJSON(snapshot)
TechnicalAnalysisSnapshot
unitless by name		Required / declared member
No @default declared; consult the signature and description.
fromJSON(snapshot).kind
string
unitless by name		Required / declared member
No @default declared; consult the signature and description.
fromJSON(snapshot).schemaVersion
number		Schema version, stamped at the serialization boundary by {@link snapshotOf}.
unitless by name		Required / declared member
No @default declared; consult the signature and description.
fromJSON(snapshot).state
Record<string, unknown>		Indicator-private stream state. Round-trip it; never read into it.
unitless by name		Required / declared member
No @default declared; consult the signature and description.
next
(value: number) => number | null
unitless by name		Required / declared member
No @default declared; consult the signature and description.
next(value)
number
unitless by name		Required / declared member
No @default declared; consult the signature and description.
return.next
(value: number) => number | null
unitless by name		Required / declared member
No @default declared; consult the signature and description.
return.toJSON
() => TechnicalAnalysisSnapshot
unitless by name		Required / declared member
No @default declared; consult the signature and description.
return.value
number | null
unitless by name		Required / declared member
No @default declared; consult the signature and description.
toJSON
() => TechnicalAnalysisSnapshot
unitless by name		Required / declared member
No @default declared; consult the signature and description.
toJSON().return.kind
string
unitless by name		Required / declared member
No @default declared; consult the signature and description.
toJSON().return.schemaVersion
number		Schema version, stamped at the serialization boundary by {@link snapshotOf}.
unitless by name		Required / declared member
No @default declared; consult the signature and description.
toJSON().return.state
Record<string, unknown>		Indicator-private stream state. Round-trip it; never read into it.
unitless by name		Required / declared member
No @default declared; consult the signature and description.
value
number | null
unitless by name		Required / declared member
No @default declared; consult the signature and description.
Stability, warnings & conventions
stable-by-law (pre-1.0; not a 1.0 stability guarantee)

Declared field units are shown above. “Unitless by name” means the name alone does not establish a unit, not that a financial quantity has none. Check source descriptions, conventions, and the returned diagnostics. Errors and warnings are part of the result contract.

interface

AnchoredVwapParameters

Public declaration. Read the signature and parameter/member contracts below; no additional behavior is inferred.

// ───────────────────────── anchored VWAP ─────────────────────────
export interface AnchoredVwapParameters {
    /** Bar index (0-based) from which accumulation starts. Bars before the anchor emit null. */
    anchor: number;
}
Fields, parameters & returned members (1)
Name / typeMeaning & unitOptional / default
anchor
number		Bar index (0-based) from which accumulation starts. Bars before the anchor emit null.
unitless by name		Required / declared member
No @default declared; consult the signature and description.
Stability, warnings & conventions
stable-by-law (pre-1.0; not a 1.0 stability guarantee)

Declared field units are shown above. “Unitless by name” means the name alone does not establish a unit, not that a financial quantity has none. Check source descriptions, conventions, and the returned diagnostics. Errors and warnings are part of the result contract.

class

AnchoredVwapStream

Public declaration. Read the signature and parameter/member contracts below; no additional behavior is inferred.

export declare class AnchoredVwapStream implements IndicatorStream<BarInput, number> {
  constructor(anchor: number);
  static fromJSON(snapshot: TechnicalAnalysisSnapshot): AnchoredVwapStream;
  value: number | null;
  next(bar: BarInput): number | null;
  toJSON(): TechnicalAnalysisSnapshot;
}
Fields, parameters & returned members (24)
Name / typeMeaning & unitOptional / default
(anchor)
number
unitless by name		Required / declared member
No @default declared; consult the signature and description.
fromJSON
(snapshot: TechnicalAnalysisSnapshot) => AnchoredVwapStream
unitless by name		Required / declared member
No @default declared; consult the signature and description.
fromJSON().return.next
(bar: BarInput) => number | null
unitless by name		Required / declared member
No @default declared; consult the signature and description.
fromJSON().return.toJSON
() => TechnicalAnalysisSnapshot
unitless by name		Required / declared member
No @default declared; consult the signature and description.
fromJSON().return.value
number | null
unitless by name		Required / declared member
No @default declared; consult the signature and description.
fromJSON(snapshot)
TechnicalAnalysisSnapshot
unitless by name		Required / declared member
No @default declared; consult the signature and description.
fromJSON(snapshot).kind
string
unitless by name		Required / declared member
No @default declared; consult the signature and description.
fromJSON(snapshot).schemaVersion
number		Schema version, stamped at the serialization boundary by {@link snapshotOf}.
unitless by name		Required / declared member
No @default declared; consult the signature and description.
fromJSON(snapshot).state
Record<string, unknown>		Indicator-private stream state. Round-trip it; never read into it.
unitless by name		Required / declared member
No @default declared; consult the signature and description.
next
(bar: BarInput) => number | null
unitless by name		Required / declared member
No @default declared; consult the signature and description.
next(bar)
BarInput
unitless by name		Required / declared member
No @default declared; consult the signature and description.
next(bar).close
number
unitless by name		Required / declared member
No @default declared; consult the signature and description.
next(bar).high
number
unitless by name		Required / declared member
No @default declared; consult the signature and description.
next(bar).low
number
unitless by name		Required / declared member
No @default declared; consult the signature and description.
next(bar).open
number
unitless by name		Optional
No @default declared; consult the signature and description.
next(bar).volume
number
unitless by name		Optional
No @default declared; consult the signature and description.
return.next
(bar: BarInput) => number | null
unitless by name		Required / declared member
No @default declared; consult the signature and description.
return.toJSON
() => TechnicalAnalysisSnapshot
unitless by name		Required / declared member
No @default declared; consult the signature and description.
return.value
number | null
unitless by name		Required / declared member
No @default declared; consult the signature and description.
toJSON
() => TechnicalAnalysisSnapshot
unitless by name		Required / declared member
No @default declared; consult the signature and description.
toJSON().return.kind
string
unitless by name		Required / declared member
No @default declared; consult the signature and description.
toJSON().return.schemaVersion
number		Schema version, stamped at the serialization boundary by {@link snapshotOf}.
unitless by name		Required / declared member
No @default declared; consult the signature and description.
toJSON().return.state
Record<string, unknown>		Indicator-private stream state. Round-trip it; never read into it.
unitless by name		Required / declared member
No @default declared; consult the signature and description.
value
number | null
unitless by name		Required / declared member
No @default declared; consult the signature and description.
Stability, warnings & conventions
stable-by-law (pre-1.0; not a 1.0 stability guarantee)

Declared field units are shown above. “Unitless by name” means the name alone does not establish a unit, not that a financial quantity has none. Check source descriptions, conventions, and the returned diagnostics. Errors and warnings are part of the result contract.

class

DemaStream

Public declaration. Read the signature and parameter/member contracts below; no additional behavior is inferred.

export declare class DemaStream implements IndicatorStream<number, number> {
  constructor(period: number);
  static fromJSON(snapshot: TechnicalAnalysisSnapshot): DemaStream;
  value: number | null;
  next(value: number): number | null;
  toJSON(): TechnicalAnalysisSnapshot;
}
Fields, parameters & returned members (19)
Name / typeMeaning & unitOptional / default
(period)
number
unitless by name		Required / declared member
No @default declared; consult the signature and description.
fromJSON
(snapshot: TechnicalAnalysisSnapshot) => DemaStream
unitless by name		Required / declared member
No @default declared; consult the signature and description.
fromJSON().return.next
(value: number) => number | null
unitless by name		Required / declared member
No @default declared; consult the signature and description.
fromJSON().return.toJSON
() => TechnicalAnalysisSnapshot
unitless by name		Required / declared member
No @default declared; consult the signature and description.
fromJSON().return.value
number | null
unitless by name		Required / declared member
No @default declared; consult the signature and description.
fromJSON(snapshot)
TechnicalAnalysisSnapshot
unitless by name		Required / declared member
No @default declared; consult the signature and description.
fromJSON(snapshot).kind
string
unitless by name		Required / declared member
No @default declared; consult the signature and description.
fromJSON(snapshot).schemaVersion
number		Schema version, stamped at the serialization boundary by {@link snapshotOf}.
unitless by name		Required / declared member
No @default declared; consult the signature and description.
fromJSON(snapshot).state
Record<string, unknown>		Indicator-private stream state. Round-trip it; never read into it.
unitless by name		Required / declared member
No @default declared; consult the signature and description.
next
(value: number) => number | null
unitless by name		Required / declared member
No @default declared; consult the signature and description.
next(value)
number
unitless by name		Required / declared member
No @default declared; consult the signature and description.
return.next
(value: number) => number | null
unitless by name		Required / declared member
No @default declared; consult the signature and description.
return.toJSON
() => TechnicalAnalysisSnapshot
unitless by name		Required / declared member
No @default declared; consult the signature and description.
return.value
number | null
unitless by name		Required / declared member
No @default declared; consult the signature and description.
toJSON
() => TechnicalAnalysisSnapshot
unitless by name		Required / declared member
No @default declared; consult the signature and description.
toJSON().return.kind
string
unitless by name		Required / declared member
No @default declared; consult the signature and description.
toJSON().return.schemaVersion
number		Schema version, stamped at the serialization boundary by {@link snapshotOf}.
unitless by name		Required / declared member
No @default declared; consult the signature and description.
toJSON().return.state
Record<string, unknown>		Indicator-private stream state. Round-trip it; never read into it.
unitless by name		Required / declared member
No @default declared; consult the signature and description.
value
number | null
unitless by name		Required / declared member
No @default declared; consult the signature and description.
Stability, warnings & conventions
stable-by-law (pre-1.0; not a 1.0 stability guarantee)

Declared field units are shown above. “Unitless by name” means the name alone does not establish a unit, not that a financial quantity has none. Check source descriptions, conventions, and the returned diagnostics. Errors and warnings are part of the result contract.

class

EmaStream

Public declaration. Read the signature and parameter/member contracts below; no additional behavior is inferred.

export declare class EmaStream implements IndicatorStream<number, number> {
  constructor(period: number);
  static fromJSON(snapshot: TechnicalAnalysisSnapshot): EmaStream;
  value: number | null;
  next(value: number): number | null;
  toJSON(): TechnicalAnalysisSnapshot;
}
Fields, parameters & returned members (19)
Name / typeMeaning & unitOptional / default
(period)
number
unitless by name		Required / declared member
No @default declared; consult the signature and description.
fromJSON
(snapshot: TechnicalAnalysisSnapshot) => EmaStream
unitless by name		Required / declared member
No @default declared; consult the signature and description.
fromJSON().return.next
(value: number) => number | null
unitless by name		Required / declared member
No @default declared; consult the signature and description.
fromJSON().return.toJSON
() => TechnicalAnalysisSnapshot
unitless by name		Required / declared member
No @default declared; consult the signature and description.
fromJSON().return.value
number | null
unitless by name		Required / declared member
No @default declared; consult the signature and description.
fromJSON(snapshot)
TechnicalAnalysisSnapshot
unitless by name		Required / declared member
No @default declared; consult the signature and description.
fromJSON(snapshot).kind
string
unitless by name		Required / declared member
No @default declared; consult the signature and description.
fromJSON(snapshot).schemaVersion
number		Schema version, stamped at the serialization boundary by {@link snapshotOf}.
unitless by name		Required / declared member
No @default declared; consult the signature and description.
fromJSON(snapshot).state
Record<string, unknown>		Indicator-private stream state. Round-trip it; never read into it.
unitless by name		Required / declared member
No @default declared; consult the signature and description.
next
(value: number) => number | null
unitless by name		Required / declared member
No @default declared; consult the signature and description.
next(value)
number
unitless by name		Required / declared member
No @default declared; consult the signature and description.
return.next
(value: number) => number | null
unitless by name		Required / declared member
No @default declared; consult the signature and description.
return.toJSON
() => TechnicalAnalysisSnapshot
unitless by name		Required / declared member
No @default declared; consult the signature and description.
return.value
number | null
unitless by name		Required / declared member
No @default declared; consult the signature and description.
toJSON
() => TechnicalAnalysisSnapshot
unitless by name		Required / declared member
No @default declared; consult the signature and description.
toJSON().return.kind
string
unitless by name		Required / declared member
No @default declared; consult the signature and description.
toJSON().return.schemaVersion
number		Schema version, stamped at the serialization boundary by {@link snapshotOf}.
unitless by name		Required / declared member
No @default declared; consult the signature and description.
toJSON().return.state
Record<string, unknown>		Indicator-private stream state. Round-trip it; never read into it.
unitless by name		Required / declared member
No @default declared; consult the signature and description.
value
number | null
unitless by name		Required / declared member
No @default declared; consult the signature and description.
Stability, warnings & conventions
stable-by-law (pre-1.0; not a 1.0 stability guarantee)

Declared field units are shown above. “Unitless by name” means the name alone does not establish a unit, not that a financial quantity has none. Check source descriptions, conventions, and the returned diagnostics. Errors and warnings are part of the result contract.

interface

FramaParameters

Public declaration. Read the signature and parameter/member contracts below; no additional behavior is inferred.

// ───────────────────────── FRAMA (fractal adaptive, Ehlers) ─────────────────────────
export interface FramaParameters {
    /** Lookback (rounded up to an even number). Default 16. */
    period: number;
}
Fields, parameters & returned members (1)
Name / typeMeaning & unitOptional / default
period
number		Lookback (rounded up to an even number). Default 16.
unitless by name		Required / declared member
No @default declared; consult the signature and description.
Stability, warnings & conventions
stable-by-law (pre-1.0; not a 1.0 stability guarantee)

Declared field units are shown above. “Unitless by name” means the name alone does not establish a unit, not that a financial quantity has none. Check source descriptions, conventions, and the returned diagnostics. Errors and warnings are part of the result contract.

class

FramaStream

Public declaration. Read the signature and parameter/member contracts below; no additional behavior is inferred.

export declare class FramaStream implements IndicatorStream<BarInput, number> {
  constructor(period: number);
  static fromJSON(snapshot: TechnicalAnalysisSnapshot): FramaStream;
  value: number | null;
  next(bar: BarInput): number | null;
  toJSON(): TechnicalAnalysisSnapshot;
}
Fields, parameters & returned members (24)
Name / typeMeaning & unitOptional / default
(period)
number
unitless by name		Required / declared member
No @default declared; consult the signature and description.
fromJSON
(snapshot: TechnicalAnalysisSnapshot) => FramaStream
unitless by name		Required / declared member
No @default declared; consult the signature and description.
fromJSON().return.next
(bar: BarInput) => number | null
unitless by name		Required / declared member
No @default declared; consult the signature and description.
fromJSON().return.toJSON
() => TechnicalAnalysisSnapshot
unitless by name		Required / declared member
No @default declared; consult the signature and description.
fromJSON().return.value
number | null
unitless by name		Required / declared member
No @default declared; consult the signature and description.
fromJSON(snapshot)
TechnicalAnalysisSnapshot
unitless by name		Required / declared member
No @default declared; consult the signature and description.
fromJSON(snapshot).kind
string
unitless by name		Required / declared member
No @default declared; consult the signature and description.
fromJSON(snapshot).schemaVersion
number		Schema version, stamped at the serialization boundary by {@link snapshotOf}.
unitless by name		Required / declared member
No @default declared; consult the signature and description.
fromJSON(snapshot).state
Record<string, unknown>		Indicator-private stream state. Round-trip it; never read into it.
unitless by name		Required / declared member
No @default declared; consult the signature and description.
next
(bar: BarInput) => number | null
unitless by name		Required / declared member
No @default declared; consult the signature and description.
next(bar)
BarInput
unitless by name		Required / declared member
No @default declared; consult the signature and description.
next(bar).close
number
unitless by name		Required / declared member
No @default declared; consult the signature and description.
next(bar).high
number
unitless by name		Required / declared member
No @default declared; consult the signature and description.
next(bar).low
number
unitless by name		Required / declared member
No @default declared; consult the signature and description.
next(bar).open
number
unitless by name		Optional
No @default declared; consult the signature and description.
next(bar).volume
number
unitless by name		Optional
No @default declared; consult the signature and description.
return.next
(bar: BarInput) => number | null
unitless by name		Required / declared member
No @default declared; consult the signature and description.
return.toJSON
() => TechnicalAnalysisSnapshot
unitless by name		Required / declared member
No @default declared; consult the signature and description.
return.value
number | null
unitless by name		Required / declared member
No @default declared; consult the signature and description.
toJSON
() => TechnicalAnalysisSnapshot
unitless by name		Required / declared member
No @default declared; consult the signature and description.
toJSON().return.kind
string
unitless by name		Required / declared member
No @default declared; consult the signature and description.
toJSON().return.schemaVersion
number		Schema version, stamped at the serialization boundary by {@link snapshotOf}.
unitless by name		Required / declared member
No @default declared; consult the signature and description.
toJSON().return.state
Record<string, unknown>		Indicator-private stream state. Round-trip it; never read into it.
unitless by name		Required / declared member
No @default declared; consult the signature and description.
value
number | null
unitless by name		Required / declared member
No @default declared; consult the signature and description.
Stability, warnings & conventions
stable-by-law (pre-1.0; not a 1.0 stability guarantee)

Declared field units are shown above. “Unitless by name” means the name alone does not establish a unit, not that a financial quantity has none. Check source descriptions, conventions, and the returned diagnostics. Errors and warnings are part of the result contract.

class

HmaStream

Public declaration. Read the signature and parameter/member contracts below; no additional behavior is inferred.

export declare class HmaStream implements IndicatorStream<number, number> {
  constructor(period: number);
  static fromJSON(snapshot: TechnicalAnalysisSnapshot): HmaStream;
  value: number | null;
  next(value: number): number | null;
  toJSON(): TechnicalAnalysisSnapshot;
}
Fields, parameters & returned members (19)
Name / typeMeaning & unitOptional / default
(period)
number
unitless by name		Required / declared member
No @default declared; consult the signature and description.
fromJSON
(snapshot: TechnicalAnalysisSnapshot) => HmaStream
unitless by name		Required / declared member
No @default declared; consult the signature and description.
fromJSON().return.next
(value: number) => number | null
unitless by name		Required / declared member
No @default declared; consult the signature and description.
fromJSON().return.toJSON
() => TechnicalAnalysisSnapshot
unitless by name		Required / declared member
No @default declared; consult the signature and description.
fromJSON().return.value
number | null
unitless by name		Required / declared member
No @default declared; consult the signature and description.
fromJSON(snapshot)
TechnicalAnalysisSnapshot
unitless by name		Required / declared member
No @default declared; consult the signature and description.
fromJSON(snapshot).kind
string
unitless by name		Required / declared member
No @default declared; consult the signature and description.
fromJSON(snapshot).schemaVersion
number		Schema version, stamped at the serialization boundary by {@link snapshotOf}.
unitless by name		Required / declared member
No @default declared; consult the signature and description.
fromJSON(snapshot).state
Record<string, unknown>		Indicator-private stream state. Round-trip it; never read into it.
unitless by name		Required / declared member
No @default declared; consult the signature and description.
next
(value: number) => number | null
unitless by name		Required / declared member
No @default declared; consult the signature and description.
next(value)
number
unitless by name		Required / declared member
No @default declared; consult the signature and description.
return.next
(value: number) => number | null
unitless by name		Required / declared member
No @default declared; consult the signature and description.
return.toJSON
() => TechnicalAnalysisSnapshot
unitless by name		Required / declared member
No @default declared; consult the signature and description.
return.value
number | null
unitless by name		Required / declared member
No @default declared; consult the signature and description.
toJSON
() => TechnicalAnalysisSnapshot
unitless by name		Required / declared member
No @default declared; consult the signature and description.
toJSON().return.kind
string
unitless by name		Required / declared member
No @default declared; consult the signature and description.
toJSON().return.schemaVersion
number		Schema version, stamped at the serialization boundary by {@link snapshotOf}.
unitless by name		Required / declared member
No @default declared; consult the signature and description.
toJSON().return.state
Record<string, unknown>		Indicator-private stream state. Round-trip it; never read into it.
unitless by name		Required / declared member
No @default declared; consult the signature and description.
value
number | null
unitless by name		Required / declared member
No @default declared; consult the signature and description.
Stability, warnings & conventions
stable-by-law (pre-1.0; not a 1.0 stability guarantee)

Declared field units are shown above. “Unitless by name” means the name alone does not establish a unit, not that a financial quantity has none. Check source descriptions, conventions, and the returned diagnostics. Errors and warnings are part of the result contract.

interface

KamaParameters

Public declaration. Read the signature and parameter/member contracts below; no additional behavior is inferred.

// ───────────────────────── KAMA (Kaufman adaptive) ─────────────────────────
export interface KamaParameters {
    period: number;
    /** Fast EMA constant period. Default 2. */
    fast?: number;
    /** Slow EMA constant period. Default 30. */
    slow?: number;
}
Fields, parameters & returned members (3)
Name / typeMeaning & unitOptional / default
fast
number		Fast EMA constant period. Default 2.
unitless by name		Optional
No @default declared; consult the signature and description.
period
number
unitless by name		Required / declared member
No @default declared; consult the signature and description.
slow
number		Slow EMA constant period. Default 30.
unitless by name		Optional
No @default declared; consult the signature and description.
Stability, warnings & conventions
stable-by-law (pre-1.0; not a 1.0 stability guarantee)

Declared field units are shown above. “Unitless by name” means the name alone does not establish a unit, not that a financial quantity has none. Check source descriptions, conventions, and the returned diagnostics. Errors and warnings are part of the result contract.

class

KamaStream

Public declaration. Read the signature and parameter/member contracts below; no additional behavior is inferred.

export declare class KamaStream implements IndicatorStream<number, number> {
  constructor(parameters: { period: number; fast: number; slow: number; });
  static fromJSON(snapshot: TechnicalAnalysisSnapshot): KamaStream;
  value: number | null;
  next(value: number): number | null;
  toJSON(): TechnicalAnalysisSnapshot;
}
Fields, parameters & returned members (22)
Name / typeMeaning & unitOptional / default
(parameters)
{ period: number; fast: number; slow: number; }
unitless by name		Required / declared member
No @default declared; consult the signature and description.
(parameters).fast
number
unitless by name		Required / declared member
No @default declared; consult the signature and description.
(parameters).period
number
unitless by name		Required / declared member
No @default declared; consult the signature and description.
(parameters).slow
number
unitless by name		Required / declared member
No @default declared; consult the signature and description.
fromJSON
(snapshot: TechnicalAnalysisSnapshot) => KamaStream
unitless by name		Required / declared member
No @default declared; consult the signature and description.
fromJSON().return.next
(value: number) => number | null
unitless by name		Required / declared member
No @default declared; consult the signature and description.
fromJSON().return.toJSON
() => TechnicalAnalysisSnapshot
unitless by name		Required / declared member
No @default declared; consult the signature and description.
fromJSON().return.value
number | null
unitless by name		Required / declared member
No @default declared; consult the signature and description.
fromJSON(snapshot)
TechnicalAnalysisSnapshot
unitless by name		Required / declared member
No @default declared; consult the signature and description.
fromJSON(snapshot).kind
string
unitless by name		Required / declared member
No @default declared; consult the signature and description.
fromJSON(snapshot).schemaVersion
number		Schema version, stamped at the serialization boundary by {@link snapshotOf}.
unitless by name		Required / declared member
No @default declared; consult the signature and description.
fromJSON(snapshot).state
Record<string, unknown>		Indicator-private stream state. Round-trip it; never read into it.
unitless by name		Required / declared member
No @default declared; consult the signature and description.
next
(value: number) => number | null
unitless by name		Required / declared member
No @default declared; consult the signature and description.
next(value)
number
unitless by name		Required / declared member
No @default declared; consult the signature and description.
return.next
(value: number) => number | null
unitless by name		Required / declared member
No @default declared; consult the signature and description.
return.toJSON
() => TechnicalAnalysisSnapshot
unitless by name		Required / declared member
No @default declared; consult the signature and description.
return.value
number | null
unitless by name		Required / declared member
No @default declared; consult the signature and description.
toJSON
() => TechnicalAnalysisSnapshot
unitless by name		Required / declared member
No @default declared; consult the signature and description.
toJSON().return.kind
string
unitless by name		Required / declared member
No @default declared; consult the signature and description.
toJSON().return.schemaVersion
number		Schema version, stamped at the serialization boundary by {@link snapshotOf}.
unitless by name		Required / declared member
No @default declared; consult the signature and description.
toJSON().return.state
Record<string, unknown>		Indicator-private stream state. Round-trip it; never read into it.
unitless by name		Required / declared member
No @default declared; consult the signature and description.
value
number | null
unitless by name		Required / declared member
No @default declared; consult the signature and description.
Stability, warnings & conventions
stable-by-law (pre-1.0; not a 1.0 stability guarantee)

Declared field units are shown above. “Unitless by name” means the name alone does not establish a unit, not that a financial quantity has none. Check source descriptions, conventions, and the returned diagnostics. Errors and warnings are part of the result contract.

interface

MamaParameters

Public declaration. Read the signature and parameter/member contracts below; no additional behavior is inferred.

// ───────────────────────── MAMA / FAMA (MESA adaptive, Ehlers) ─────────────────────────
export interface MamaParameters {
    /** Fast adaptation limit. Default 0.5. */
    fastLimit?: number;
    /** Slow adaptation limit. Default 0.05. */
    slowLimit?: number;
}
Fields, parameters & returned members (2)
Name / typeMeaning & unitOptional / default
fastLimit
number		Fast adaptation limit. Default 0.5.
unitless by name		Optional
No @default declared; consult the signature and description.
slowLimit
number		Slow adaptation limit. Default 0.05.
unitless by name		Optional
No @default declared; consult the signature and description.
Stability, warnings & conventions
stable-by-law (pre-1.0; not a 1.0 stability guarantee)

Declared field units are shown above. “Unitless by name” means the name alone does not establish a unit, not that a financial quantity has none. Check source descriptions, conventions, and the returned diagnostics. Errors and warnings are part of the result contract.

interface

MamaPoint

Public declaration. Read the signature and parameter/member contracts below; no additional behavior is inferred.

export interface MamaPoint {
    mama: number;
    fama: number;
}
Fields, parameters & returned members (2)
Name / typeMeaning & unitOptional / default
fama
number
unitless by name		Required / declared member
No @default declared; consult the signature and description.
mama
number
unitless by name		Required / declared member
No @default declared; consult the signature and description.
Stability, warnings & conventions
stable-by-law (pre-1.0; not a 1.0 stability guarantee)

Declared field units are shown above. “Unitless by name” means the name alone does not establish a unit, not that a financial quantity has none. Check source descriptions, conventions, and the returned diagnostics. Errors and warnings are part of the result contract.

class

MamaStream

Public declaration. Read the signature and parameter/member contracts below; no additional behavior is inferred.

export declare class MamaStream implements IndicatorStream<BarInput, MamaPoint> {
  constructor(parameters: { fastLimit: number; slowLimit: number; });
  static fromJSON(snapshot: TechnicalAnalysisSnapshot): MamaStream;
  value: MamaPoint | null;
  next(bar: BarInput): MamaPoint | null;
  toJSON(): TechnicalAnalysisSnapshot;
}
Fields, parameters & returned members (34)
Name / typeMeaning & unitOptional / default
(parameters)
{ fastLimit: number; slowLimit: number; }
unitless by name		Required / declared member
No @default declared; consult the signature and description.
(parameters).fastLimit
number
unitless by name		Required / declared member
No @default declared; consult the signature and description.
(parameters).slowLimit
number
unitless by name		Required / declared member
No @default declared; consult the signature and description.
fromJSON
(snapshot: TechnicalAnalysisSnapshot) => MamaStream
unitless by name		Required / declared member
No @default declared; consult the signature and description.
fromJSON().return.next
(bar: BarInput) => MamaPoint | null
unitless by name		Required / declared member
No @default declared; consult the signature and description.
fromJSON().return.toJSON
() => TechnicalAnalysisSnapshot
unitless by name		Required / declared member
No @default declared; consult the signature and description.
fromJSON().return.value
MamaPoint | null
unitless by name		Required / declared member
No @default declared; consult the signature and description.
fromJSON().return.value.fama
number
unitless by name		Required / declared member
No @default declared; consult the signature and description.
fromJSON().return.value.mama
number
unitless by name		Required / declared member
No @default declared; consult the signature and description.
fromJSON(snapshot)
TechnicalAnalysisSnapshot
unitless by name		Required / declared member
No @default declared; consult the signature and description.
fromJSON(snapshot).kind
string
unitless by name		Required / declared member
No @default declared; consult the signature and description.
fromJSON(snapshot).schemaVersion
number		Schema version, stamped at the serialization boundary by {@link snapshotOf}.
unitless by name		Required / declared member
No @default declared; consult the signature and description.
fromJSON(snapshot).state
Record<string, unknown>		Indicator-private stream state. Round-trip it; never read into it.
unitless by name		Required / declared member
No @default declared; consult the signature and description.
next
(bar: BarInput) => MamaPoint | null
unitless by name		Required / declared member
No @default declared; consult the signature and description.
next().return.fama
number
unitless by name		Required / declared member
No @default declared; consult the signature and description.
next().return.mama
number
unitless by name		Required / declared member
No @default declared; consult the signature and description.
next(bar)
BarInput
unitless by name		Required / declared member
No @default declared; consult the signature and description.
next(bar).close
number
unitless by name		Required / declared member
No @default declared; consult the signature and description.
next(bar).high
number
unitless by name		Required / declared member
No @default declared; consult the signature and description.
next(bar).low
number
unitless by name		Required / declared member
No @default declared; consult the signature and description.
next(bar).open
number
unitless by name		Optional
No @default declared; consult the signature and description.
next(bar).volume
number
unitless by name		Optional
No @default declared; consult the signature and description.
return.next
(bar: BarInput) => MamaPoint | null
unitless by name		Required / declared member
No @default declared; consult the signature and description.
return.toJSON
() => TechnicalAnalysisSnapshot
unitless by name		Required / declared member
No @default declared; consult the signature and description.
return.value
MamaPoint | null
unitless by name		Required / declared member
No @default declared; consult the signature and description.
return.value.fama
number
unitless by name		Required / declared member
No @default declared; consult the signature and description.
return.value.mama
number
unitless by name		Required / declared member
No @default declared; consult the signature and description.
toJSON
() => TechnicalAnalysisSnapshot
unitless by name		Required / declared member
No @default declared; consult the signature and description.
toJSON().return.kind
string
unitless by name		Required / declared member
No @default declared; consult the signature and description.
toJSON().return.schemaVersion
number		Schema version, stamped at the serialization boundary by {@link snapshotOf}.
unitless by name		Required / declared member
No @default declared; consult the signature and description.
toJSON().return.state
Record<string, unknown>		Indicator-private stream state. Round-trip it; never read into it.
unitless by name		Required / declared member
No @default declared; consult the signature and description.
value
MamaPoint | null
unitless by name		Required / declared member
No @default declared; consult the signature and description.
value.fama
number
unitless by name		Required / declared member
No @default declared; consult the signature and description.
value.mama
number
unitless by name		Required / declared member
No @default declared; consult the signature and description.
Stability, warnings & conventions
stable-by-law (pre-1.0; not a 1.0 stability guarantee)

Declared field units are shown above. “Unitless by name” means the name alone does not establish a unit, not that a financial quantity has none. Check source descriptions, conventions, and the returned diagnostics. Errors and warnings are part of the result contract.

class

McGinleyStream

McGinley Dynamic (John R. McGinley) — an EMA-like average whose smoothing constant self-adjusts by the ratio of price to the current average, so it speeds up in fast markets and slows in quiet ones. Registered as `mcginley`; pandas-ta calls it `mcgd`.

export declare class McGinleyStream implements IndicatorStream<number, number> {
  constructor(period: number);
  static fromJSON(snapshot: TechnicalAnalysisSnapshot): McGinleyStream;
  value: number | null;
  next(value: number): number | null;
  toJSON(): TechnicalAnalysisSnapshot;
}
Fields, parameters & returned members (19)
Name / typeMeaning & unitOptional / default
(period)
number
unitless by name		Required / declared member
No @default declared; consult the signature and description.
fromJSON
(snapshot: TechnicalAnalysisSnapshot) => McGinleyStream
unitless by name		Required / declared member
No @default declared; consult the signature and description.
fromJSON().return.next
(value: number) => number | null
unitless by name		Required / declared member
No @default declared; consult the signature and description.
fromJSON().return.toJSON
() => TechnicalAnalysisSnapshot
unitless by name		Required / declared member
No @default declared; consult the signature and description.
fromJSON().return.value
number | null
unitless by name		Required / declared member
No @default declared; consult the signature and description.
fromJSON(snapshot)
TechnicalAnalysisSnapshot
unitless by name		Required / declared member
No @default declared; consult the signature and description.
fromJSON(snapshot).kind
string
unitless by name		Required / declared member
No @default declared; consult the signature and description.
fromJSON(snapshot).schemaVersion
number		Schema version, stamped at the serialization boundary by {@link snapshotOf}.
unitless by name		Required / declared member
No @default declared; consult the signature and description.
fromJSON(snapshot).state
Record<string, unknown>		Indicator-private stream state. Round-trip it; never read into it.
unitless by name		Required / declared member
No @default declared; consult the signature and description.
next
(value: number) => number | null
unitless by name		Required / declared member
No @default declared; consult the signature and description.
next(value)
number
unitless by name		Required / declared member
No @default declared; consult the signature and description.
return.next
(value: number) => number | null
unitless by name		Required / declared member
No @default declared; consult the signature and description.
return.toJSON
() => TechnicalAnalysisSnapshot
unitless by name		Required / declared member
No @default declared; consult the signature and description.
return.value
number | null
unitless by name		Required / declared member
No @default declared; consult the signature and description.
toJSON
() => TechnicalAnalysisSnapshot
unitless by name		Required / declared member
No @default declared; consult the signature and description.
toJSON().return.kind
string
unitless by name		Required / declared member
No @default declared; consult the signature and description.
toJSON().return.schemaVersion
number		Schema version, stamped at the serialization boundary by {@link snapshotOf}.
unitless by name		Required / declared member
No @default declared; consult the signature and description.
toJSON().return.state
Record<string, unknown>		Indicator-private stream state. Round-trip it; never read into it.
unitless by name		Required / declared member
No @default declared; consult the signature and description.
value
number | null
unitless by name		Required / declared member
No @default declared; consult the signature and description.
Stability, warnings & conventions
stable-by-law (pre-1.0; not a 1.0 stability guarantee)

Declared field units are shown above. “Unitless by name” means the name alone does not establish a unit, not that a financial quantity has none. Check source descriptions, conventions, and the returned diagnostics. Errors and warnings are part of the result contract.

interface

PeriodParameters

Public declaration. Read the signature and parameter/member contracts below; no additional behavior is inferred.

export interface PeriodParameters {
    period: number;
}
Fields, parameters & returned members (1)
Name / typeMeaning & unitOptional / default
period
number
unitless by name		Required / declared member
No @default declared; consult the signature and description.
Stability, warnings & conventions
stable-by-law (pre-1.0; not a 1.0 stability guarantee)

Declared field units are shown above. “Unitless by name” means the name alone does not establish a unit, not that a financial quantity has none. Check source descriptions, conventions, and the returned diagnostics. Errors and warnings are part of the result contract.

class

RmaStream

Public declaration. Read the signature and parameter/member contracts below; no additional behavior is inferred.

export declare class RmaStream implements IndicatorStream<number, number> {
  constructor(period: number);
  static fromJSON(snapshot: TechnicalAnalysisSnapshot): RmaStream;
  value: number | null;
  next(value: number): number | null;
  toJSON(): TechnicalAnalysisSnapshot;
}
Fields, parameters & returned members (19)
Name / typeMeaning & unitOptional / default
(period)
number
unitless by name		Required / declared member
No @default declared; consult the signature and description.
fromJSON
(snapshot: TechnicalAnalysisSnapshot) => RmaStream
unitless by name		Required / declared member
No @default declared; consult the signature and description.
fromJSON().return.next
(value: number) => number | null
unitless by name		Required / declared member
No @default declared; consult the signature and description.
fromJSON().return.toJSON
() => TechnicalAnalysisSnapshot
unitless by name		Required / declared member
No @default declared; consult the signature and description.
fromJSON().return.value
number | null
unitless by name		Required / declared member
No @default declared; consult the signature and description.
fromJSON(snapshot)
TechnicalAnalysisSnapshot
unitless by name		Required / declared member
No @default declared; consult the signature and description.
fromJSON(snapshot).kind
string
unitless by name		Required / declared member
No @default declared; consult the signature and description.
fromJSON(snapshot).schemaVersion
number		Schema version, stamped at the serialization boundary by {@link snapshotOf}.
unitless by name		Required / declared member
No @default declared; consult the signature and description.
fromJSON(snapshot).state
Record<string, unknown>		Indicator-private stream state. Round-trip it; never read into it.
unitless by name		Required / declared member
No @default declared; consult the signature and description.
next
(value: number) => number | null
unitless by name		Required / declared member
No @default declared; consult the signature and description.
next(value)
number
unitless by name		Required / declared member
No @default declared; consult the signature and description.
return.next
(value: number) => number | null
unitless by name		Required / declared member
No @default declared; consult the signature and description.
return.toJSON
() => TechnicalAnalysisSnapshot
unitless by name		Required / declared member
No @default declared; consult the signature and description.
return.value
number | null
unitless by name		Required / declared member
No @default declared; consult the signature and description.
toJSON
() => TechnicalAnalysisSnapshot
unitless by name		Required / declared member
No @default declared; consult the signature and description.
toJSON().return.kind
string
unitless by name		Required / declared member
No @default declared; consult the signature and description.
toJSON().return.schemaVersion
number		Schema version, stamped at the serialization boundary by {@link snapshotOf}.
unitless by name		Required / declared member
No @default declared; consult the signature and description.
toJSON().return.state
Record<string, unknown>		Indicator-private stream state. Round-trip it; never read into it.
unitless by name		Required / declared member
No @default declared; consult the signature and description.
value
number | null
unitless by name		Required / declared member
No @default declared; consult the signature and description.
Stability, warnings & conventions
stable-by-law (pre-1.0; not a 1.0 stability guarantee)

Declared field units are shown above. “Unitless by name” means the name alone does not establish a unit, not that a financial quantity has none. Check source descriptions, conventions, and the returned diagnostics. Errors and warnings are part of the result contract.

class

RollingVwapStream

Public declaration. Read the signature and parameter/member contracts below; no additional behavior is inferred.

export declare class RollingVwapStream implements IndicatorStream<BarInput, number> {
  constructor(period: number);
  static fromJSON(snapshot: TechnicalAnalysisSnapshot): RollingVwapStream;
  value: number | null;
  next(bar: BarInput): number | null;
  toJSON(): TechnicalAnalysisSnapshot;
}
Fields, parameters & returned members (24)
Name / typeMeaning & unitOptional / default
(period)
number
unitless by name		Required / declared member
No @default declared; consult the signature and description.
fromJSON
(snapshot: TechnicalAnalysisSnapshot) => RollingVwapStream
unitless by name		Required / declared member
No @default declared; consult the signature and description.
fromJSON().return.next
(bar: BarInput) => number | null
unitless by name		Required / declared member
No @default declared; consult the signature and description.
fromJSON().return.toJSON
() => TechnicalAnalysisSnapshot
unitless by name		Required / declared member
No @default declared; consult the signature and description.
fromJSON().return.value
number | null
unitless by name		Required / declared member
No @default declared; consult the signature and description.
fromJSON(snapshot)
TechnicalAnalysisSnapshot
unitless by name		Required / declared member
No @default declared; consult the signature and description.
fromJSON(snapshot).kind
string
unitless by name		Required / declared member
No @default declared; consult the signature and description.
fromJSON(snapshot).schemaVersion
number		Schema version, stamped at the serialization boundary by {@link snapshotOf}.
unitless by name		Required / declared member
No @default declared; consult the signature and description.
fromJSON(snapshot).state
Record<string, unknown>		Indicator-private stream state. Round-trip it; never read into it.
unitless by name		Required / declared member
No @default declared; consult the signature and description.
next
(bar: BarInput) => number | null
unitless by name		Required / declared member
No @default declared; consult the signature and description.
next(bar)
BarInput
unitless by name		Required / declared member
No @default declared; consult the signature and description.
next(bar).close
number
unitless by name		Required / declared member
No @default declared; consult the signature and description.
next(bar).high
number
unitless by name		Required / declared member
No @default declared; consult the signature and description.
next(bar).low
number
unitless by name		Required / declared member
No @default declared; consult the signature and description.
next(bar).open
number
unitless by name		Optional
No @default declared; consult the signature and description.
next(bar).volume
number
unitless by name		Optional
No @default declared; consult the signature and description.
return.next
(bar: BarInput) => number | null
unitless by name		Required / declared member
No @default declared; consult the signature and description.
return.toJSON
() => TechnicalAnalysisSnapshot
unitless by name		Required / declared member
No @default declared; consult the signature and description.
return.value
number | null
unitless by name		Required / declared member
No @default declared; consult the signature and description.
toJSON
() => TechnicalAnalysisSnapshot
unitless by name		Required / declared member
No @default declared; consult the signature and description.
toJSON().return.kind
string
unitless by name		Required / declared member
No @default declared; consult the signature and description.
toJSON().return.schemaVersion
number		Schema version, stamped at the serialization boundary by {@link snapshotOf}.
unitless by name		Required / declared member
No @default declared; consult the signature and description.
toJSON().return.state
Record<string, unknown>		Indicator-private stream state. Round-trip it; never read into it.
unitless by name		Required / declared member
No @default declared; consult the signature and description.
value
number | null
unitless by name		Required / declared member
No @default declared; consult the signature and description.
Stability, warnings & conventions
stable-by-law (pre-1.0; not a 1.0 stability guarantee)

Declared field units are shown above. “Unitless by name” means the name alone does not establish a unit, not that a financial quantity has none. Check source descriptions, conventions, and the returned diagnostics. Errors and warnings are part of the result contract.

class

SmaStream

Public declaration. Read the signature and parameter/member contracts below; no additional behavior is inferred.

export declare class SmaStream implements IndicatorStream<number, number> {
  constructor(period: number);
  static fromJSON(snapshot: TechnicalAnalysisSnapshot): SmaStream;
  value: number | null;
  next(value: number): number | null;
  toJSON(): TechnicalAnalysisSnapshot;
}
Fields, parameters & returned members (19)
Name / typeMeaning & unitOptional / default
(period)
number
unitless by name		Required / declared member
No @default declared; consult the signature and description.
fromJSON
(snapshot: TechnicalAnalysisSnapshot) => SmaStream
unitless by name		Required / declared member
No @default declared; consult the signature and description.
fromJSON().return.next
(value: number) => number | null
unitless by name		Required / declared member
No @default declared; consult the signature and description.
fromJSON().return.toJSON
() => TechnicalAnalysisSnapshot
unitless by name		Required / declared member
No @default declared; consult the signature and description.
fromJSON().return.value
number | null
unitless by name		Required / declared member
No @default declared; consult the signature and description.
fromJSON(snapshot)
TechnicalAnalysisSnapshot
unitless by name		Required / declared member
No @default declared; consult the signature and description.
fromJSON(snapshot).kind
string
unitless by name		Required / declared member
No @default declared; consult the signature and description.
fromJSON(snapshot).schemaVersion
number		Schema version, stamped at the serialization boundary by {@link snapshotOf}.
unitless by name		Required / declared member
No @default declared; consult the signature and description.
fromJSON(snapshot).state
Record<string, unknown>		Indicator-private stream state. Round-trip it; never read into it.
unitless by name		Required / declared member
No @default declared; consult the signature and description.
next
(value: number) => number | null
unitless by name		Required / declared member
No @default declared; consult the signature and description.
next(value)
number
unitless by name		Required / declared member
No @default declared; consult the signature and description.
return.next
(value: number) => number | null
unitless by name		Required / declared member
No @default declared; consult the signature and description.
return.toJSON
() => TechnicalAnalysisSnapshot
unitless by name		Required / declared member
No @default declared; consult the signature and description.
return.value
number | null
unitless by name		Required / declared member
No @default declared; consult the signature and description.
toJSON
() => TechnicalAnalysisSnapshot
unitless by name		Required / declared member
No @default declared; consult the signature and description.
toJSON().return.kind
string
unitless by name		Required / declared member
No @default declared; consult the signature and description.
toJSON().return.schemaVersion
number		Schema version, stamped at the serialization boundary by {@link snapshotOf}.
unitless by name		Required / declared member
No @default declared; consult the signature and description.
toJSON().return.state
Record<string, unknown>		Indicator-private stream state. Round-trip it; never read into it.
unitless by name		Required / declared member
No @default declared; consult the signature and description.
value
number | null
unitless by name		Required / declared member
No @default declared; consult the signature and description.
Stability, warnings & conventions
stable-by-law (pre-1.0; not a 1.0 stability guarantee)

Declared field units are shown above. “Unitless by name” means the name alone does not establish a unit, not that a financial quantity has none. Check source descriptions, conventions, and the returned diagnostics. Errors and warnings are part of the result contract.

class

SuperSmootherStream

Public declaration. Read the signature and parameter/member contracts below; no additional behavior is inferred.

export declare class SuperSmootherStream implements IndicatorStream<number, number> {
  constructor(period: number);
  static fromJSON(snapshot: TechnicalAnalysisSnapshot): SuperSmootherStream;
  value: number | null;
  next(value: number): number | null;
  toJSON(): TechnicalAnalysisSnapshot;
}
Fields, parameters & returned members (19)
Name / typeMeaning & unitOptional / default
(period)
number
unitless by name		Required / declared member
No @default declared; consult the signature and description.
fromJSON
(snapshot: TechnicalAnalysisSnapshot) => SuperSmootherStream
unitless by name		Required / declared member
No @default declared; consult the signature and description.
fromJSON().return.next
(value: number) => number | null
unitless by name		Required / declared member
No @default declared; consult the signature and description.
fromJSON().return.toJSON
() => TechnicalAnalysisSnapshot
unitless by name		Required / declared member
No @default declared; consult the signature and description.
fromJSON().return.value
number | null
unitless by name		Required / declared member
No @default declared; consult the signature and description.
fromJSON(snapshot)
TechnicalAnalysisSnapshot
unitless by name		Required / declared member
No @default declared; consult the signature and description.
fromJSON(snapshot).kind
string
unitless by name		Required / declared member
No @default declared; consult the signature and description.
fromJSON(snapshot).schemaVersion
number		Schema version, stamped at the serialization boundary by {@link snapshotOf}.
unitless by name		Required / declared member
No @default declared; consult the signature and description.
fromJSON(snapshot).state
Record<string, unknown>		Indicator-private stream state. Round-trip it; never read into it.
unitless by name		Required / declared member
No @default declared; consult the signature and description.
next
(value: number) => number | null
unitless by name		Required / declared member
No @default declared; consult the signature and description.
next(value)
number
unitless by name		Required / declared member
No @default declared; consult the signature and description.
return.next
(value: number) => number | null
unitless by name		Required / declared member
No @default declared; consult the signature and description.
return.toJSON
() => TechnicalAnalysisSnapshot
unitless by name		Required / declared member
No @default declared; consult the signature and description.
return.value
number | null
unitless by name		Required / declared member
No @default declared; consult the signature and description.
toJSON
() => TechnicalAnalysisSnapshot
unitless by name		Required / declared member
No @default declared; consult the signature and description.
toJSON().return.kind
string
unitless by name		Required / declared member
No @default declared; consult the signature and description.
toJSON().return.schemaVersion
number		Schema version, stamped at the serialization boundary by {@link snapshotOf}.
unitless by name		Required / declared member
No @default declared; consult the signature and description.
toJSON().return.state
Record<string, unknown>		Indicator-private stream state. Round-trip it; never read into it.
unitless by name		Required / declared member
No @default declared; consult the signature and description.
value
number | null
unitless by name		Required / declared member
No @default declared; consult the signature and description.
Stability, warnings & conventions
stable-by-law (pre-1.0; not a 1.0 stability guarantee)

Declared field units are shown above. “Unitless by name” means the name alone does not establish a unit, not that a financial quantity has none. Check source descriptions, conventions, and the returned diagnostics. Errors and warnings are part of the result contract.

interface

T3Parameters

Public declaration. Read the signature and parameter/member contracts below; no additional behavior is inferred.

// ───────────────────────── T3 (Tillson) ─────────────────────────
export interface T3Parameters {
    period: number;
    /** Tillson volume factor (0–1). Default 0.7. */
    volumeFactor?: number;
}
Fields, parameters & returned members (2)
Name / typeMeaning & unitOptional / default
period
number
unitless by name		Required / declared member
No @default declared; consult the signature and description.
volumeFactor
number		Tillson volume factor (0–1). Default 0.7.
decimal fraction / multiple		Optional
No @default declared; consult the signature and description.
Stability, warnings & conventions
stable-by-law (pre-1.0; not a 1.0 stability guarantee)

Declared field units are shown above. “Unitless by name” means the name alone does not establish a unit, not that a financial quantity has none. Check source descriptions, conventions, and the returned diagnostics. Errors and warnings are part of the result contract.

class

T3Stream

Public declaration. Read the signature and parameter/member contracts below; no additional behavior is inferred.

export declare class T3Stream implements IndicatorStream<number, number> {
  constructor(parameters: { period: number; volumeFactor: number; });
  static fromJSON(snapshot: TechnicalAnalysisSnapshot): T3Stream;
  value: number | null;
  next(value: number): number | null;
  toJSON(): TechnicalAnalysisSnapshot;
}
Fields, parameters & returned members (21)
Name / typeMeaning & unitOptional / default
(parameters)
{ period: number; volumeFactor: number; }
unitless by name		Required / declared member
No @default declared; consult the signature and description.
(parameters).period
number
unitless by name		Required / declared member
No @default declared; consult the signature and description.
(parameters).volumeFactor
number
decimal fraction / multiple		Required / declared member
No @default declared; consult the signature and description.
fromJSON
(snapshot: TechnicalAnalysisSnapshot) => T3Stream
unitless by name		Required / declared member
No @default declared; consult the signature and description.
fromJSON().return.next
(value: number) => number | null
unitless by name		Required / declared member
No @default declared; consult the signature and description.
fromJSON().return.toJSON
() => TechnicalAnalysisSnapshot
unitless by name		Required / declared member
No @default declared; consult the signature and description.
fromJSON().return.value
number | null
unitless by name		Required / declared member
No @default declared; consult the signature and description.
fromJSON(snapshot)
TechnicalAnalysisSnapshot
unitless by name		Required / declared member
No @default declared; consult the signature and description.
fromJSON(snapshot).kind
string
unitless by name		Required / declared member
No @default declared; consult the signature and description.
fromJSON(snapshot).schemaVersion
number		Schema version, stamped at the serialization boundary by {@link snapshotOf}.
unitless by name		Required / declared member
No @default declared; consult the signature and description.
fromJSON(snapshot).state
Record<string, unknown>		Indicator-private stream state. Round-trip it; never read into it.
unitless by name		Required / declared member
No @default declared; consult the signature and description.
next
(value: number) => number | null
unitless by name		Required / declared member
No @default declared; consult the signature and description.
next(value)
number
unitless by name		Required / declared member
No @default declared; consult the signature and description.
return.next
(value: number) => number | null
unitless by name		Required / declared member
No @default declared; consult the signature and description.
return.toJSON
() => TechnicalAnalysisSnapshot
unitless by name		Required / declared member
No @default declared; consult the signature and description.
return.value
number | null
unitless by name		Required / declared member
No @default declared; consult the signature and description.
toJSON
() => TechnicalAnalysisSnapshot
unitless by name		Required / declared member
No @default declared; consult the signature and description.
toJSON().return.kind
string
unitless by name		Required / declared member
No @default declared; consult the signature and description.
toJSON().return.schemaVersion
number		Schema version, stamped at the serialization boundary by {@link snapshotOf}.
unitless by name		Required / declared member
No @default declared; consult the signature and description.
toJSON().return.state
Record<string, unknown>		Indicator-private stream state. Round-trip it; never read into it.
unitless by name		Required / declared member
No @default declared; consult the signature and description.
value
number | null
unitless by name		Required / declared member
No @default declared; consult the signature and description.
Stability, warnings & conventions
stable-by-law (pre-1.0; not a 1.0 stability guarantee)

Declared field units are shown above. “Unitless by name” means the name alone does not establish a unit, not that a financial quantity has none. Check source descriptions, conventions, and the returned diagnostics. Errors and warnings are part of the result contract.

class

TemaStream

Public declaration. Read the signature and parameter/member contracts below; no additional behavior is inferred.

export declare class TemaStream implements IndicatorStream<number, number> {
  constructor(period: number);
  static fromJSON(snapshot: TechnicalAnalysisSnapshot): TemaStream;
  value: number | null;
  next(value: number): number | null;
  toJSON(): TechnicalAnalysisSnapshot;
}
Fields, parameters & returned members (19)
Name / typeMeaning & unitOptional / default
(period)
number
unitless by name		Required / declared member
No @default declared; consult the signature and description.
fromJSON
(snapshot: TechnicalAnalysisSnapshot) => TemaStream
unitless by name		Required / declared member
No @default declared; consult the signature and description.
fromJSON().return.next
(value: number) => number | null
unitless by name		Required / declared member
No @default declared; consult the signature and description.
fromJSON().return.toJSON
() => TechnicalAnalysisSnapshot
unitless by name		Required / declared member
No @default declared; consult the signature and description.
fromJSON().return.value
number | null
unitless by name		Required / declared member
No @default declared; consult the signature and description.
fromJSON(snapshot)
TechnicalAnalysisSnapshot
unitless by name		Required / declared member
No @default declared; consult the signature and description.
fromJSON(snapshot).kind
string
unitless by name		Required / declared member
No @default declared; consult the signature and description.
fromJSON(snapshot).schemaVersion
number		Schema version, stamped at the serialization boundary by {@link snapshotOf}.
unitless by name		Required / declared member
No @default declared; consult the signature and description.
fromJSON(snapshot).state
Record<string, unknown>		Indicator-private stream state. Round-trip it; never read into it.
unitless by name		Required / declared member
No @default declared; consult the signature and description.
next
(value: number) => number | null
unitless by name		Required / declared member
No @default declared; consult the signature and description.
next(value)
number
unitless by name		Required / declared member
No @default declared; consult the signature and description.
return.next
(value: number) => number | null
unitless by name		Required / declared member
No @default declared; consult the signature and description.
return.toJSON
() => TechnicalAnalysisSnapshot
unitless by name		Required / declared member
No @default declared; consult the signature and description.
return.value
number | null
unitless by name		Required / declared member
No @default declared; consult the signature and description.
toJSON
() => TechnicalAnalysisSnapshot
unitless by name		Required / declared member
No @default declared; consult the signature and description.
toJSON().return.kind
string
unitless by name		Required / declared member
No @default declared; consult the signature and description.
toJSON().return.schemaVersion
number		Schema version, stamped at the serialization boundary by {@link snapshotOf}.
unitless by name		Required / declared member
No @default declared; consult the signature and description.
toJSON().return.state
Record<string, unknown>		Indicator-private stream state. Round-trip it; never read into it.
unitless by name		Required / declared member
No @default declared; consult the signature and description.
value
number | null
unitless by name		Required / declared member
No @default declared; consult the signature and description.
Stability, warnings & conventions
stable-by-law (pre-1.0; not a 1.0 stability guarantee)

Declared field units are shown above. “Unitless by name” means the name alone does not establish a unit, not that a financial quantity has none. Check source descriptions, conventions, and the returned diagnostics. Errors and warnings are part of the result contract.

class

TrimaStream

Public declaration. Read the signature and parameter/member contracts below; no additional behavior is inferred.

export declare class TrimaStream implements IndicatorStream<number, number> {
  constructor(period: number);
  static fromJSON(snapshot: TechnicalAnalysisSnapshot): TrimaStream;
  value: number | null;
  next(value: number): number | null;
  toJSON(): TechnicalAnalysisSnapshot;
}
Fields, parameters & returned members (19)
Name / typeMeaning & unitOptional / default
(period)
number
unitless by name		Required / declared member
No @default declared; consult the signature and description.
fromJSON
(snapshot: TechnicalAnalysisSnapshot) => TrimaStream
unitless by name		Required / declared member
No @default declared; consult the signature and description.
fromJSON().return.next
(value: number) => number | null
unitless by name		Required / declared member
No @default declared; consult the signature and description.
fromJSON().return.toJSON
() => TechnicalAnalysisSnapshot
unitless by name		Required / declared member
No @default declared; consult the signature and description.
fromJSON().return.value
number | null
unitless by name		Required / declared member
No @default declared; consult the signature and description.
fromJSON(snapshot)
TechnicalAnalysisSnapshot
unitless by name		Required / declared member
No @default declared; consult the signature and description.
fromJSON(snapshot).kind
string
unitless by name		Required / declared member
No @default declared; consult the signature and description.
fromJSON(snapshot).schemaVersion
number		Schema version, stamped at the serialization boundary by {@link snapshotOf}.
unitless by name		Required / declared member
No @default declared; consult the signature and description.
fromJSON(snapshot).state
Record<string, unknown>		Indicator-private stream state. Round-trip it; never read into it.
unitless by name		Required / declared member
No @default declared; consult the signature and description.
next
(value: number) => number | null
unitless by name		Required / declared member
No @default declared; consult the signature and description.
next(value)
number
unitless by name		Required / declared member
No @default declared; consult the signature and description.
return.next
(value: number) => number | null
unitless by name		Required / declared member
No @default declared; consult the signature and description.
return.toJSON
() => TechnicalAnalysisSnapshot
unitless by name		Required / declared member
No @default declared; consult the signature and description.
return.value
number | null
unitless by name		Required / declared member
No @default declared; consult the signature and description.
toJSON
() => TechnicalAnalysisSnapshot
unitless by name		Required / declared member
No @default declared; consult the signature and description.
toJSON().return.kind
string
unitless by name		Required / declared member
No @default declared; consult the signature and description.
toJSON().return.schemaVersion
number		Schema version, stamped at the serialization boundary by {@link snapshotOf}.
unitless by name		Required / declared member
No @default declared; consult the signature and description.
toJSON().return.state
Record<string, unknown>		Indicator-private stream state. Round-trip it; never read into it.
unitless by name		Required / declared member
No @default declared; consult the signature and description.
value
number | null
unitless by name		Required / declared member
No @default declared; consult the signature and description.
Stability, warnings & conventions
stable-by-law (pre-1.0; not a 1.0 stability guarantee)

Declared field units are shown above. “Unitless by name” means the name alone does not establish a unit, not that a financial quantity has none. Check source descriptions, conventions, and the returned diagnostics. Errors and warnings are part of the result contract.

interface

VidyaParameters

Public declaration. Read the signature and parameter/member contracts below; no additional behavior is inferred.

// ───────────────────────── VIDYA (Chande variable index) ─────────────────────────
export interface VidyaParameters {
    period: number;
    /** CMO lookback driving the volatility index. Default = period. */
    cmoPeriod?: number;
}
Fields, parameters & returned members (2)
Name / typeMeaning & unitOptional / default
cmoPeriod
number		CMO lookback driving the volatility index. Default = period.
unitless by name		Optional
No @default declared; consult the signature and description.
period
number
unitless by name		Required / declared member
No @default declared; consult the signature and description.
Stability, warnings & conventions
stable-by-law (pre-1.0; not a 1.0 stability guarantee)

Declared field units are shown above. “Unitless by name” means the name alone does not establish a unit, not that a financial quantity has none. Check source descriptions, conventions, and the returned diagnostics. Errors and warnings are part of the result contract.