@beerwright/core
    Preparing search index...

    Interface ExplanationSpec

    Fields of an Explanation other than the value itself.

    interface ExplanationSpec {
        expression: string;
        family?: ExplanationFamily;
        formula: string;
        inputs: ExplainInputs;
        label: string;
        notes?: readonly string[];
        sources?: readonly Source[];
        unit: string;
    }
    Index
    expression family? formula inputs label notes? sources? unit
    expression: string

    The formula written out. See Explanation.expression.

    family?: ExplanationFamily

    Explicitly allows undefined so callers can pass a conditional.

    formula: string

    Stable identifier for the formula. See Explanation.formula.

    inputs: ExplainInputs

    The inputs, in canonical units, keyed by name.

    label: string

    Human label for the value. See Explanation.label.

    notes?: readonly string[]

    Explicitly allows undefined so callers can pass a conditional.

    sources?: readonly Source[]

    Explicitly allows undefined so callers can pass a conditional.

    unit: string

    The result's unit. See Explanation.unit.

    Settings
    Member Visibility

    On This Page
    Properties