Interface ReferenceExample

One worked example with enough in it to cover every family.

Only recipe is required. If a field is left out, that family has nothing to show and is missing from the result (it isn't returned empty).

interface ReferenceExample {
    abvFormulas?: readonly AbvFormula[];
    acid?: AcidAdjustmentInput;
    bitternessFormulas?: readonly IbuFormula[];
    blend?: BlendInput;
    colorFormulas?: readonly ColorFormula[];
    decoction?: DecoctionPullInput;
    equipment?: Partial<EquipmentProfile>;
    forcedCarbonation?: { targetVolumes: number; tempC: number };
    hopStorage?: { alphaAcidPercent: number; storage: HopStorage };
    hotVolume?: { measuredAtC: number; volumeL: number };
    hydrometer?: { measuredGravity: number; sampleTempC: number };
    mixing?: readonly SpiritMixComponent[];
    nutrients?: NutrientScheduleInput;
    options?: CalculationOptions;
    pearson?: PearsonSquareInput;
    pitch?: PitchPlanInput;
    priming?: PrimingInput;
    proofAndSweeten?: ProofAndSweetenInput;
    recipe: RecipeInput;
    refractometer?: {
        finalMeasuredBrix: number;
        originalMeasuredBrix: number;
        wortCorrectionFactor?: number;
    };
    sorbate?: SorbateDoseInput;
    starter?: {
        availableCellsBillion: number;
        options?: StarterPlanOptions;
        targetCellsBillion: number;
    };
    sugarToGravity?: SugarToGravityInput;
    sulfite?: SulfiteDoseInput;
    waterSolver?: WaterSolverInput;
}

Properties

`Optional` `Readonly`abvFormulas

abvFormulas?: readonly AbvFormula[]

ABV formulas to show side by side.

`Optional` `Readonly`acid

acid?: AcidAdjustmentInput

An acid adjustment.

`Optional` `Readonly`bitternessFormulas

bitternessFormulas?: readonly IbuFormula[]

Bitterness models to show side by side, in addition to whichever one options selects. We show them together because the three give different answers for the same hop schedule.

`Optional` `Readonly`blend

blend?: BlendInput

A blend. It's a different beer from the worked example, and its explanation says so.

`Optional` `Readonly`colorFormulas

colorFormulas?: readonly ColorFormula[]

Colour fits to show side by side.

`Optional` `Readonly`decoction

decoction?: DecoctionPullInput

A decoction pull. The worked example's recipe doesn't have a decoction mash.

`Optional` `Readonly`equipment

equipment?: Partial<EquipmentProfile>

The equipment the recipe is calculated on. Defaults apply when it's left out.

`Optional` `Readonly`forcedCarbonation

forcedCarbonation?: { targetVolumes: number; tempC: number }

A regulator setting to reach the same carbonation without sugar.

Type Declaration

ReadonlytargetVolumes: number

Carbonation to reach, in volumes of CO₂.
ReadonlytempC: number

Temperature of the beer, in °C.

`Optional` `Readonly`hopStorage

hopStorage?: { alphaAcidPercent: number; storage: HopStorage }

A hop that has been in the freezer a while.

Type Declaration

ReadonlyalphaAcidPercent: number

The hop's alpha acid before storage, in percent.
Readonlystorage: HopStorage

How and how long the hop has been stored.

`Optional` `Readonly`hotVolume

hotVolume?: { measuredAtC: number; volumeL: number }

A kettle volume read hot off the sight glass.

Type Declaration

ReadonlymeasuredAtC: number

Temperature of the wort when it was read, in °C.
ReadonlyvolumeL: number

The volume read hot, in liters.

`Optional` `Readonly`hydrometer

hydrometer?: { measuredGravity: number; sampleTempC: number }

A hydrometer reading taken warm.

Type Declaration

ReadonlymeasuredGravity: number

The gravity read off the hydrometer, as specific gravity.
ReadonlysampleTempC: number

Temperature of the sample, in °C.

`Optional` `Readonly`mixing

mixing?: readonly SpiritMixComponent[]

Spirits mixed by strength, with the contraction counted.

`Optional` `Readonly`nutrients

nutrients?: NutrientScheduleInput

A staggered nutrient schedule for the mead.

`Optional` `Readonly`options

options?: CalculationOptions

Calculation options for the recipe. These pick the formulas the base run uses.

`Optional` `Readonly`pearson

pearson?: PearsonSquareInput

A Pearson square blend of two components to a target.

`Optional` `Readonly`pitch

pitch?: PitchPlanInput

The pitch.

`Optional` `Readonly`priming

priming?: PrimingInput

The packaging dose.

`Optional` `Readonly`proofAndSweeten

proofAndSweeten?: ProofAndSweetenInput

A jar of macerate proofed down and sweetened. It's the only drink in the reference that isn't fermented.

`Readonly`recipe

recipe: RecipeInput

The recipe the worked example is about.

`Optional` `Readonly`refractometer

refractometer?: {
    finalMeasuredBrix: number;
    originalMeasuredBrix: number;
    wortCorrectionFactor?: number;
}

A refractometer reading before the boil and another at the end of fermentation.

Type Declaration

ReadonlyfinalMeasuredBrix: number

Reading at the end of fermentation, in °Brix as the refractometer shows it.
ReadonlyoriginalMeasuredBrix: number

Reading before fermentation, in °Brix as the refractometer shows it.
Optional ReadonlywortCorrectionFactor?: number

Wort correction factor the readings are divided by. Uses the package default when left out.

`Optional` `Readonly`sorbate

sorbate?: SorbateDoseInput

A sorbate dose.

`Optional` `Readonly`starter

starter?: {
    availableCellsBillion: number;
    options?: StarterPlanOptions;
    targetCellsBillion: number;
}

The starter, if the pitch needs one.

Type Declaration

ReadonlyavailableCellsBillion: number

Cells on hand before the starter, in billions.
Optional Readonlyoptions?: StarterPlanOptions

Starter planning options. Defaults apply when left out.
ReadonlytargetCellsBillion: number

Cells the pitch needs, in billions.

`Optional` `Readonly`sugarToGravity

sugarToGravity?: SugarToGravityInput

The six cellar calculations, which are about a mead instead of the worked example's beer. They're independent of each other, so an example can have a sulfite dose without a nutrient schedule and still get the sulfite explanation.

`Optional` `Readonly`sulfite

sulfite?: SulfiteDoseInput

A sulfite dose.

`Optional` `Readonly`waterSolver

waterSolver?: WaterSolverInput

A salt solve against a target profile.

Interface ReferenceExample

Index

Properties

Properties

Optional ReadonlyabvFormulas

Optional Readonlyacid

Optional ReadonlybitternessFormulas

Optional Readonlyblend

Optional ReadonlycolorFormulas

Optional Readonlydecoction

Optional Readonlyequipment

Optional ReadonlyforcedCarbonation

Type Declaration

ReadonlytargetVolumes: number

ReadonlytempC: number

Optional ReadonlyhopStorage

Type Declaration

ReadonlyalphaAcidPercent: number

Readonlystorage: HopStorage

Optional ReadonlyhotVolume

Type Declaration

ReadonlymeasuredAtC: number

ReadonlyvolumeL: number

Optional Readonlyhydrometer

Type Declaration

ReadonlymeasuredGravity: number

ReadonlysampleTempC: number

Optional Readonlymixing

Optional Readonlynutrients

Optional Readonlyoptions

Optional Readonlypearson

Optional Readonlypitch

Optional Readonlypriming

Optional ReadonlyproofAndSweeten

Readonlyrecipe

Optional Readonlyrefractometer

Type Declaration

ReadonlyfinalMeasuredBrix: number

ReadonlyoriginalMeasuredBrix: number

Optional ReadonlywortCorrectionFactor?: number

Optional Readonlysorbate

Optional Readonlystarter

Type Declaration

ReadonlyavailableCellsBillion: number

Optional Readonlyoptions?: StarterPlanOptions

ReadonlytargetCellsBillion: number

Optional ReadonlysugarToGravity

Optional Readonlysulfite

Optional ReadonlywaterSolver

Settings

On This Page

`Optional` `Readonly`abvFormulas

`Optional` `Readonly`acid

`Optional` `Readonly`bitternessFormulas

`Optional` `Readonly`blend

`Optional` `Readonly`colorFormulas

`Optional` `Readonly`decoction

`Optional` `Readonly`equipment

`Optional` `Readonly`forcedCarbonation

`Readonly`targetVolumes: number

`Readonly`tempC: number

`Optional` `Readonly`hopStorage

`Readonly`alphaAcidPercent: number

`Readonly`storage: HopStorage

`Optional` `Readonly`hotVolume

`Readonly`measuredAtC: number

`Readonly`volumeL: number

`Optional` `Readonly`hydrometer

`Readonly`measuredGravity: number

`Readonly`sampleTempC: number

`Optional` `Readonly`mixing

`Optional` `Readonly`nutrients

`Optional` `Readonly`options

`Optional` `Readonly`pearson

`Optional` `Readonly`pitch

`Optional` `Readonly`priming

`Optional` `Readonly`proofAndSweeten

`Readonly`recipe

`Optional` `Readonly`refractometer

`Readonly`finalMeasuredBrix: number

`Readonly`originalMeasuredBrix: number

`Optional` `Readonly`wortCorrectionFactor?: number

`Optional` `Readonly`sorbate

`Optional` `Readonly`starter

`Readonly`availableCellsBillion: number

`Optional` `Readonly`options?: StarterPlanOptions

`Readonly`targetCellsBillion: number

`Optional` `Readonly`sugarToGravity

`Optional` `Readonly`sulfite

`Optional` `Readonly`waterSolver