Class IPv6

Represents an IPv6 number. A 128 bit number that is used to uniquely identify a device that is part of a computer network that uses the internet protocol for communication.

See

Hierarchy (View Summary)

AbstractIPNum
- IPv6
  - IPv6Mask

Constructors

constructor

new IPv6(ipValue: string | bigint): IPv6
Constructor for an IPv6 number.
Parameters
- ipValue: string | bigint
  value to construct an IPv6 from. The given value can either be numeric or string. If a string is given then it needs to be in hexadecatet string notation
Returns IPv6
Overrides AbstractIPNum.constructor
- Defined in IPNumber.ts:629

Properties

`Readonly`bitSize

bitSize: number = 128

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

`Readonly`hexadecatet

hexadecatet: Hexadecatet[] = []

An array of Hexadecatet's

`Readonly`maximumBitSize

maximumBitSize: bigint = Validator.ONE_HUNDRED_AND_TWENTY_EIGHT_BIT_SIZE

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

`Readonly`separator

separator: string = ":"

The string character used to separate the individual hexadecatet when the IPv6 is rendered as strings

`Readonly`type

type: IPNumType = IPNumType.IPv6

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 IPv6 number in BigInt

Methods

getHexadecatet

getHexadecatet(): Hexadecatet[]
Gets the individual Hexadecatet that makes up the IPv6 number

Returns Hexadecatet[]
The individual Hexadecatet that makes up the IPv6 number
- Defined in IPNumber.ts:664

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 AbstractIPNum.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 AbstractIPNum.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 AbstractIPNum.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 AbstractIPNum.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 AbstractIPNum.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 AbstractIPNum.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 AbstractIPNum.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 AbstractIPNum.isLessThanOrEquals
- Defined in IPNumber.ts:105

nextIPNumber

nextIPNumber(): IPv6
Returns the next IPv6 number

Returns IPv6
the next IPv6 number
Overrides AbstractIPNum.nextIPNumber
- Defined in IPNumber.ts:673

previousIPNumber

previousIPNumber(): IPv6
Returns the previous IPv6 number

Returns IPv6
the previous IPv6 number
Overrides AbstractIPNum.previousIPNumber
- Defined in IPNumber.ts:682

toBinaryString

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

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

toString

toString(): string
A string representation of the IPv6 number.

Returns string
The string representation of IPv6
- Defined in IPNumber.ts:649

`Static`fromBigInt

fromBigInt(bigIntValue: bigint): IPv6
A convenience method for creating an IPv6 by providing the decimal value of the IP number in BigInt
Parameters
- bigIntValue: bigint
  the decimal value of the IP number in BigInt
Returns IPv6
the IPv6 instance
- Defined in IPNumber.ts:559

`Static`fromBinaryString

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

`Static`fromHexadecatet

fromHexadecatet(ipString: string): IPv6
A convenience method for creating an IPv6 by providing the IP number in hexadecatet notation. E.g "2001:800:0:0:0:0:0:2002"

{@see https://en.wikipedia.org/wiki/IPv6_address#Representation} for more information on hexadecatet notation.
Parameters
- ipString: string
  the IP number in hexadecatet
Returns IPv6
the IPv6 instance
- Defined in IPNumber.ts:572

`Static`fromIPv4

fromIPv4(ipv4: IPv4): IPv6
A convenience method for creating an IPv4-Compatible IPv6 Address from an instance of IPv4
Parameters
- ipv4: IPv4
  to create an IPv4-Compatible IPv6 Address
Returns IPv6
the IPv4-Compatible IPv6 Address
- Defined in IPNumber.ts:608

`Static`fromIPv4DotDecimalString

fromIPv4DotDecimalString(ip4DotDecimalString: string): IPv6
A convenience method for creating an IPv4-Compatible IPv6 Address from a IPv4 represented in dot-decimal notation i.e. 127.0.0.1
Parameters
- ip4DotDecimalString: string
  string represented in a dot decimal string
Returns IPv6
the IPv4-Compatible IPv6 Address
- Defined in IPNumber.ts:619

`Static`fromString

fromString(ipString: string): IPv6
Alias for IPv6.fromHexadecimalString
Parameters
- ipString: string
  the IP number in hexadecatet
Returns IPv6
the IPv6 instance
- Defined in IPNumber.ts:582

Class IPv6

See

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns IPv6

Properties

ReadonlybitSize

Readonlyhexadecatet

ReadonlymaximumBitSize

Readonlyseparator

Readonlytype

Readonlyvalue

Methods

getHexadecatet

Returns Hexadecatet[]

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 IPv6

previousIPNumber

Returns IPv6

toBinaryString

Returns string

toString

Returns string

StaticfromBigInt

Parameters

Returns IPv6

StaticfromBinaryString

Parameters

Returns IPv6

StaticfromHexadecatet

Parameters

Returns IPv6

StaticfromIPv4

Parameters

Returns IPv6

StaticfromIPv4DotDecimalString

Parameters

Returns IPv6

StaticfromString

Parameters

Returns IPv6

Settings

On This Page

`Readonly`bitSize

`Readonly`hexadecatet

`Readonly`maximumBitSize

`Readonly`separator

`Readonly`type

`Readonly`value

`Static`fromBigInt

`Static`fromBinaryString

`Static`fromHexadecatet

`Static`fromIPv4

`Static`fromIPv4DotDecimalString

`Static`fromString