@cooklang/cooklang-ts

Index

Classes

Interfaces

Type aliases

Functions

getImageURL

Type aliases

Metadata

Metadata: Record<string, string>

A recipes metadata

see: Cooklang Metadata

ShoppingList

ShoppingList: Record<string, Item[]>

A shopping list consisting of categories and their items

see: Cooklang Shopping List

Step

Step: (Ingredient | Cookware | Timer | Text)[]

A step consisting of multiple ingredients, cookware, timers, and text

Functions

getImageURL

getImageURL(name: string, options?: ImageURLOptions): string

- Defined in index.ts:21
Creates a URL for an image of the the supplied recipe.
example
```
getImageURL('Baked Potato', { extension: 'jpg', step: 2 });
// returns "Baked Potato.2.jpg"
```
see
Cooklang Pictures Specification
Parameters
- name: string
  
  Name of the .cook file.
- Optional options: ImageURLOptions
  
  The URL options.
Returns string
The image URL for the givin recipe and step.

Generated using TypeDoc