⚠️ This is pre-release documentation for v3. For stable docs, visit v2.
Skip to content

@tmlmt/cooklang-parser / IngredientQuantityGroup

Interface: IngredientQuantityGroup ​

Represents a group of summed quantities for an ingredient, optionally with alternatives. Quantities with the same alternative signature are summed together into a single group. When units are incompatible, separate IngredientQuantityGroup entries are created instead of merging.

Extends ​

Properties ​

alternatives? ​

optional alternatives?: AlternativeIngredientRef[][]

References to alternative ingredients for this quantity group. Each inner array represents one alternative choice option (subgroup). Items within the same inner array are combined with "+" (AND), while different inner arrays represent "or" alternatives. If undefined, this group has no alternatives.


equivalents? ​

optional equivalents?: QuantityWithPlainUnit[]

Optional equivalent quantities in different units (for alternative units like @flour{100%g|3.5%oz})

Inherited from ​

QuantityWithPlainUnit.equivalents


quantity ​

quantity: FixedValue | Range

Inherited from ​

QuantityWithPlainUnit.quantity


unit? ​

optional unit?: string

Inherited from ​

QuantityWithPlainUnit.unit