Class IPv4Prefix

Represents the prefix portion in the CIDR notation for representing IP ranges

The IPv4 prefix portion represents the mask. It is the number of continuous bits turned on (with value 1) counting from the left side of an 8 bit value.

{@see https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing} for more information on CIDR

Implements

Prefix

Index

Constructors

Properties

Methods

getValue merge split toMask toRangeSize toString fromNumber fromRangeSize

Constructors

constructor

new IPv4Prefix(rawValue: bigint): IPv4Prefix
Constructor for an instance of IPv4 prefix from a decimal number
Parameters
- rawValue: bigint
  the decimal value to construct the IPv4 prefix from.
Returns IPv4Prefix
the instance of an IPv4 prefix
- Defined in Prefix.ts:55

Properties

type

type: "IPv4"

value

value: bigint

The decimal value of the 8bit number representing the prefix

Methods

getValue

getValue(): bigint
Gets the decimal value of the IPv4 prefix

Returns bigint
the decimal value of the IPv4 prefix
Implementation of Prefix.getValue
- Defined in Prefix.ts:70

merge

merge(): IPv4Prefix
Returns a prefix for when this prefix is merged with another prefix of the same size

Returns IPv4Prefix
Implementation of Prefix.merge
- Defined in Prefix.ts:114

split

split(): IPv4Prefix
Returns a prefix for when this prefix is split into two equal halves

Returns IPv4Prefix
Implementation of Prefix.split
- Defined in Prefix.ts:122

toMask

toMask(): IPv4Mask
Converts the IPv4 prefix to a IPv4Mask

The IPv4 mask is the representation of the prefix in the dot-decimal notation

Returns IPv4Mask
the mask representation of the prefix
- Defined in Prefix.ts:89

toRangeSize

toRangeSize(): bigint
Returns the size (number of IP numbers) of range of this prefix

Returns bigint
the size (number of IP numbers) of range of this prefix
Implementation of Prefix.toRangeSize
- Defined in Prefix.ts:100

toString

toString(): string
Gets the decimal value of the IPv4 prefix as string

Returns string
The decimal value of the IPv4 prefix as string
Implementation of Prefix.toString
- Defined in Prefix.ts:78

`Static`fromNumber

fromNumber(rawValue: bigint): IPv4Prefix
Convenience method for constructing an instance of IPv4 prefix from a decimal number
Parameters
- rawValue: bigint
  the decimal value to construct the IPv4 prefix from.
Returns IPv4Prefix
the instance of an IPv4 prefix
- Defined in Prefix.ts:40

`Static`fromRangeSize

fromRangeSize(rangeSize: bigint): IPv4Prefix
Parameters
- rangeSize: bigint
Returns IPv4Prefix
- Defined in Prefix.ts:44