@pond-ts/financial API Reference
    Preparing search index...

    Interface PriceTransformOptions<S, Output>

    Options shared by the three high/low/close price transforms (typicalPrice, medianPrice, weightedClose).

    medianPrice never reads close, and passing it is harmless — the option is on the shared interface because these are one family with one shape, and three near-identical option types spelled out separately would be three places to drift. (The one that reads the open has its own type: AveragePriceOptions.)

    interface PriceTransformOptions<S extends SeriesSchema, Output extends string> {
        close?: NumericColumnNameForSchema<S>;
        high?: NumericColumnNameForSchema<S>;
        low?: NumericColumnNameForSchema<S>;
        output?: Output;
    }

    Type Parameters

    • S extends SeriesSchema
    • Output extends string

    Hierarchy (View Summary)

    Index

    Properties

    close?: NumericColumnNameForSchema<S>

    Close column. Default 'close'. Unused by medianPrice.

    high?: NumericColumnNameForSchema<S>

    High column. Default 'high'.

    low?: NumericColumnNameForSchema<S>

    Low column. Default 'low'.

    output?: Output

    Name of the appended column. Default the transform's own name.