Class IPv4Mask

The IPv4Mask can be seen as a specialized IPv4 number where, in a 32 bit number, starting from the left, you have continuous bits turned on (with 1 value) followed by bits turned off (with 0 value). In networking, it is used to demarcate which bits are used to identify a network, and the ones that are used to identify hosts on the network

Hierarchy (View Summary)

IPv4
- IPv4Mask

Constructors

constructor

new IPv4Mask(ipString: string): IPv4Mask
Constructor for creating an instance of IPv4Mask. The passed strings need to be a valid IPv4 mask number in dot-decimal notation.
Parameters
- ipString: string
  The passed string in dot-decimal notation
Returns IPv4Mask
Overrides IPv4.constructor
- Defined in IPNumber.ts:762

Properties

`Readonly`bitSize

bitSize: number = 32

The number of bits needed to represents the value of the IPv4 number

`Readonly`maximumBitSize

maximumBitSize: bigint = Validator.THIRTY_TWO_BIT_SIZE

The maximum bit size (i.e. binary value) of the IPv4 number in BigInt

`Readonly`octets

octets: Octet[] = []

An array of Octet's

`Readonly`prefix

prefix: number

The cidr prefix represented by this mask

`Readonly`separator

separator: string = "."

The string character used to separate the individual octets when the IPv4 is rendered as strings

`Readonly`type

type: IPNumType = IPNumType.IPv4

The type of IP number. Value is one of the values of the IPNumType enum

`Readonly`value

value: bigint

The decimal value represented by the IPv4 mask in BigInt

Methods

getOctets

getOctets(): Octet[]
Gets the individual Octet that makes up the IPv4 number

Returns Octet[]
The individual Octet that makes up the IPv4 number
Inherited from IPv4.getOctets
- Defined in IPNumber.ts:242

getValue

getValue(): bigint
Gets the numeric value of an IP number as BigInt

Returns bigint
bigInt the numeric value of an IP number.
Inherited from IPv4.getValue
- Defined in IPNumber.ts:40

hasNext

hasNext(): boolean
Checks if an IP number has a value greater than the present value

Returns boolean
true, if there is a value greater than the present value. Returns false otherwise.
Inherited from IPv4.hasNext
- Defined in IPNumber.ts:57

hasPrevious

hasPrevious(): boolean
Checks if an IP number has a value lesser than the present value

Returns boolean
true, if there is a value lesser than the present value. Returns false otherwise.
Inherited from IPv4.hasPrevious
- Defined in IPNumber.ts:65

isEquals

isEquals(anotherIPNum: AbstractIPNum): boolean
Checks if the given IP number, is equals to the current IP number
Parameters
- anotherIPNum: AbstractIPNum
  the other IP number to compare with
Returns boolean
true if the given IP number is equals
Inherited from IPv4.isEquals
- Defined in IPNumber.ts:75

isGreaterThan

isGreaterThan(anotherIPNum: AbstractIPNum): boolean
Checks if the given IP number is greater than this current IP number
Parameters
- anotherIPNum: AbstractIPNum
  the other IP number to compare with
Returns boolean
true if the given IP number is greater than this current one. False otherwise.
Inherited from IPv4.isGreaterThan
- Defined in IPNumber.ts:95

isGreaterThanOrEquals

isGreaterThanOrEquals(anotherIPNum: AbstractIPNum): boolean
Checks if the given IP number is greater than or equals to this current IP number
Parameters
- anotherIPNum: AbstractIPNum
  the other IP number to compare with
Returns boolean
{boolean} true if the given IP number is greater than or equals to this current one. False otherwise.
Inherited from IPv4.isGreaterThanOrEquals
- Defined in IPNumber.ts:116

isLessThan

isLessThan(anotherIPNum: AbstractIPNum): boolean
Checks if the given IP number is lesser than this current IP number
Parameters
- anotherIPNum: AbstractIPNum
  the other IP number to compare with
Returns boolean
true if the given IP number is less than this current one. False otherwise.
Inherited from IPv4.isLessThan
- Defined in IPNumber.ts:85

isLessThanOrEquals

isLessThanOrEquals(anotherIPNum: AbstractIPNum): boolean
Checks if the given IP number is less than or equals to this current IP number
Parameters
- anotherIPNum: AbstractIPNum
  the other IP number to compare with
