@tmlmt/cooklang-parser / formatItemQuantity

Function: formatItemQuantity()

formatItemQuantity(itemQuantity, separator?): string

Format an IngredientItemQuantity with all its equivalents to a string.

Parameters

itemQuantity

MaybeScalableQuantity

The ingredient item quantity to format

separator?

string = " | "

The separator between primary and equivalent quantities (default: " | ")

Returns

string

The formatted string with all quantities

Example

// For an ingredient like @flour{100%g|3.5%oz}
formatItemQuantity(itemQuantity); // "100 g | 3.5 oz"
formatItemQuantity(itemQuantity, " / "); // "100 g / 3.5 oz"