@insiderfinance/totalfinance/technical-analysis/chart-types

interface

AggregateStream

A streaming aggregator: each input bar yields zero or more completed output units.

/** A streaming aggregator: each input bar yields zero or more completed output units. */
export interface AggregateStream<Out> {
    next(bar: BarInput): Out[];
    toJSON(): TechnicalAnalysisSnapshot;
}

Fields, parameters & returned members (11)

Name / type	Meaning & unit	Optional / default
`next` `(bar: BarInput) => Out[]`	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.
`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.

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

BarAggregator

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

export declare class BarAggregator implements AggregateStream<BarInput> {
  constructor(parameters: { kind: string; shouldClose: CloseRule; });
  flush(): BarInput[];
  next(bar: BarInput): BarInput[];
  restore(snapshot: TechnicalAnalysisSnapshot): void;
  toJSON(): TechnicalAnalysisSnapshot;
}

Fields, parameters & returned members (24)

Name / type	Meaning & unit	Optional / default
`(parameters)` `{ kind: string; shouldClose: CloseRule; }`	unitless by name	Required / declared member No @default declared; consult the signature and description.
`(parameters).kind` `string`	unitless by name	Required / declared member No @default declared; consult the signature and description.
`(parameters).shouldClose` `CloseRule`	unitless by name	Required / declared member No @default declared; consult the signature and description.
`flush` `() => BarInput[]`	Emit the final partial bar (if any) — used by the batch wrappers to flush. unitless by name	Required / declared member No @default declared; consult the signature and description.
`next` `(bar: BarInput) => BarInput[]`	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.
`restore` `(snapshot: TechnicalAnalysisSnapshot) => void`	Restore this aggregator's forming-bar state from a snapshot produced by `toJSON()` (the close rule is a function, so rebuild the aggregator via its factory — e.g. `aggregators.volume(500)` — then restore). Validates the schema version and the snapshot `kind`, and deep-copies the state, so restoring twice from one snapshot yields independent aggregators. unitless by name	Required / declared member No @default declared; consult the signature and description.
`restore(snapshot)` `TechnicalAnalysisSnapshot`	unitless by name	Required / declared member No @default declared; consult the signature and description.
`restore(snapshot).kind` `string`	unitless by name	Required / declared member No @default declared; consult the signature and description.
`restore(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.
`restore(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.
`return.flush` `() => BarInput[]`	Emit the final partial bar (if any) — used by the batch wrappers to flush. unitless by name	Required / declared member No @default declared; consult the signature and description.
`return.next` `(bar: BarInput) => BarInput[]`	unitless by name	Required / declared member No @default declared; consult the signature and description.
`return.restore` `(snapshot: TechnicalAnalysisSnapshot) => void`	Restore this aggregator's forming-bar state from a snapshot produced by `toJSON()` (the close rule is a function, so rebuild the aggregator via its factory — e.g. `aggregators.volume(500)` — then restore). Validates the schema version and the snapshot `kind`, and deep-copies the state, so restoring twice from one snapshot yields independent aggregators. 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.
`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.

Stability, warnings & conventions

stable-by-law (pre-1.0; not a 1.0 stability guarantee)

interface

CountBarParameters

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

export interface CountBarParameters {
    count: number;
    flush?: boolean;
}

Fields, parameters & returned members (2)

Name / type	Meaning & unit	Optional / default
`count` `number`	unitless by name	Required / declared member No @default declared; consult the signature and description.
`flush` `boolean`	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)

interface

DollarBarParameters

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

export interface DollarBarParameters {
    dollar: number;
    flush?: boolean;
}

Fields, parameters & returned members (2)

Name / type	Meaning & unit	Optional / default
`dollar` `number`	unitless by name	Required / declared member No @default declared; consult the signature and description.
`flush` `boolean`	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)

interface

HeikinAshiBar

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

// ---- Heikin-Ashi (smoothed candles; also re-exported by chart-types) ----
export interface HeikinAshiBar {
    open: number;
    high: number;
    low: number;
    close: number;
}

Fields, parameters & returned members (4)

