node-cidr

node-cidr is a Javascript library that makes it easy to manipulate IPs and Subnets. Currently only IPv4 is supported, but IPv6 support is planned for a future release.

Index

$3

* invalidChars

$3

* address
* broadcast
* cidrCommonCidr
* count
* includes
* intCommonCidr
* ipCommonCidr
* ips
* mask
* max
* min
* netmask
* next
* nextCidr
* padLeft
* previous
* previousCidr
* random
* reverse
* subnets
* toBinary
* toCidr
* toHex
* toInt
* toIntRange
* toOctets
* toRange
* toString
* usable
* validateCidr
* validateIp
* wildcardmask

$3

* cidr
* ip

---

Variables

$3

● invalidChars: RegExp = /^.?(?=[\^#%&$\:<>\?\/\{\|\}[a-zA-Z]).*$/

Defined in index.ts:3

___

Functions

$3

► address(ip: string): string

Defined in index.ts:155

Parameters:

| Param | Type | Description |
| ------ | ------ | ------ |
| ip | string | - |

Returns: string

___

$3

► broadcast(cidr: string): string

Defined in index.ts:175

Parameters:

| Param | Type | Description |
| ------ | ------ | ------ |
| cidr | string | - |

Returns: string

___

$3

► cidrCommonCidr(cidrs: string[]): string

Defined in index.ts:166

Parameters:

| Param | Type | Description |
| ------ | ------ | ------ |
| cidrs | string[] | - |

Returns: string

___

$3

► count(cidr: string): number

Defined in index.ts:190

Parameters:

| Param | Type | Description |
| ------ | ------ | ------ |
| cidr | string | - |

Returns: number

___

$3

► includes(cidr: string, ip: string): boolean

Defined in index.ts:240

Parameters:

| Param | Type | Description |
| ------ | ------ | ------ |
| cidr | string | - |
| ip | string | - |

Returns: boolean

___

$3

► intCommonCidr(ips: number[]): string

Defined in index.ts:5

Parameters:

| Param | Type | Description |
| ------ | ------ | ------ |
| ips | number[] | - |

Returns: string

___

$3

► ipCommonCidr(ips: string[]): string

Defined in index.ts:57

Parameters:

| Param | Type | Description |
| ------ | ------ | ------ |
| ips | string[] | - |

Returns: string

___

$3

► ips(cidr: string): string[]

Defined in index.ts:229

Parameters:

| Param | Type | Description |
| ------ | ------ | ------ |
| cidr | string | - |

Returns: string[]

___

$3

► mask(ip: string): number

Defined in index.ts:157

Parameters:

| Param | Type | Description |
| ------ | ------ | ------ |
| ip | string | - |

Returns: number

___

$3

► max(cidr: string): string

Defined in index.ts:184

Parameters:

| Param | Type | Description |
| ------ | ------ | ------ |
| cidr | string | - |

Returns: string

___

$3

► min(cidr: string): string

Defined in index.ts:177

Parameters:

| Param | Type | Description |
| ------ | ------ | ------ |
| cidr | string | - |

Returns: string

___

$3

► netmask(cidr: string): string

Defined in index.ts:172

Parameters:

| Param | Type | Description |
| ------ | ------ | ------ |
| cidr | string | - |

Returns: string

___

$3

► next(ip: string): string

Defined in index.ts:111

Returns the next adjacent address.

Parameters:

| Param | Type | Description |
| ------ | ------ | ------ |
| ip | string | - |

Returns: string

___

$3

► nextCidr(cidr: string): string

Defined in index.ts:245

Parameters:

| Param | Type | Description |
| ------ | ------ | ------ |
| cidr | string | - |

Returns: string

___

$3

► padLeft(input: string, char: string, min: number): string

Defined in index.ts:26

Parameters:

| Param | Type | Description |
| ------ | ------ | ------ |
| input | string | - |
| char | string | - |
| min | number | - |

Returns: string

___

$3

► previous(ip: string): string

Defined in index.ts:117

Returns the previous adjacent address.

Parameters:

| Param | Type | Description |
| ------ | ------ | ------ |
| ip | string | - |

Returns: string

___

$3

► previousCidr(cidr: string): string

Defined in index.ts:248

Parameters:

| Param | Type | Description |
| ------ | ------ | ------ |
| cidr | string | - |

Returns: string

___

$3

► random(cidr: string): string

Defined in index.ts:251

Parameters:

| Param | Type | Description |
| ------ | ------ | ------ |
| cidr | string | - |

Returns: string

___

$3

► reverse(ip: string⎮number): string

Defined in index.ts:73

Returns the reverse lookup hostname for the address.

Parameters:

| Param | Type | Description |
| ------ | ------ | ------ |
| ip | string⎮number | - |

Returns: string

___

$3

► subnets(cidr: string, subMask: number, limit: number): string[]

Defined in index.ts:206

Parameters:

| Param | Type | Description |
| ------ | ------ | ------ |
| cidr | string | - |
| subMask | number | - |
| limit | number | - |

Returns: string[]

___

$3

► toBinary(ip: string⎮number): string

Defined in index.ts:84

Returns the binary representation of the address, in string form.

Parameters:

| Param | Type | Description |
| ------ | ------ | ------ |
| ip | string⎮number | - |

Returns: string

___

$3

► toCidr(ip: string⎮number): string

Defined in index.ts:119

Parameters:

| Param | Type | Description |
| ------ | ------ | ------ |
| ip | string⎮number | - |

Returns: string

___

$3

► toHex(ip: string⎮number): string

Defined in index.ts:97

Provides the hex value of the address.

Parameters:

| Param | Type | Description |
| ------ | ------ | ------ |
| ip | string⎮number | - |

Returns: string

___

$3

► toInt(ipAddress: string): number

Defined in index.ts:35

Parameters:

| Param | Type | Description |
| ------ | ------ | ------ |
| ipAddress | string | - |

Returns: number

___

$3

► toIntRange(cidr: string): number[]

Defined in index.ts:159

Parameters:

| Param | Type | Description |
| ------ | ------ | ------ |
| cidr | string | - |

Returns: number[]

___

$3

► toOctets(input: string⎮number): number[]

Defined in index.ts:62

Parameters:

| Param | Type | Description |
| ------ | ------ | ------ |
| input | string⎮number | - |

Returns: number[]

___

$3

► toRange(cidr: string): string[]

Defined in index.ts:164

Parameters:

| Param | Type | Description |
| ------ | ------ | ------ |
| cidr | string | - |

Returns: string[]

___

$3

► toString(ipInt: number): string

Defined in index.ts:43

Parameters:

| Param | Type | Description |
| ------ | ------ | ------ |
| ipInt | number | - |

Returns: string

___

$3

► usable(cidr: string): string[]

Defined in index.ts:192

Parameters:

| Param | Type | Description |
| ------ | ------ | ------ |
| cidr | string | - |

Returns: string[]

___

$3

► validateCidr(cidr: string): string⎮null

Defined in index.ts:256

Parameters:

| Param | Type | Description |
| ------ | ------ | ------ |
| cidr | string | - |

Returns: string⎮null

___

$3

► validateIp(ip: string): string⎮null

Defined in index.ts:126

Parameters:

| Param | Type | Description |
| ------ | ------ | ------ |
| ip | string | - |

Returns: string⎮null

___

$3

► wildcardmask(cidr: string): string

Defined in index.ts:203

Parameters:

| Param | Type | Description |
| ------ | ------ | ------ |
| cidr | string | - |

Returns: string

___

Object literal: cidr

$3

● address: [address]()

Defined in index.ts:287

___

$3

● broadcast: [broadcast]()

Defined in index.ts:280

___

$3

● commonCidr: [cidrCommonCidr]() = cidrCommonCidr

Defined in index.ts:274

___

$3

● count: [count]()

Defined in index.ts:277

___

$3

● includes: [includes]()

Defined in index.ts:283

___

$3

● ips: [ips]()

Defined in index.ts:282

___

$3

● mask: [mask]()

Defined in index.ts:288

___

$3

● max: [max]()

Defined in index.ts:275

___

$3

● min: [min]()

Defined in index.ts:276

___

$3

● netmask: [netmask]()

Defined in index.ts:278

___

$3

● next: [nextCidr]() = nextCidr

Defined in index.ts:285

___

$3

● previous: [previousCidr]() = previousCidr

Defined in index.ts:286

___

$3

● random: [random]()

Defined in index.ts:284

___

$3

● subnets: [subnets]()

Defined in index.ts:281

___

$3

● toIntRange: [toIntRange]()

Defined in index.ts:273

___

$3

● toRange: [toRange]()

Defined in index.ts:271

___

$3

● usable: [usable]()

Defined in index.ts:272

___

$3

● validate: [validateCidr]() = validateCidr

Defined in index.ts:289

___

$3

● wildcardmask: [wildcardmask]()

Defined in index.ts:279

___

Object literal: ip

$3

● commonCidr: [ipCommonCidr]() = ipCommonCidr

Defined in index.ts:142

___

$3

● next: [next]()

Defined in index.ts:148

___

$3

● previous: [previous]()

Defined in index.ts:147

___

$3

● reverse: [reverse]()

Defined in index.ts:146

___

$3

● toBinary: [toBinary]()

Defined in index.ts:145

___

$3

● toCidr: [toCidr]()

Defined in index.ts:149

___

$3

● toHex: [toHex]()

Defined in index.ts:143

___

$3

● toInt: [toInt]()

Defined in index.ts:140

___

$3

● toOctets: [toOctets]()

Defined in index.ts:144

___

$3

● toString: [toString]()

Defined in index.ts:141

___

$3

● validate: [validateIp]() = validateIp

Defined in index.ts:150

___