IP Utils API Overview
extractMappedIPv4()
extractMappedIPv4(
input):string
Defined in: index.ts:56
Parameters
| Parameter | Type |
|---|---|
input | unknown |
Returns
string
getCIDRBroadcast()
getCIDRBroadcast(
input):string
Defined in: index.ts:274
Parameters
| Parameter | Type |
|---|---|
input | unknown |
Returns
string
getCIDRMax()
getCIDRMax(
input):string
Defined in: index.ts:202
Parameters
| Parameter | Type | Description |
|---|---|---|
input | unknown | ip address block in CIDR notation |
Returns
string
last ip address in the block
Deprecated
use getLastUsableIPInCIDR
getCIDRMin()
getCIDRMin(
input):string
Defined in: index.ts:192
Parameters
| Parameter | Type | Description |
|---|---|---|
input | unknown | ip address block in CIDR notation |
Returns
string
first IP address in the block
Deprecated
use getFirstUsableIPInCIDR
getCIDRNetwork()
getCIDRNetwork(
input):string
Defined in: index.ts:286
Parameters
| Parameter | Type |
|---|---|
input | unknown |
Returns
string
getFirstIPInCIDR()
getFirstIPInCIDR(
input):string
Defined in: index.ts:211
Parameters
| Parameter | Type | Description |
|---|---|---|
input | unknown | ip address block in CIDR notation, inclusive |
Returns
string
first IP address in the block
getFirstUsableIPInCIDR()
getFirstUsableIPInCIDR(
input):string
Defined in: index.ts:237
Parameters
| Parameter | Type | Description |
|---|---|---|
input | unknown | ip address block in CIDR notation |
Returns
string
first usable ip address of the CIDR block
getLastIPInCIDR()
getLastIPInCIDR(
input):string
Defined in: index.ts:224
Parameters
| Parameter | Type | Description |
|---|---|---|
input | unknown | ip address block in CIDR notation |
Returns
string
last ip address in the block, inclusive
getLastUsableIPInCIDR()
getLastUsableIPInCIDR(
input):string
Defined in: index.ts:251
Parameters
| Parameter | Type | Description |
|---|---|---|
input | unknown | ip address block in CIDR notation |
Returns
string
last usable ip address of the CIDR block
inIPRange()
inIPRange(
input,args):boolean
Defined in: index.ts:68
Parameters
| Parameter | Type |
|---|---|
input | unknown |
args | { cidr?: string; max?: string; min?: string; } |
args.cidr? | string |
args.max? | string |
args.min? | string |
Returns
boolean
intToIP()
intToIP(
input,ipVersion):string
Defined in: index.ts:343
Parameters
| Parameter | Type |
|---|---|
input | unknown |
ipVersion | string | number |
Returns
string
ipToInt()
ipToInt(
input):bigint
Defined in: index.ts:335
Parameters
| Parameter | Type |
|---|---|
input | unknown |
Returns
bigint
isCIDR()
isCIDR(
input):input is string
Defined in: index.ts:182
Parameters
| Parameter | Type |
|---|---|
input | unknown |
Returns
input is string
isIP()
isIP(
input):input is string
Defined in: index.ts:16
Parameters
| Parameter | Type |
|---|---|
input | unknown |
Returns
input is string
isIPOrThrow()
isIPOrThrow(
input):string
Defined in: index.ts:30
Will throw if input is not a valid IP
Parameters
| Parameter | Type |
|---|---|
input | unknown |
Returns
string
isIPRangeOrThrow()
isIPRangeOrThrow(
input):string
Defined in: index.ts:21
Will throw if input is not a valid CIDR
Parameters
| Parameter | Type |
|---|---|
input | unknown |
Returns
string
isIPv4()
isIPv4(
input):boolean
Defined in: index.ts:42
Parameters
| Parameter | Type |
|---|---|
input | unknown |
Returns
boolean
isIPv6()
isIPv6(
input):boolean
Defined in: index.ts:38
Parameters
| Parameter | Type |
|---|---|
input | unknown |
Returns
boolean
isMappedIPv4()
isMappedIPv4(
input):boolean
Defined in: index.ts:46
Parameters
| Parameter | Type |
|---|---|
input | unknown |
Returns
boolean
isNonRoutableIP()
isNonRoutableIP(
input):boolean
Defined in: index.ts:123
Parameters
| Parameter | Type |
|---|---|
input | unknown |
Returns
boolean
isNonZeroCidr()
isNonZeroCidr(
input):boolean
Defined in: index.ts:329
Parameters
| Parameter | Type |
|---|---|
input | string |
Returns
boolean
isRoutableIP()
isRoutableIP(
input):boolean
Defined in: index.ts:117
Parameters
| Parameter | Type |
|---|---|
input | unknown |
Returns
boolean
reverseIP()
reverseIP(
input):string
Defined in: index.ts:364
Parameters
| Parameter | Type |
|---|---|
input | unknown |
Returns
string
shortenIPv6Address()
shortenIPv6Address(
input):string
Defined in: index.ts:266
Parameters
| Parameter | Type | Description |
|---|---|---|
input | unknown | ip address |
Returns
string
IPv6 addresses are returned without leading 0's in a group or empty groups ipv4 addresses are simply returned
toCIDR()
toCIDR(
input,suffix):string
Defined in: index.ts:300
Parameters
| Parameter | Type |
|---|---|
input | unknown |
suffix | string | number |
Returns
string