mathjs/docs/reference/functions/unit.md

layout
default

Function unit #

Create a unit. Depending on the passed arguments, the function will create and return a new math.type.Unit object. When a matrix is provided, all elements will be converted to units.

Syntax #

math.unit(unit : string)
math.unit(value : number, unit : string)

Parameters #

Parameter	Type	Description
args	* | Array | Matrix	A number and unit.

Returns #

Type	Description
Unit | Array | Matrix	The created unit

Examples #

var a = math.unit(5, 'cm');    // returns Unit 50 mm
var b = math.unit('23 kg');    // returns Unit 23 kg
a.to('m');                     // returns Unit 0.05 m

See also #

bignumber, boolean, complex, index, matrix, number, string, createUnit