@terascope/utils / ip
ip
Functions
extractMappedIPv4()
extractMappedIPv4(
input):string
Defined in: packages/utils/src/ip.ts:59
Parameters
| Parameter | Type |
|---|---|
input | unknown |
Returns
string
getAvailablePort()
getAvailablePort(
min,max):Promise<number>
Defined in: packages/utils/src/ip.ts:429
Grabs a random port and checks if it's in use. Will recurse until a random unused port is found and return it.
Parameters
| Parameter | Type | Default value | Description |
|---|---|---|---|
min | number | 10000 | The minimum port number to use |
max | number | 60000 | The maximum port number to use |
Returns
Promise<number>
A port that is available for use
getCIDRBroadcast()
getCIDRBroadcast(
input):string
Defined in: packages/utils/src/ip.ts:269
Parameters
| Parameter | Type |
|---|---|
input | unknown |
Returns
string
getCIDRMax()
getCIDRMax(
input):string
Defined in: packages/utils/src/ip.ts:197
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: packages/utils/src/ip.ts:187
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: packages/utils/src/ip.ts:281
Parameters
| Parameter | Type |
|---|---|
input | unknown |
Returns
string
getFirstIPInCIDR()
getFirstIPInCIDR(
input):string
Defined in: packages/utils/src/ip.ts:206
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: packages/utils/src/ip.ts:232
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: packages/utils/src/ip.ts:219
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: packages/utils/src/ip.ts:246
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: packages/utils/src/ip.ts:71
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: packages/utils/src/ip.ts:338
Parameters
| Parameter | Type |
|---|---|
input | unknown |
ipVersion | string | number |
Returns
string
ipToInt()
ipToInt(
input):bigint
Defined in: packages/utils/src/ip.ts:330
Parameters
| Parameter | Type |
|---|---|
input | unknown |
Returns
bigint
isCIDR()
isCIDR(
input):input is string
Defined in: packages/utils/src/ip.ts:177
Parameters
| Parameter | Type |
|---|---|
input | unknown |
Returns
input is string
isIP()
isIP(
input):input is string
Defined in: packages/utils/src/ip.ts:19
Parameters
| Parameter | Type |
|---|---|
input | unknown |
Returns
input is string
isIPOrThrow()
isIPOrThrow(
input):string
Defined in: packages/utils/src/ip.ts:33
Will throw if input is not a valid IP
Parameters
| Parameter | Type |
|---|---|
input | unknown |
Returns
string
isIPRangeOrThrow()
isIPRangeOrThrow(
input):string
Defined in: packages/utils/src/ip.ts:24
Will throw if input is not a valid CIDR
Parameters
| Parameter | Type |
|---|---|
input | unknown |
Returns
string
isIPv4()
isIPv4(
input):boolean
Defined in: packages/utils/src/ip.ts:45
Parameters
| Parameter | Type |
|---|---|
input | unknown |
Returns
boolean
isIPv6()
isIPv6(
input):boolean
Defined in: packages/utils/src/ip.ts:41
Parameters
| Parameter | Type |
|---|---|
input | unknown |
Returns
boolean
isMappedIPv4()
isMappedIPv4(
input):boolean
Defined in: packages/utils/src/ip.ts:49
Parameters
| Parameter | Type |
|---|---|
input | unknown |
Returns
boolean
isNonRoutableIP()
isNonRoutableIP(
input):boolean
Defined in: packages/utils/src/ip.ts:118
Parameters
| Parameter | Type |
|---|---|
input | unknown |
Returns
boolean
isNonZeroCidr()
isNonZeroCidr(
input):boolean
Defined in: packages/utils/src/ip.ts:324
Parameters
| Parameter | Type |
|---|---|
input | string |
Returns
boolean
isPortInUse()
isPortInUse(
port):Promise<boolean>
Defined in: packages/utils/src/ip.ts:401
Given a port, will attempt to create a Server on said port to verify it's not in use. If successful, will close the server and return false.
Parameters
| Parameter | Type | Description |
|---|---|---|
port | number | The port that will be checked |
Returns
Promise<boolean>
A boolean of true if the address is in use or false if not
isRoutableIP()
isRoutableIP(
input):boolean
Defined in: packages/utils/src/ip.ts:112
Parameters
| Parameter | Type |
|---|---|
input | unknown |
Returns
boolean
reverseIP()
reverseIP(
input):string
Defined in: packages/utils/src/ip.ts:359
Parameters
| Parameter | Type |
|---|---|
input | unknown |
Returns
string
shortenIPv6Address()
shortenIPv6Address(
input):string
Defined in: packages/utils/src/ip.ts:261
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: packages/utils/src/ip.ts:295
Parameters
| Parameter | Type |
|---|---|
input | unknown |
suffix | string | number |
Returns
string