⚠️ This is pre-release documentation for v3. For stable docs, visit v2.
@tmlmt/cooklang-parser

Appearance

@tmlmt/cooklang-parser / Metadata

Interface: Metadata ​

Represents the metadata of a recipe.

Indexable ​

[key: string]: MetadataValue

Index signature for additional metadata fields not explicitly typed. Any metadata key in the frontmatter will be captured here.

Properties ​

author? ​

optional author?: string

The author of the recipe (separate from source author).

category? ​

optional category?: string

The category of the recipe.

course? ​

optional course?: string

The course of the recipe.

cuisine? ​

optional cuisine?: string

The cuisine of the recipe.

description? ​

optional description?: string

The description of the recipe.

diet? ​

optional diet?: string

The diet of the recipe.

difficulty? ​

optional difficulty?: string

The difficulty of the recipe.

image? ​

optional image?: string

The primary image of the recipe.

images? ​

optional images?: string[]

The images of the recipe.

introduction? ​

optional introduction?: string

The introduction of the recipe.

locale? ​

optional locale?: string

The locale of the recipe.

serves? ​

optional serves?: string | number

The number of people the recipe serves. Stored as a number when the value is numeric, or as a string when non-numeric (e.g. serves: two). Non-numeric values default the internal scaling baseline to 1.

Interchangeable with servings or yield for the purpose of setting Recipe.servings. If multiple ones are defined, the prevalence order is servings > serves > yield.

Example ​

yaml
serves: 4

servings? ​

optional servings?: string | number

The number of servings the recipe makes. Stored as a number when the value is numeric, or as a string when non-numeric (e.g. servings: two). Non-numeric values default the internal scaling baseline to 1.

Interchangeable with yield or serves for the purpose of setting Recipe.servings. If multiple ones are defined, the prevalence order is servings > serves > yield.

Example ​

yaml
servings: 4

source? ​

optional source?: string | MetadataSource

The source of the recipe. Can be a simple URL string or structured attribution. When parsed from YAML, source.name, source.url, source.author keys are merged here.

tags? ​

optional tags?: string[]

The tags of the recipe.

time? ​

optional time?: MetadataTime

Time information for the recipe. When parsed from YAML, prep time, time.prep, cook time, time.cook, time required, time, duration keys are merged here.

title? ​

optional title?: string

The title of the recipe.

unitSystem? ​

optional unitSystem?: string

The unit system used in the recipe for ambiguous units like tsp, tbsp, cup. See Unit Conversion Guide for more information. This stores the original value as written by the user.

variants? ​

optional variants?: string[]

The list of available variant names for this recipe.

yield? ​

optional yield?: Yield

The yield of the recipe. Can be given as:

  • a plain quantity with optional unit: yield: 300%g or yield: 2
  • a complex format with and optional surrounding text: yield: about NaN of bread

Interchangeable with servings or serves for the purpose of setting Recipe.servings. If multiple ones are defined, the prevalence order is servings > serves > yield.

Examples ​

yaml
yield: 300%g
yaml
yield: about {{300%g}} of bread