# ipv4-calculator

> Calculator for IPv4 networks

Latest version **1.3.1** (published 2019-08-27) · MIT license · 0 weekly downloads

## Install

```sh
npm install ipv4-calculator
pnpm add ipv4-calculator
yarn add ipv4-calculator
bun add ipv4-calculator
```

## 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.3.1 |
| Published | 2019-08-27 |
| First published | 2016-09-30 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 43.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Alex Fitiskin |
| Maintainers | alexfitiskin |
| Keywords | ip, ipv4, networks |

## Links

- npm: https://www.npmjs.com/package/ipv4-calculator
- Repository: https://github.com/afitiskin/ipv4-calculator
- Homepage: https://github.com/afitiskin/ipv4-calculator#readme
- Issues: https://github.com/afitiskin/ipv4-calculator/issues
- npm.io page: https://npm.io/package/ipv4-calculator

## Alternatives

- [lodash.startswith](https://npm.io/package/lodash.startswith.md) — 769.7K weekly downloads
- [@tarojs/service](https://npm.io/package/@tarojs/service.md) — 33.9K weekly downloads
- [io.extendreality.tilia.indicators.spatialtargets.unity](https://npm.io/package/io.extendreality.tilia.indicators.spatialtargets.unity.md) — 131 weekly downloads
- [@rtarojs/taro](https://npm.io/package/@rtarojs/taro.md) — 90 weekly downloads
- [node-branch-io](https://npm.io/package/node-branch-io.md) — 50 weekly downloads

## Recent versions

- 1.3.1 (latest) — 2019-08-27
- 1.3.0 — 2019-07-01
- 1.2.0 — 2016-12-14
- 1.1.1 — 2016-12-14
- 1.1.0 — 2016-10-03
- 1.0.2 — 2016-10-03
- 1.0.1 — 2016-09-30
- 1.0.0 — 2016-09-30

## README

# IPv4 networks calculator
Get IPs list for any network, first network IP address and broadcast IP address.

## Installation
```
npm install ipv4-calculator --save
```

## Usage
```
import * as ipCalculator from 'ipv4-calculator';

ipCalculator.getNetworkFirstIp('192.210.0.11/30'); // '192.210.0.8'
ipCalculator.getNetworkFirstIpAsArray('192.210.0.11/30'); // [192, 210, 0, 8]
ipCalculator.getNetworkBroadcastIp('192.210.0.25/28'); // '192.210.0.31'
ipCalculator.getNetworkBroadcastIpAsArray('192.210.0.25/28'); // [192, 210, 0, 31]
ipCalculator.getNetworkIps('192.210.0.25/30'); // ['192.210.0.24', '192.210.0.25', '192.210.0.26', '192.210.0.27']
ipCalculator.getNetworkIpsQuantity('192.210.0.25/30'); // 4
ipCalculator.getNetworkIpsQuantityByMask(30); // 4
```

## Other
You are able to use utils, validators and decorators from this package

### Utils
```
import * as utils from 'ipv4-calculator/dist/utils';

utils.numberToBinaryString(2); // '10'
utils.binaryStringToNumber('10'); // 2

utils.ipToBinaryString('192.168.0.29'); // '11000000101010000000000000011101'
utils.binaryStringToIp('11000000101010000000000000011101'); // '192.168.0.29'

utils.ipToNumber('192.168.0.29'); // 3232235549
utils.ipNumberToIp(3232235549); // '192.168.0.29'

utils.ipNumberToBinaryString(3232235549); // '11000000101010000000000000011101'

utils.maskToBinaryString(31); // '11111111111111111111111111111110'
utils.binaryStringToMask('11111111111111111111111111111110'); // 31
```

### Validators
```
import * as validator from 'ipv4-calculator/dist/validators';

validator.isMaskValid(15); // true
validator.isMaskValid(150); // false

validator.isIpValid('192.169.0.10'); // true
validator.isIpValid('0.0.0.256'); // false

validator.isIpNumberValid(4294967295); // true
validator.isIpNumberValid(4294967295 + 1); // false

validator.isBinaryStringValid('01010101010101010101010101010101'); // true
validator.isBinaryStringValid('22'); // false

validator.isBinaryMaskValid('11111111111111100000000000000000'); // true
validator.isBinaryMaskValid('11111111111111100000000000000001'); // false

validator.isNetworkValid('0.0.0.0/0'); // true
validator.isNetworkValid('0.0.0.0/33'); // false
```

### Decorators
```
import * as decorators from 'ipv4-calculator/dist/decorators';

class SomeClass {
  @decorators.validateMaskDecorator // throw Error if mask is invalid
  doSomethingWithNetworkMask(mask) {
    // ...
  }

  @decorators.validateIpDecorator // throw Error if IP is invalid
  doSomethingWithIpAddress(ip) {
    // ...
  }

  @decorators.validateNetworkAddressDecorator // throw Error if network is invalid
  doSomethingWithIpNetwork(network) {
    // ...
  }

  @decorators.validateBinaryStringDecorator // throw Error if binary string is invalid
  doSomethingWithBinaryString(string) {
    // ...
  }

  @decorators.validateBinaryMaskDecorator  // throw Error if binary mask is invalid
  doSomethingWithBinaryMask(mask) {
    // ...
  }

  @decorators.validateIpNumberDecorator // throw Error if IP number is invalid
  doSomethingWithIpNumber(ipNumber) {
    // ...
  }
}

// or use decorate util to decorate any function
const myFunc = decorators.decorate(ip => {
  // only if IP valid
  // in other case Error will be throwed
}, decorators.validateIpDecorator);
```

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