
Security News
ECMAScript 2025 Finalized with Iterator Helpers, Set Methods, RegExp.escape, and More
ECMAScript 2025 introduces Iterator Helpers, Set methods, JSON modules, and more in its latest spec update approved by Ecma in June 2025.
parse-ingredient
Advanced tools
Recipe ingredient parser with support for mixed numbers and vulgar fractions
Parses a string, which can include mixed numbers or vulgar fractions (thanks to numeric-quantity), into an array of recipe ingredient objects.
Ingredient objects have the following signature:
interface Ingredient {
/**
* The primary quantity (the lower quantity in a range, if applicable)
*/
quantity: number | null;
/**
* The secondary quantity (the upper quantity in a range, or `null` if not applicable)
*/
quantity2: number | null;
/**
* The unit of measure identifier (see `unitsOfMeasure`)
*/
unitOfMeasureID: string | null;
/**
* The unit of measure
*/
unitOfMeasure: string | null;
/**
* The description
*/
description: string;
/**
* Whether the "ingredient" is actually a group header, e.g. "For icing:"
*/
isGroupHeader: boolean;
}
For the isGroupHeader
attribute to be true
, the ingredient string must not start with a number, and must either start with 'For '
or end with ':'
.
If present (i.e., not null
), the unitOfMeasureID
property corresponds to a key from the exported unitsOfMeasure
object which defines short, plural, and other alternate versions of known units of measure. To extend the list of units, use the additionalUOMs
option and/or or submit a pull request to add new units to this library's default list.
For a complimentary library that handles the inverse operation, displaying numeric values as imperial measurements (e.g.
'1 1/2'
instead of1.5
), see format-quantity.
npm i parse-ingredient
# OR yarn add / pnpm add / bun add
In the browser, all exports including the parseIngredient
function are available on the global object ParseIngredient
.
<script src="https://unpkg.com/parse-ingredient"></script>
<script>
ParseIngredient.parseIngredient('1 1/2 cups sugar');
// [
// {
// quantity: 1.5,
// quantity2: null,
// unitOfMeasure: 'cups',
// unitOfMeasureID: 'cup',
// description: 'sugar',
// isGroupHeader: false,
// }
// ]
</script>
import { parseIngredient } from 'parse-ingredient';
parseIngredient('1-2 pears');
// [
// {
// quantity: 1,
// quantity2: 2,
// unitOfMeasure: null,
// unitOfMeasureID: null,
// description: 'pears',
// isGroupHeader: false,
// }
// ]
parseIngredient(
`2/3 cup flour
1 tsp baking powder`
);
// [
// {
// quantity: 0.667,
// quantity2: null,
// unitOfMeasure: 'cup',
// unitOfMeasureID: 'cup',
// description: 'flour',
// isGroupHeader: false,
// },
// {
// quantity: 1,
// quantity2: null,
// unitOfMeasure: 'tsp',
// unitOfMeasureID: 'teaspoon',
// description: 'baking powder',
// isGroupHeader: false,
// },
// ]
parseIngredient('For cake:');
// [
// {
// quantity: null,
// quantity2: null,
// unitOfMeasure: null,
// unitOfMeasureID: null,
// description: 'For cake:',
// isGroupHeader: true,
// }
// ]
parseIngredient('Ripe tomato x2');
// [
// {
// quantity: 2,
// quantity2: null,
// unitOfMeasure: null,
// unitOfMeasureID: null,
// description: 'Ripe tomato',
// isGroupHeader: false,
// }
// ]
normalizeUOM
Pass true
to convert units of measure to their long, singular form, e.g. "ml" becomes "milliliter" and "cups" becomes "cup". This can help normalize the units of measure for processing. In most cases, this option will make unitOfMeasure
equivalent to unitOfMeasureID
.
parseIngredient('1 c sugar', { normalizeUOM: true });
// [
// {
// quantity: 1,
// quantity2: null,
// unitOfMeasure: 'cup',
// unitOfMeasureID: 'cup',
// description: 'sugar',
// isGroupHeader: false,
// }
// ]
additionalUOMs
Pass an object that matches the format of the exported unitsOfMeasure
object. Keys that match any in the exported object will be used instead of the default, and any others will be added to the list of known units of measure when parsing ingredients.
parseIngredient('2 buckets of widgets', {
additionalUOMs: {
bucket: {
short: 'bkt',
plural: 'buckets',
versions: ['bk'],
},
},
});
// [
// {
// quantity: 2,
// quantity2: null,
// unitOfMeasureID: 'bucket',
// unitOfMeasure: 'buckets',
// description: 'widgets',
// isGroupHeader: false,
// },
// ]
allowLeadingOf
When true
, ingredient descriptions that start with "of " will not be modified. (By default, a leading "of " will be removed from all descriptions.)
parseIngredient('1 cup of sugar', { allowLeadingOf: true });
// [
// {
// quantity: 1,
// quantity2: null,
// unitOfMeasure: 'cup',
// unitOfMeasureID: 'cup',
// description: 'of sugar',
// isGroupHeader: false,
// }
// ]
ignoreUOMs
An array of strings to ignore as units of measure when parsing ingredients.
parseIngredient('2 large eggs', { ignoreUOMs: ['large'] });
// [
// {
// quantity: 2,
// quantity2: null,
// unitOfMeasure: null,
// unitOfMeasureID: null,
// description: 'large eggs',
// isGroupHeader: false,
// }
// ]
Thanks goes to these wonderful people (emoji key):
Jake Boone 💻 📖 💡 🚧 ⚠️ | Stefan van der Weide 💻 ⚠️ | Roger 💻 | Tyler 💻 ⚠️ |
This project follows the all-contributors specification. Contributions of any kind welcome!
[v1.3.0] - 2025-05-06
FAQs
Recipe ingredient parser with support for mixed numbers and vulgar fractions
We found that parse-ingredient demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
ECMAScript 2025 introduces Iterator Helpers, Set methods, JSON modules, and more in its latest spec update approved by Ecma in June 2025.
Security News
A new Node.js homepage button linking to paid support for EOL versions has sparked a heated discussion among contributors and the wider community.
Research
North Korean threat actors linked to the Contagious Interview campaign return with 35 new malicious npm packages using a stealthy multi-stage malware loader.