Returns boolean
true if the given IP number is less than or equals to this current one. False otherwise.
Inherited from IPv4.isLessThanOrEquals
- Defined in IPNumber.ts:105

nextIPNumber

nextIPNumber(): IPv4
Returns the next IPv4 number

Returns IPv4
the next IPv4 number
Inherited from IPv4.nextIPNumber
- Defined in IPNumber.ts:251

previousIPNumber

previousIPNumber(): IPv4
Returns the previous IPv4 number

Returns IPv4
the previous IPv4 number
Inherited from IPv4.previousIPNumber
- Defined in IPNumber.ts:260

toBinaryString

toBinaryString(): string
Gets the binary string representation of an IP number.

Returns string
the string binary representation.
Inherited from IPv4.toBinaryString
- Defined in IPNumber.ts:49

toIPv4MappedIPv6

toIPv4MappedIPv6(): IPv6
Returns this IPv4 number as a IPv4-Mapped IPv6 Address

The IPv4-Mapped IPv6 Address allows an IPv4 number to be embedded within an IPv6 number

{@see https://tools.ietf.org/html/rfc4291#section-2.5.5} for more information on the IPv4-Mapped IPv6 Address

Returns IPv6
an IPv6 number with the IPv4 embedded within it
Inherited from IPv4.toIPv4MappedIPv6
- Defined in IPNumber.ts:273

toString

toString(): string
A string representation of the IPv4 number. The string representation is in dot-decimal notation

Returns string
The string representation in dot-decimal notation
Inherited from IPv4.toString
- Defined in IPNumber.ts:233

`Static`fromBinaryString

fromBinaryString(ipBinaryString: string): IPv4
A convenience method for creating an IPv4 from binary string
Parameters
- ipBinaryString: string
  the binary string representing the IPv4 number to be created
Returns IPv4
the IPv4 instance
Inherited from IPv4.fromBinaryString
- Defined in IPNumber.ts:200

`Static`fromDecimalDottedString

fromDecimalDottedString(rawValue: string): IPv4Mask
A convenience method for creating an instance of IPv4Mask. The passed strings need to be a valid IPv4 number in dot-decimal notation.
Parameters
- rawValue: string
  The passed string in dot-decimal notation
Returns IPv4Mask
the instance of IPv4Mask
Overrides IPv4.fromDecimalDottedString
- Defined in IPNumber.ts:752

`Static`fromNumber

fromNumber(bigIntValue: number | bigint): IPv4
A convenience method for creating an IPv4 by providing the decimal value of the IP number in BigInt
Parameters
- bigIntValue: number | bigint
  the decimal value of the IP number in BigInt
Returns IPv4
the IPv4 instance
Inherited from IPv4.fromNumber
- Defined in IPNumber.ts:167

`Static`fromString

fromString(ipString: string): IPv4
Alias for IPv4.fromDecimalDottedString.
Parameters
- ipString: string
  the IP number in dot-decimal notation
Returns IPv4
the IPv4 instance
Inherited from IPv4.fromString
- Defined in IPNumber.ts:190

Class IPv4Mask

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns IPv4Mask

Properties

ReadonlybitSize

ReadonlymaximumBitSize

Readonlyoctets

Readonlyprefix

Readonlyseparator

Readonlytype

Readonlyvalue

Methods

getOctets

Returns Octet[]

getValue

Returns bigint

hasNext

Returns boolean

hasPrevious

Returns boolean

isEquals

Parameters

Returns boolean

isGreaterThan

Parameters

Returns boolean

isGreaterThanOrEquals

Parameters

Returns boolean

isLessThan

Parameters

Returns boolean

isLessThanOrEquals

Parameters

Returns boolean

nextIPNumber

Returns IPv4

previousIPNumber

Returns IPv4

toBinaryString

Returns string

toIPv4MappedIPv6

Returns IPv6

toString

Returns string

StaticfromBinaryString

Parameters

Returns IPv4

StaticfromDecimalDottedString

Parameters

Returns IPv4Mask

StaticfromNumber

Parameters

Returns IPv4

StaticfromString

Parameters

Returns IPv4

Settings

On This Page

`Readonly`bitSize

`Readonly`maximumBitSize

`Readonly`octets

`Readonly`prefix

`Readonly`separator

`Readonly`type

`Readonly`value

`Static`fromBinaryString

`Static`fromDecimalDottedString

`Static`fromNumber

`Static`fromString