Name / type	Meaning & unit	Optional / default
`close` `number`	unitless by name	Required / declared member No @default declared; consult the signature and description.
`high` `number`	unitless by name	Required / declared member No @default declared; consult the signature and description.
`low` `number`	unitless by name	Required / declared member No @default declared; consult the signature and description.
`open` `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)

class

InformationBarAggregator

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

export declare class InformationBarAggregator implements AggregateStream<BarInput>, FlushableAgg {
  constructor(parameters: { kind: string; mode: InfoMode; threshold: number; weight: InfoWeight; });
  static fromJSON(snapshot: TechnicalAnalysisSnapshot): InformationBarAggregator;
  flush(): BarInput[];
  next(bar: BarInput): BarInput[];
  toJSON(): TechnicalAnalysisSnapshot;
}

Fields, parameters & returned members (28)

Name / type	Meaning & unit	Optional / default
`(parameters)` `{ kind: string; mode: InfoMode; threshold: number; weight: InfoWeight; }`	unitless by name	Required / declared member No @default declared; consult the signature and description.
`(parameters).kind` `string`	unitless by name	Required / declared member No @default declared; consult the signature and description.
`(parameters).mode` `'imbalance' \| 'run'`	unitless by name	Required / declared member No @default declared; consult the signature and description.
`(parameters).threshold` `number`	unitless by name	Required / declared member No @default declared; consult the signature and description.
`(parameters).weight` `'tick' \| 'volume' \| 'dollar'`	unitless by name	Required / declared member No @default declared; consult the signature and description.
`flush` `() => BarInput[]`	unitless by name	Required / declared member No @default declared; consult the signature and description.
`fromJSON` `(snapshot: TechnicalAnalysisSnapshot) => InformationBarAggregator`	unitless by name	Required / declared member No @default declared; consult the signature and description.
`fromJSON().return.flush` `() => BarInput[]`	unitless by name	Required / declared member No @default declared; consult the signature and description.
`fromJSON().return.next` `(bar: BarInput) => BarInput[]`	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(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) => BarInput[]`	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.flush` `() => BarInput[]`	unitless by name	Required / declared member No @default declared; consult the signature and description.
`return.next` `(bar: BarInput) => BarInput[]`	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.
`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.

Stability, warnings & conventions

stable-by-law (pre-1.0; not a 1.0 stability guarantee)

interface

InformationBarParameters

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

export interface InformationBarParameters {
    /** Imbalance/run magnitude that closes a bar. */
    threshold: number;
    /** Emit the trailing partial bar. Default true. */
    flush?: boolean;
}

Fields, parameters & returned members (2)

Name / type	Meaning & unit	Optional / default
`flush` `boolean`	Emit the trailing partial bar. Default true. unitless by name	Optional No @default declared; consult the signature and description.
`threshold` `number`	Imbalance/run magnitude that closes a bar. 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)

interface

KagiParameters

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

// ───────────────────────── Kagi (batch) ─────────────────────────
export interface KagiParameters {
    /** Reversal amount. Absolute price by default, or a percent of price if `percent` is true. */
    reversal: number;
    percent?: boolean;
}

Fields, parameters & returned members (2)

Name / type	Meaning & unit	Optional / default
`percent` `boolean`	unitless by name	Optional No @default declared; consult the signature and description.
`reversal` `number`	Reversal amount. Absolute price by default, or a percent of price if `percent` is true. 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)

interface

KagiSegment

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

export interface KagiSegment {
    from: number;
    to: number;
    direction: 1 | -1;
    /** Yang (thick) once price rises above the prior shoulder; yin (thin) below the prior waist. */
    line: 'yang' | 'yin';
}

Fields, parameters & returned members (4)

Name / type	Meaning & unit	Optional / default
`direction` `1 \| -1`	unitless by name	Required / declared member No @default declared; consult the signature and description.
`from` `number`	unitless by name	Required / declared member No @default declared; consult the signature and description.
`line` `'yang' \| 'yin'`	Yang (thick) once price rises above the prior shoulder; yin (thin) below the prior waist. unitless by name	Required / declared member No @default declared; consult the signature and description.
`to` `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)

interface

LineBreakBar

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

export interface LineBreakBar {
    open: number;
    close: number;
    direction: 1 | -1;
}

Fields, parameters & returned members (3)

Name / type	Meaning & unit	Optional / default
`close` `number`	unitless by name	Required / declared member No @default declared; consult the signature and description.
`direction` `1 \| -1`	unitless by name	Required / declared member No @default declared; consult the signature and description.
`open` `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)

interface

LineBreakParameters

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

// ───────────────────────── Three-Line Break ─────────────────────────
export interface LineBreakParameters {
    lines?: number;
}

Fields, parameters & returned members (1)

