⚠️ 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.

Properties ​

author? ​

optional author: string

The author of the recipe.

category? ​

optional category: string

The category of the recipe.

cook time? ​

optional cook time: string

The cooking time of the recipe. Will not be further parsed into any DateTime format nor normalize

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.

duration? ​

optional duration: string

image? ​

optional image: string

The picture of the recipe. Alias of picture

images? ​

optional images: string[]

The images of the recipe. Alias of pictures

introduction? ​

optional introduction: string

The introduction of the recipe.

locale? ​

optional locale: string

The locale of the recipe.

picture? ​

optional picture: string

The picture of the recipe. Alias of image

pictures? ​

optional pictures: string[]

The images of the recipe. Alias of images

prep time? ​

optional prep time: string

The preparation time of the recipe. Will not be further parsed into any DateTime format nor normalize

serves? ​

optional serves: string | number

The number of people the recipe serves. Should be either a number or a string which starts with a number (which will be used for scaling) followed by a comma and then whatever you want.

Interchangeable with servings or yield. If multiple ones are defined, the prevailance order for the number which will used for scaling is servings > yield > serves. See servings for examples.

servings? ​

optional servings: string | number

The number of servings the recipe makes. Should be either a number or a string which starts with a number (which will be used for scaling) followed by a comma and then whatever you want.

Interchangeable with yield or serves. If multiple ones are defined, the prevailance order for the number which will used for scaling is servings > yield > serves.

Examples ​

yaml
servings: 4
yaml
servings: 2, a few

source? ​

optional source: string

The source of the recipe.

source.author? ​

optional source.author: string

The source author of the recipe.

source.name? ​

optional source.name: string

The source name of the recipe.

source.url? ​

optional source.url: string

The source url of the recipe.

tags? ​

optional tags: string[]

The tags of the recipe.

time? ​

optional time: string

time required? ​

optional time required: string

The total time of the recipe. Will not be further parsed into any DateTime format nor normalize

time.cook? ​

optional time.cook: string

Alias of cook time

time.prep? ​

optional time.prep: string

Alias of prep time

title? ​

optional title: string

The title of the recipe.

yield? ​

optional yield: string | number

The yield of the recipe. Should be either a number or a string which starts with a number (which will be used for scaling) followed by a comma and then whatever you want.

Interchangeable with servings or serves. If multiple ones are defined, the prevailance order for the number which will used for scaling is servings > yield > serves. See servings for examples.