culinary-unit-abbreviation
TypeScript icon, indicating that this package has built-in type declarations

1.0.2 • Public • Published

culinary-unit-abbreviation

A npm library that converts various culinary units or terms to their respective abbreviations, in TypeScript & JavaScript.

published npm version codecov npm monthly downloads type definitions license

Features

  • Convert common & niche culinary units for Height, Length, Depth, Weight, Volume, Capacity, Size, and Spoons to matching abbreviations.
  • Parses and converts the plural form of the unit to its respective abbreviation if it exists in our data.
  • Passing capitalized unit returns its respective abbreviation also capitalized (in multi-worded strings, only if the first word was capitalized).
  • Handles international & American spelling of units like (non-exclusive):
    • centimetre & centimeter
    • litre & liter
  • Returns a verbose string when no match exists in our data (or in multi-worded strings, if at least one word lacks a match). i.e. input: 'yellow' returns: No abbreviation found for yellow.

Prerequisites

You need npm installed.

$ npm install npm@latest -g

Installing

Using npm:

$ npm install culinary-unit-abbreviation

Example

import abbr from 'culinary-unit-abbreviation'; // as ES module

// Convert the unit 'tablespoons' to 'tbsps'
abbr('tablespoons');

// Convert the unit 'large clove' to 'lg cl'
abbr('large clove');

// Convert the unit 'fluid ounces' to 'fl oz'
abbr('fluid ounces');
const abbr = require('culinary-unit-abbreviation'); // as CommonJS script

// Convert the unit 'half dozen' to '½ doz'
abbr('half dozen');

// Convert the unit 'Millilitre' to 'mL'
abbr('Millilitre');

// Convert the unit 'Pounds' to 'Lbs'
abbr('Pounds');

Supported conversions

Generic/Subjective

  • bottle(s)
  • bunch(es)
  • bushel(s)
  • can(s)
  • clove(s)
  • dash(es)
  • dozen(s)
  • drop(s)
  • each
  • filet(s)
  • handful(s)
  • head(s)
  • loaf/loaves
  • package(s)
  • packet(s)
  • peck(s)
  • piece(s)
  • pinch(es)
  • serving(s)
  • sheet(s)
  • slice(s)
  • sprig(s)
  • stalk(s)
  • stick(s)
  • strip(s)

Size

  • large
  • medium
  • small

Common Fractions

  • half
  • quarter
  • third

Height/Length/Depth

  • centimeter(s)/centimetre(s)
  • inch(es)
  • millimeter(s)/millimetre(s)

Weight

  • gram(s)
  • kilogram(s)
  • microgram(s)
  • milligram(s)
  • ounce(s)
  • pound(s)

Volume/Capacity

  • centiliter(s)/centilitre(s)
  • cup(s)
  • fluid ounce(s)
  • gallon(s)
  • liter(s)/litre(s)
  • milliliter(s)/millilitre(s)
  • pint(s)
  • quart(s)

Spoon Size

  • dessertspoon(s)
  • tablespoon(s)
  • teaspoon(s)

Request An Abbreviation

Want to see another unit or measurement term and it's abbreviation? Think another abbreviation should replace another? Submit an Issue with the term, abbreviation, and an example of the term/abbreviation as it is used in culinary arts.

Aknowledgments

Dimitar Dimitrov - unit-abbreviation - library structure & README boilerplate inspiration Basarat Ali Syed - "That TypeScript Guy" - TypeScript for Professionals - 2023 Edition Udemy course

License

MIT

Package Sidebar

Install

npm i culinary-unit-abbreviation

Weekly Downloads

2

Version

1.0.2

License

MIT

Unpacked Size

44.4 kB

Total Files

17

Last publish

Collaborators

  • uncle_baby_kern