# mod-op

> Modulo operator for numbers

Latest version **1.0.1** (published 2019-01-09) · MIT license · 0 weekly downloads

## Install

```sh
npm install mod-op
pnpm add mod-op
yarn add mod-op
bun add mod-op
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2019-01-09 |
| First published | 2015-02-03 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 3 |
| Author | Eirik Vullum |
| Maintainers | eiriklv |
| Keywords | modulo, modulus, remainder, wrap, wrapping |

## Links

- npm: https://www.npmjs.com/package/mod-op
- Repository: https://github.com/eiriklv/mod-op
- Issues: https://github.com/eiriklv/mod-op/issues
- npm.io page: https://npm.io/package/mod-op

## Recent versions

- 1.0.1 (latest) — 2019-01-09
- 1.0.0 — 2015-02-03

## README

mod-op
======

[![Build Status](https://travis-ci.org/eiriklv/mod-op.svg?branch=master)](https://travis-ci.org/eiriklv/mod-op)
[![npm version](https://badge.fury.io/js/mod-op.svg)](http://badge.fury.io/js/mod-op)
[![Dependency Status](https://david-dm.org/eiriklv/mod-op.svg)](https://david-dm.org/eiriklv/mod-op)
[![devDependency Status](https://david-dm.org/eiriklv/mod-op/dev-status.svg)](https://david-dm.org/eiriklv/mod-op#info=devDependencies)

#### Introduction:
Modulo operator as a function for JavaScript, as it only has the remainder (`%`) operator by default.

---------------------------------------

### mod(dividend, divisor)

Perform `dividend` modulo `divisor`

__Arguments__

* `dividend` - Number
* `divisor` - Number

__Example__

```js
var mod = require('mod-op');

var wrapped = mod(-128, 256);
// 128
```

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