Name / type	Meaning & unit	Optional / default
`lines` `number`	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)

class

LineBreakStream

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

export declare class LineBreakStream implements AggregateStream<LineBreakBar> {
  constructor(count: number);
  static fromJSON(snapshot: TechnicalAnalysisSnapshot): LineBreakStream;
  next(bar: BarInput): LineBreakBar[];
  toJSON(): TechnicalAnalysisSnapshot;
}

Fields, parameters & returned members (21)

Name / type	Meaning & unit	Optional / default
`(count)` `number`	unitless by name	Required / declared member No @default declared; consult the signature and description.
`fromJSON` `(snapshot: TechnicalAnalysisSnapshot) => LineBreakStream`	unitless by name	Required / declared member No @default declared; consult the signature and description.
`fromJSON().return.next` `(bar: BarInput) => LineBreakBar[]`	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(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) => LineBreakBar[]`	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) => LineBreakBar[]`	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.
`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.

Stability, warnings & conventions

stable-by-law (pre-1.0; not a 1.0 stability guarantee)

interface

PnfColumn

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

export interface PnfColumn {
    kind: 'X' | 'O';
    low: number;
    high: number;
    boxes: number;
}

Fields, parameters & returned members (4)

Name / type	Meaning & unit	Optional / default
`boxes` `number`	unitless by name	Required / declared member No @default declared; consult the signature and description.
`high` `number`	unitless by name	Required / declared member No @default declared; consult the signature and description.
`kind` `'X' \| 'O'`	unitless by name	Required / declared member No @default declared; consult the signature and description.
`low` `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)

interface

PnfParameters

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

// ───────────────────────── Point & Figure (batch) ─────────────────────────
export interface PnfParameters {
    boxSize: number;
    reversal?: number;
}

Fields, parameters & returned members (2)

Name / type	Meaning & unit	Optional / default
`boxSize` `number`	count (integer)	Required / declared member No @default declared; consult the signature and description.
`reversal` `number`	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)

interface

RangeBarParameters

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

export interface RangeBarParameters {
    size: number;
    /** Emit the trailing partial bar. Default true. */
    flush?: boolean;
}

Fields, parameters & returned members (2)

Name / type	Meaning & unit	Optional / default
`flush` `boolean`	Emit the trailing partial bar. Default true. unitless by name	Optional No @default declared; consult the signature and description.
`size` `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)

interface

RenkoBrick

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

export interface RenkoBrick {
    open: number;
    close: number;
    direction: 1 | -1;
}

Fields, parameters & returned members (3)

Name / type	Meaning & unit	Optional / default
`close` `number`	unitless by name	Required / declared member No @default declared; consult the signature and description.
`direction` `1 \| -1`	unitless by name	Required / declared member No @default declared; consult the signature and description.
`open` `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)

interface

RenkoParameters

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

// ───────────────────────── Renko ─────────────────────────
export interface RenkoParameters {
    brickSize: number;
}

Fields, parameters & returned members (1)

Name / type	Meaning & unit	Optional / default
`brickSize` `number`	count (integer)	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)

class

RenkoStream

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

export declare class RenkoStream implements AggregateStream<RenkoBrick> {
  constructor(brick: number);
  static fromJSON(snapshot: TechnicalAnalysisSnapshot): RenkoStream;
  next(bar: BarInput): RenkoBrick[];
  toJSON(): TechnicalAnalysisSnapshot;
}

Fields, parameters & returned members (21)

Name / type	Meaning & unit	Optional / default
`(brick)` `number`	unitless by name	Required / declared member No @default declared; consult the signature and description.
`fromJSON` `(snapshot: TechnicalAnalysisSnapshot) => RenkoStream`	unitless by name	Required / declared member No @default declared; consult the signature and description.
`fromJSON().return.next` `(bar: BarInput) => RenkoBrick[]`	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(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) => RenkoBrick[]`	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) => RenkoBrick[]`	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.
`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.

Stability, warnings & conventions

stable-by-law (pre-1.0; not a 1.0 stability guarantee)

interface

VolumeBarParameters

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

export interface VolumeBarParameters {
    volume: number;
    flush?: boolean;
}

Fields, parameters & returned members (2)

Name / type	Meaning & unit	Optional / default
`flush` `boolean`	unitless by name	Optional No @default declared; consult the signature and description.
`volume` `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)

value

aggregators

Streaming aggregators for live bar construction (each returns completed bars per input bar).

