An open API service indexing awesome lists of open source software.

https://github.com/drag13/roundto

Small function that rounds number with selected precision
https://github.com/drag13/roundto

javscript math round rounding

Last synced: about 1 year ago
JSON representation

Small function that rounds number with selected precision

Awesome Lists containing this project

README

          

# RoundTo

[![codecov](https://codecov.io/gh/Drag13/RoundTo/branch/master/graph/badge.svg)](https://codecov.io/gh/Drag13/RoundTo)
[![Build Status](https://travis-ci.org/Drag13/RoundTo.svg?branch=master)](https://travis-ci.org/Drag13/RoundTo)
[![npm](https://img.shields.io/npm/dt/@drag13/round-to.svg)](https://www.npmjs.com/package/@drag13/round-to)
[![TypeSCript](https://img.shields.io/badge/TypeScript-Ready-brightgreen.svg)](https://github.com/Drag13/RoundTo)
[![GitHub license](https://img.shields.io/github/license/Drag13/RoundTo.svg)](https://github.com/Drag13/RoundTo/blob/master/LICENSE)

## Description

Small one-function-lib to round numbers with custom precision. TypeScript ready.

## Installation

`npm install @drag13/round-to`

## Usage

RoundTo function rounds your decimal with selected precesion. It also tries to handle edge cases with floating point using Epsilon shift and nano-robots.

``` javascript
const round = require('@drag13/round-to');
const roundingResult = round(5.4399, 2);
console.assert(roundingResult===5.44);
```

## TypeScript

Feel free to use it with TypeScript

``` typescript
import * as round from '@drag13/round-to';
const roundingResult = round(5.4399, 2);
console.assert(roundingResult===5.44);
```

## Tests

`npm test`

## Some covered cases

```javascript
console.assert(roundTo(0.43499999999999994, 2)===0.435);
console.assert(roundTo(Math.PI, 2)===3.14);
```

## Contributing

Any bug fixing is appreciated. If you want to add new functionality - you're welcome. But KISS it please.