Skip to content

Units Functions

Unit conversion functions.

Summary

Function Signature Description
convert_length number, string, string -> number Convert a length value between meters, kilometers, miles, feet, inches, centimeters, millimeters, yards, and nautical miles
convert_mass number, string, string -> number Convert a mass value between kilograms, grams, milligrams, pounds, ounces, tonnes, and stones
convert_temperature number, string, string -> number Convert a temperature value between Celsius, Fahrenheit, and Kelvin
convert_volume number, string, string -> number Convert a volume value between liters, milliliters, gallons, quarts, pints, cups, fluid ounces, tablespoons, and teaspoons

Functions

convert_length

Convert a length value between meters, kilometers, miles, feet, inches, centimeters, millimeters, yards, and nautical miles

Signature: number, string, string -> number

Examples:

# Kilometers to miles
convert_length(`1`, 'km', 'mi') -> 0.621371
# Feet to meters
convert_length(`1`, 'ft', 'm') -> 0.3048
# Inches to centimeters
convert_length(`1`, 'in', 'cm') -> 2.54

convert_mass

Convert a mass value between kilograms, grams, milligrams, pounds, ounces, tonnes, and stones

Signature: number, string, string -> number

Examples:

# Kilograms to pounds
convert_mass(`1`, 'kg', 'lbs') -> 2.20462
# Pounds to kilograms
convert_mass(`1`, 'lbs', 'kg') -> 0.453592
# Tonnes to kilograms
convert_mass(`1`, 't', 'kg') -> 1000

convert_temperature

Convert a temperature value between Celsius, Fahrenheit, and Kelvin

Signature: number, string, string -> number

Examples:

# Boiling point of water in Fahrenheit
convert_temperature(`100`, 'C', 'F') -> 212
# Freezing point in Celsius
convert_temperature(`32`, 'F', 'C') -> 0
# Celsius to Kelvin
convert_temperature(`0`, 'C', 'K') -> 273.15

convert_volume

Convert a volume value between liters, milliliters, gallons, quarts, pints, cups, fluid ounces, tablespoons, and teaspoons

Signature: number, string, string -> number

Examples:

# Gallons to liters
convert_volume(`1`, 'gal', 'l') -> 3.78541
# Liters to milliliters
convert_volume(`1`, 'l', 'ml') -> 1000
# Cups to milliliters
convert_volume(`1`, 'cup', 'ml') -> 236.588