Skip to content

๐Ÿ“ JavaScript library for length units conversion.

License

Notifications You must be signed in to change notification settings

benjaminhr/length.js

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

14 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

Length.js

JavaScript library for length units conversion




Installation

Length was designed to work both in the browser and in Node.js.

Browser

<script src="length.js"></script>

Length is available on unpgk CDN in compressed and uncompressed version.

Node.js

npm install length.js
var length = require('length.js');
// or using ES6 import
import length from 'length.js';

Usage

Length creates an object which contains value, unit, and conversion methods.
To get this object, simply call length() with two supported arguments. Then you can convert passed value by calling one of available method.

The Length prototype is exposed through length.fn (if you want to add your own functions).


length(value, unit)

Creates an object which contains value, unit, and conversion methods.

Arguments

  • value (Number): Number of units.

  • unit (String): Unit type.

    Available unit types:

    • cm: centimeter,
    • m: meter,
    • ft: foot.

Returns

  • (Object): Returns new Length object.

Example

length(12, 'cm');

Methods

.toMeter()

Returns

  • (Number): Value converted to meters.

Example

length(100, 'cm').toMeter();
// => 1

.toCentimeter()

Returns

  • (Number): Value converted to centimeters.

Example

length(1, 'm').toCentimeter();
// => 100

.toFoot()

Returns

  • (Number): Value converted to foots.

Example

length(1, 'm').toFoot();
// =>  3.280839895013

About

๐Ÿ“ JavaScript library for length units conversion.

Resources

License

Stars

Watchers

Forks

Packages

No packages published