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

@tmlmt/cooklang-parser / Yield

Interface: Yield

Represents a yield metadata value for a recipe. Supports plain quantities (e.g. yield: 300%g), complex format with surrounding text (e.g. yield: about NaN of bread), or simple numbers (e.g. yield: 2).

Extends

Properties

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


textAfter?

optional textAfter?: string

The text after the scaling variable (complex format).


textBefore?

optional textBefore?: string

The text before the scaling variable (complex format).


unit?

optional unit?: string

Inherited from

QuantityWithPlainUnit.unit