Git Product home page Git Product logo

spiffy-round's Introduction

Spiffy Round logo

Tests MIT License version downloads semantic-release

What

Spiffy/smart rounding for numbers. Returns string (so you can have a consistent number of decimal places).

Why

Consistent, user friendly friendly formatted numbers. See examples below.

API

spiffyRound(value[, decimal places])

value

Type: Number/String

decimal places

Type: Number

Default: 0

Description: Number of desired decimal places (only applies if decimals are not all 0's)

Installation

npm install --save spiffy-round

Usage

const spiffyRound = require("spiffy-round");

// value type Number
spiffyRound(1.2); // '1'
spiffyRound(1.2, 1); // '1.2'
spiffyRound(1.2, 2); // '1.20'
spiffyRound(1.256, 2); // '1.26'
spiffyRound(1, 2); // '1'
spiffyRound(0.0, 2); // '0'
spiffyRound(1.0, 2); // '1'
spiffyRound(-1.0, 2); // '-1'
spiffyRound(+0); // '0'
spiffyRound(-0); // '0'
spiffyRound(+1.006, 2); // '1.01'
spiffyRound(-1.006, 2); // '-1.01'

// value type String
spiffyRound("1.2"); // '1'
spiffyRound("1.2", 1); // '1.2'
spiffyRound("1.2", 2); // '1.20'
spiffyRound("1.256", 2); // '1.26'
spiffyRound("1", 2); // '1'
spiffyRound("0.000", 2); // '0'
spiffyRound("1.00", 2); // '1'
spiffyRound("-1.00", 2); // '-1'
spiffyRound("+0"); // '0'
spiffyRound("-0"); // '0'
spiffyRound("+1.006", 2); // '1.01'
spiffyRound("-1.006", 2); // '-1.01'

ToDo

  • handle exponents
  • handle alternate decimal separator ','

Contributing

Contributions are welcomed. How to make a contribution:

  • Create an issue on Github
  • Fork project
  • Make changes then use npm run commit to commit
  • Create a pull request

spiffy-round's People

Contributors

dependabot[bot] avatar lukeaus avatar

Stargazers

 avatar

Watchers

 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.