@recipe-book/core
v0.6.0
Published
Framework-agnostic recipe parsing, scaling, unit conversion and formatting.
Readme
@recipe-book/core
Parse, validate, scale, convert, and format recipes. Core has no runtime dependencies and doesn't use React, so it works in scripts, on servers, in browsers, and in React Server Components. To render recipes with unstyled React components, install @recipe-book/react instead. It includes core, and Packages lists the paths to import core through it.
- Read regional recipes with the parsers'
decimalandunitsoptions. - Show the size of a can, a package, or another count unit in the reader's measurement system with the
systemoption offormatIngredient. - Find the mass and volume quantities in step text, such as
200 gand1 ½ cups, withsegmentStepQuantities, so a page can show them in the reader's measurement system. - Write units, durations, temperatures, and sizes in another language with the label packs in
@recipe-book/core/labels.
Install
npm i @recipe-book/coreUsage
Parse recipe input with parseRecipe. Then resolve the parsed recipe to a number of servings and a measurement system with resolveRecipe, and format each ingredient as a line with formatIngredient.
import { formatIngredient, parseRecipe, resolveRecipe } from '@recipe-book/core'
const result = parseRecipe({
name: 'Buttermilk pancakes',
servings: 4,
ingredients: [
{ name: 'all-purpose flour', quantity: '1 ½ cups', equivalents: ['190 g'] },
{ name: 'buttermilk', quantity: '1 ¼ cups' },
{ name: 'egg', plural: 'eggs', quantity: 2 },
],
steps: [
'Whisk the flour, buttermilk, and eggs.',
'Cook ¼-cup portions on a buttered griddle, 2–3 minutes per side.',
],
})
if (!result.success) throw result.error
const recipe = resolveRecipe(result.data, { servings: 8, system: 'metric' })
for (const section of recipe.ingredients) {
for (const item of section.items) {
console.log(formatIngredient(item).text)
}
}It prints:
380 g all-purpose flour
591 mL buttermilk
4 eggsResolve a recipe for display explains where each quantity comes from.
