# @pelevesque/wrap-number

> Wraps a number inside a range.

Latest version **0.0.5** (published 2020-02-04) · MIT license · 0 weekly downloads

## Install

```sh
npm install @pelevesque/wrap-number
pnpm add @pelevesque/wrap-number
yarn add @pelevesque/wrap-number
bun add @pelevesque/wrap-number
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.5 |
| Published | 2020-02-04 |
| First published | 2018-08-01 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=9.0.0 |
| Dependencies | 0 |
| Unpacked size | 4.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Pierre-Emmanuel Lévesque |
| Maintainers | pelevesque |
| Keywords | math, number, wrap, range, modulo |

## Links

- npm: https://www.npmjs.com/package/@pelevesque/wrap-number
- Repository: https://github.com/pelevesque/wrap-number
- Homepage: https://github.com/pelevesque/wrap-number#readme
- Issues: https://github.com/pelevesque/wrap-number/issues
- npm.io page: https://npm.io/package/@pelevesque/wrap-number

## Alternatives

- [random-seedable](https://npm.io/package/random-seedable.md) — 27.9K weekly downloads
- [n2words](https://npm.io/package/n2words.md) — 22.2K weekly downloads
- [@stdlib/math-base-special-factorialln](https://npm.io/package/@stdlib/math-base-special-factorialln.md) — 5.7K weekly downloads
- [@stdlib/math-base-special-abs2](https://npm.io/package/@stdlib/math-base-special-abs2.md) — 1.7K weekly downloads
- [commons-math-interpolation](https://npm.io/package/commons-math-interpolation.md) — 1.4K weekly downloads

## Recent versions

- 0.0.5 (latest) — 2020-02-04
- 0.0.4 — 2020-02-04
- 0.0.3 — 2019-06-16
- 0.0.2 — 2019-05-29
- 0.0.1 — 2018-08-01

## README

[![Build Status](https://travis-ci.org/pelevesque/wrap-number.svg?branch=master)](https://travis-ci.org/pelevesque/wrap-number)
[![Coverage Status](https://coveralls.io/repos/github/pelevesque/wrap-number/badge.svg?branch=master)](https://coveralls.io/github/pelevesque/wrap-number?branch=master)
[![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)

# wrap-number

Wraps a number inside a range.

## Node Repository

https://www.npmjs.com/package/@pelevesque/wrap-number

## Installation

`npm install @pelevesque/wrap-number`

## Tests

Command                      | Description
---------------------------- | ------------
`npm test` or `npm run test` | All Tests Below
`npm run cover`              | Standard Style
`npm run standard`           | Coverage
`npm run unit`               | Unit Tests

## Usage

```js
const wrapNumber = require('@pelevesque/wrap-number')
```

```js
const num = 11
const rangeMin = -10
const rangeMax = 10
const result = wrapNumber(num, rangeMin, rangeMax)
// result === -10
```

---
_Source: https://npm.io/package/@pelevesque/wrap-number · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
