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

@tmlmt/cooklang-parser / ShoppingListRecipeRef

Interface: ShoppingListRecipeRef

Represents a recipe reference parsed from a .shopping-list file. Returned by ShoppingList.loadFile so the consuming app knows which .cook files to load before calling ShoppingList.hydrateRecipe.

Properties

path

path: string

Relative path as written in the file (e.g. "./Complex Recipe")


servings?

optional servings?: number

Servings multiplier. undefined if not specified in the file.