export declare const aggregators: { readonly dollar: (threshold: number) => BarAggregator; readonly dollarImbalance: (threshold: number) => InformationBarAggregator; readonly dollarRun: (threshold: number) => InformationBarAggregator; readonly imbalance: (threshold: number) => InformationBarAggregator; readonly range: (size: number) => BarAggregator; readonly run: (threshold: number) => InformationBarAggregator; readonly tick: (count: number) => BarAggregator; readonly volume: (threshold: number) => BarAggregator; readonly volumeImbalance: (threshold: number) => InformationBarAggregator; readonly volumeRun: (threshold: number) => InformationBarAggregator; };

Fields, parameters & returned members (54)

Name / type	Meaning & unit	Optional / default
`dollar` `(threshold: number) => BarAggregator`	unitless by name	Required / declared member No @default declared; consult the signature and description.
`dollar().return.flush` `() => BarInput[]`	Emit the final partial bar (if any) — used by the batch wrappers to flush. unitless by name	Required / declared member No @default declared; consult the signature and description.
`dollar().return.next` `(bar: BarInput) => BarInput[]`	unitless by name	Required / declared member No @default declared; consult the signature and description.
`dollar().return.restore` `(snapshot: TechnicalAnalysisSnapshot) => void`	Restore this aggregator's forming-bar state from a snapshot produced by `toJSON()` (the close rule is a function, so rebuild the aggregator via its factory — e.g. `aggregators.volume(500)` — then restore). Validates the schema version and the snapshot `kind`, and deep-copies the state, so restoring twice from one snapshot yields independent aggregators. unitless by name	Required / declared member No @default declared; consult the signature and description.
`dollar().return.toJSON` `() => TechnicalAnalysisSnapshot`	unitless by name	Required / declared member No @default declared; consult the signature and description.
`dollar(threshold)` `number`	unitless by name	Required / declared member No @default declared; consult the signature and description.
`dollarImbalance` `(threshold: number) => InformationBarAggregator`	unitless by name	Required / declared member No @default declared; consult the signature and description.
`dollarImbalance().return.flush` `() => BarInput[]`	unitless by name	Required / declared member No @default declared; consult the signature and description.
`dollarImbalance().return.next` `(bar: BarInput) => BarInput[]`	unitless by name	Required / declared member No @default declared; consult the signature and description.
`dollarImbalance().return.toJSON` `() => TechnicalAnalysisSnapshot`	unitless by name	Required / declared member No @default declared; consult the signature and description.
`dollarImbalance(threshold)` `number`	unitless by name	Required / declared member No @default declared; consult the signature and description.
`dollarRun` `(threshold: number) => InformationBarAggregator`	unitless by name	Required / declared member No @default declared; consult the signature and description.
`dollarRun().return.flush` `() => BarInput[]`	unitless by name	Required / declared member No @default declared; consult the signature and description.
`dollarRun().return.next` `(bar: BarInput) => BarInput[]`	unitless by name	Required / declared member No @default declared; consult the signature and description.
`dollarRun().return.toJSON` `() => TechnicalAnalysisSnapshot`	unitless by name	Required / declared member No @default declared; consult the signature and description.
`dollarRun(threshold)` `number`	unitless by name	Required / declared member No @default declared; consult the signature and description.
`imbalance` `(threshold: number) => InformationBarAggregator`	unitless by name	Required / declared member No @default declared; consult the signature and description.
`imbalance().return.flush` `() => BarInput[]`	unitless by name	Required / declared member No @default declared; consult the signature and description.
`imbalance().return.next` `(bar: BarInput) => BarInput[]`	unitless by name	Required / declared member No @default declared; consult the signature and description.
`imbalance().return.toJSON` `() => TechnicalAnalysisSnapshot`	unitless by name	Required / declared member No @default declared; consult the signature and description.
`imbalance(threshold)` `number`	unitless by name	Required / declared member No @default declared; consult the signature and description.
`range` `(size: number) => BarAggregator`	unitless by name	Required / declared member No @default declared; consult the signature and description.
`range().return.flush` `() => BarInput[]`	Emit the final partial bar (if any) — used by the batch wrappers to flush. unitless by name	Required / declared member No @default declared; consult the signature and description.
`range().return.next` `(bar: BarInput) => BarInput[]`	unitless by name	Required / declared member No @default declared; consult the signature and description.
`range().return.restore` `(snapshot: TechnicalAnalysisSnapshot) => void`	Restore this aggregator's forming-bar state from a snapshot produced by `toJSON()` (the close rule is a function, so rebuild the aggregator via its factory — e.g. `aggregators.volume(500)` — then restore). Validates the schema version and the snapshot `kind`, and deep-copies the state, so restoring twice from one snapshot yields independent aggregators. unitless by name	Required / declared member No @default declared; consult the signature and description.
`range().return.toJSON` `() => TechnicalAnalysisSnapshot`	unitless by name	Required / declared member No @default declared; consult the signature and description.
`range(size)` `number`	unitless by name	Required / declared member No @default declared; consult the signature and description.
`run` `(threshold: number) => InformationBarAggregator`	unitless by name	Required / declared member No @default declared; consult the signature and description.
`run().return.flush` `() => BarInput[]`	unitless by name	Required / declared member No @default declared; consult the signature and description.
`run().return.next` `(bar: BarInput) => BarInput[]`	unitless by name	Required / declared member No @default declared; consult the signature and description.
`run().return.toJSON` `() => TechnicalAnalysisSnapshot`	unitless by name	Required / declared member No @default declared; consult the signature and description.
`run(threshold)` `number`	unitless by name	Required / declared member No @default declared; consult the signature and description.
`tick` `(count: number) => BarAggregator`	unitless by name	Required / declared member No @default declared; consult the signature and description.
`tick().return.flush` `() => BarInput[]`	Emit the final partial bar (if any) — used by the batch wrappers to flush. unitless by name	Required / declared member No @default declared; consult the signature and description.
`tick().return.next` `(bar: BarInput) => BarInput[]`	unitless by name	Required / declared member No @default declared; consult the signature and description.
`tick().return.restore` `(snapshot: TechnicalAnalysisSnapshot) => void`	Restore this aggregator's forming-bar state from a snapshot produced by `toJSON()` (the close rule is a function, so rebuild the aggregator via its factory — e.g. `aggregators.volume(500)` — then restore). Validates the schema version and the snapshot `kind`, and deep-copies the state, so restoring twice from one snapshot yields independent aggregators. unitless by name	Required / declared member No @default declared; consult the signature and description.
`tick().return.toJSON` `() => TechnicalAnalysisSnapshot`	unitless by name	Required / declared member No @default declared; consult the signature and description.
`tick(count)` `number`	unitless by name	Required / declared member No @default declared; consult the signature and description.
`volume` `(threshold: number) => BarAggregator`	unitless by name	Required / declared member No @default declared; consult the signature and description.
`volume().return.flush` `() => BarInput[]`	Emit the final partial bar (if any) — used by the batch wrappers to flush. unitless by name	Required / declared member No @default declared; consult the signature and description.
`volume().return.next` `(bar: BarInput) => BarInput[]`	unitless by name	Required / declared member No @default declared; consult the signature and description.
`volume().return.restore` `(snapshot: TechnicalAnalysisSnapshot) => void`	Restore this aggregator's forming-bar state from a snapshot produced by `toJSON()` (the close rule is a function, so rebuild the aggregator via its factory — e.g. `aggregators.volume(500)` — then restore). Validates the schema version and the snapshot `kind`, and deep-copies the state, so restoring twice from one snapshot yields independent aggregators. unitless by name	Required / declared member No @default declared; consult the signature and description.
`volume().return.toJSON` `() => TechnicalAnalysisSnapshot`	unitless by name	Required / declared member No @default declared; consult the signature and description.
`volume(threshold)` `number`	unitless by name	Required / declared member No @default declared; consult the signature and description.
`volumeImbalance` `(threshold: number) => InformationBarAggregator`	unitless by name	Required / declared member No @default declared; consult the signature and description.
`volumeImbalance().return.flush` `() => BarInput[]`	unitless by name	Required / declared member No @default declared; consult the signature and description.
`volumeImbalance().return.next` `(bar: BarInput) => BarInput[]`	unitless by name	Required / declared member No @default declared; consult the signature and description.
`volumeImbalance().return.toJSON` `() => TechnicalAnalysisSnapshot`	unitless by name	Required / declared member No @default declared; consult the signature and description.
`volumeImbalance(threshold)` `number`	unitless by name	Required / declared member No @default declared; consult the signature and description.
`volumeRun` `(threshold: number) => InformationBarAggregator`	unitless by name	Required / declared member No @default declared; consult the signature and description.
`volumeRun().return.flush` `() => BarInput[]`	unitless by name	Required / declared member No @default declared; consult the signature and description.
`volumeRun().return.next` `(bar: BarInput) => BarInput[]`	unitless by name	Required / declared member No @default declared; consult the signature and description.
`volumeRun().return.toJSON` `() => TechnicalAnalysisSnapshot`	unitless by name	Required / declared member No @default declared; consult the signature and description.
`volumeRun(threshold)` `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)

function

dollarBars

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

export declare function dollarBars(bars: ArrayLike<BarInput>, parameters: DollarBarParameters): BarInput[];

Fields, parameters & returned members (4)

Name / type	Meaning & unit	Optional / default
`(bars)` `ArrayLike<BarInput>`	unitless by name	Required / declared member No @default declared; consult the signature and description.
`(parameters)` `DollarBarParameters`	unitless by name	Required / declared member No @default declared; consult the signature and description.
`(parameters).dollar` `number`	unitless by name	Required / declared member No @default declared; consult the signature and description.
`(parameters).flush` `boolean`	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)

function

dollarImbalanceBars

Dollar imbalance bars — signed dollar value `|Σ sign(Δclose)·close·volume|`.

export declare function dollarImbalanceBars(bars: ArrayLike<BarInput>, parameters: InformationBarParameters): BarInput[];

Fields, parameters & returned members (4)

Name / type	Meaning & unit	Optional / default
`(bars)` `ArrayLike<BarInput>`	unitless by name	Required / declared member No @default declared; consult the signature and description.
`(parameters)` `InformationBarParameters`	unitless by name	Required / declared member No @default declared; consult the signature and description.
`(parameters).flush` `boolean`	Emit the trailing partial bar. Default true. unitless by name	Optional No @default declared; consult the signature and description.
`(parameters).threshold` `number`	Imbalance/run magnitude that closes a bar. 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)

function

dollarRunBars

Dollar run bars — close on the larger one-sided dollar run.

export declare function dollarRunBars(bars: ArrayLike<BarInput>, parameters: InformationBarParameters): BarInput[];

Fields, parameters & returned members (4)

Name / type	Meaning & unit	Optional / default
`(bars)` `ArrayLike<BarInput>`	unitless by name	Required / declared member No @default declared; consult the signature and description.
`(parameters)` `InformationBarParameters`	unitless by name	Required / declared member No @default declared; consult the signature and description.
`(parameters).flush` `boolean`	Emit the trailing partial bar. Default true. unitless by name	Optional No @default declared; consult the signature and description.
`(parameters).threshold` `number`	Imbalance/run magnitude that closes a bar. 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)

function

heikinAshi

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

export declare const heikinAshi: import('@insiderfinance/totalfinance/technical-analysis').Indicator<Empty, BarInput, HeikinAshiBar>;

Fields, parameters & returned members (43)

Name / type	Meaning & unit	Optional / default
`(input)` `ArrayLike<BarInput>`	unitless by name	Required / declared member No @default declared; consult the signature and description.
`(parameters)` `Empty \| undefined`	unitless by name	Optional No @default declared; consult the signature and description.
`explain` `(input: ArrayLike<BarInput>, parameters?: Empty \| undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain<HeikinAshiBar>`	unitless by name	Required / declared member No @default declared; consult the signature and description.
`explain().return.assumptions` `import('@insiderfinance/totalfinance/core').Assumptions<import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisAssumptionExtras>`	Every applied convention, echoed back. unitless by name	Required / declared member No @default declared; consult the signature and description.
`explain().return.diagnostics` `import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }`	unitless by name	Required / declared member No @default declared; consult the signature and description.
`explain().return.diagnostics.autoReason` `string`	When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. unitless by name	Optional No @default declared; consult the signature and description.
`explain().return.diagnostics.converged` `boolean`	Whether an iterative procedure converged. `false` means the value is not trustworthy. unitless by name	Optional No @default declared; consult the signature and description.
`explain().return.diagnostics.decomposition` `Record<string, number>`	Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). unitless by name	Optional No @default declared; consult the signature and description.
`explain().return.diagnostics.engine` `string`	Pricing/solver engine name, e.g. `black-scholes-merton`. unitless by name	Optional No @default declared; consult the signature and description.
`explain().return.diagnostics.finiteDifferenceBumps` `Record<string, number>`	Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) unitless by name	Optional No @default declared; consult the signature and description.
`explain().return.diagnostics.iterations` `number`	Iteration count for iterative methods. unitless by name	Optional No @default declared; consult the signature and description.
`explain().return.diagnostics.method` `string`	Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. unitless by name	Optional No @default declared; consult the signature and description.
`explain().return.diagnostics.selection` `import('@insiderfinance/totalfinance/core/pricing').SelectionReport`	The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. unitless by name	Optional No @default declared; consult the signature and description.
`explain().return.diagnostics.timingMs` `number`	Wall-clock timing in milliseconds, when measured. milliseconds	Optional No @default declared; consult the signature and description.
`explain().return.diagnostics.warmup` `number`	Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. unitless by name	Optional No @default declared; consult the signature and description.
`explain().return.diagnostics.warnings` `import('@insiderfinance/totalfinance/core').QuantWarning[]`	Structured warnings; always present (possibly empty). unitless by name	Required / declared member No @default declared; consult the signature and description.
`explain().return.provenance` `import('@insiderfinance/totalfinance/core').Provenance`	Optional data lineage when the inputs came from a provider. unitless by name	Optional No @default declared; consult the signature and description.
`explain().return.value` `HeikinAshiBar[]`	The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). unitless by name	Required / declared member No @default declared; consult the signature and description.
`explain(input)` `ArrayLike<BarInput>`	unitless by name	Required / declared member No @default declared; consult the signature and description.
`explain(parameters)` `Empty \| undefined`	unitless by name	Optional No @default declared; consult the signature and description.
`fromJSON` `(snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream<BarInput, HeikinAshiBar>`	unitless by name	Required / declared member No @default declared; consult the signature and description.
`fromJSON().return.next` `(input: BarInput) => HeikinAshiBar \| null`	unitless by name	Required / declared member No @default declared; consult the signature and description.
`fromJSON().return.peek` `(input: BarInput) => HeikinAshiBar \| null`	The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. 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` `HeikinAshiBar \| null`	unitless by name	Required / declared member No @default declared; consult the signature and description.
`fromJSON().return.value.close` `number`	unitless by name	Required / declared member No @default declared; consult the signature and description.
`fromJSON().return.value.high` `number`	unitless by name	Required / declared member No @default declared; consult the signature and description.
`fromJSON().return.value.low` `number`	unitless by name	Required / declared member No @default declared; consult the signature and description.
`fromJSON().return.value.open` `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.
`stream` `(parameters?: Empty \| undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream<BarInput, HeikinAshiBar>`	unitless by name	Required / declared member No @default declared; consult the signature and description.
`stream().return.next` `(input: BarInput) => HeikinAshiBar \| null`	unitless by name	Required / declared member No @default declared; consult the signature and description.
`stream().return.peek` `(input: BarInput) => HeikinAshiBar \| null`	The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. unitless by name	Required / declared member No @default declared; consult the signature and description.
`stream().return.toJSON` `() => TechnicalAnalysisSnapshot`	unitless by name	Required / declared member No @default declared; consult the signature and description.
`stream().return.value` `HeikinAshiBar \| null`	unitless by name	Required / declared member No @default declared; consult the signature and description.
`stream().return.value.close` `number`	unitless by name	Required / declared member No @default declared; consult the signature and description.
`stream().return.value.high` `number`	unitless by name	Required / declared member No @default declared; consult the signature and description.
`stream().return.value.low` `number`	unitless by name	Required / declared member No @default declared; consult the signature and description.
`stream().return.value.open` `number`	unitless by name	Required / declared member No @default declared; consult the signature and description.
`stream(parameters)` `Empty \| undefined`	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)

function

imbalanceBars

Tick imbalance bars — close on `|Σ sign(Δclose)|`.

export declare function imbalanceBars(bars: ArrayLike<BarInput>, parameters: InformationBarParameters): BarInput[];

Fields, parameters & returned members (4)

Name / type	Meaning & unit	Optional / default
`(bars)` `ArrayLike<BarInput>`	unitless by name	Required / declared member No @default declared; consult the signature and description.
`(parameters)` `InformationBarParameters`	unitless by name	Required / declared member No @default declared; consult the signature and description.
`(parameters).flush` `boolean`	Emit the trailing partial bar. Default true. unitless by name	Optional No @default declared; consult the signature and description.
`(parameters).threshold` `number`	Imbalance/run magnitude that closes a bar. 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)