Class Parser

Hierarchy

Parser

Index

Constructors

constructor

Properties

Methods

parse

Constructors

constructor

new Parser(options?: ParserOptions): Parser

- Defined in Parser.ts:35
Creates a new parser with the supplied options

Parameters
- Optional options: ParserOptions
  
  The parser's options
Returns Parser

Properties

defaultCookwareAmount

defaultCookwareAmount: string | number

defaultIngredientAmount

defaultIngredientAmount: string | number

defaultUnits

defaultUnits: string = ''

includeStepNumber

includeStepNumber: boolean

Methods

parse

parse(source: string): ParseResult

- Defined in Parser.ts:49
Parses a Cooklang string and returns any metadata, steps, or shopping lists

see
Cooklang Recipe

Parameters
- source: string
  
  A Cooklang recipe
Returns ParseResult
The extracted ingredients, cookwares, metadata, steps, and shopping lists

Generated using TypeDoc