Code Monkey home page Code Monkey logo

length.js's Introduction

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

length.js's People

Watchers

James Cloos avatar Benjamin Robson avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.