Class AbstractIPRange<T, P>`Abstract`

Provides the implementation of functionality that are common to IPv4CidrRange and IPv6CidrRange

Type Parameters

T extends AbstractIPNum
P extends IPv4Prefix | IPv6Prefix

Hierarchy (View Summary)

AbstractIPRange
- IPv4CidrRange
- IPv6CidrRange

Implements

Iterable<AbstractIPNum>

Index

Constructors

constructor

new AbstractIPRange<T extends AbstractIPNum, P extends IPv4Prefix | IPv6Prefix>(): AbstractIPRange<
T,
P,
>
Type Parameters
- T extends AbstractIPNum
- P extends IPv4Prefix | IPv6Prefix
Returns AbstractIPRange<T, P>

Properties

`Abstract` `Readonly`bitValue

bitValue: bigint

Methods

[iterator]

"[iterator]"(): Iterator<AbstractIPNum>
Returns Iterator<AbstractIPNum>
Implementation of Iterable.[iterator]
- Defined in IPRange.ts:517

contains

contains(otherRange: AbstractIPNum | IPv4CidrRange | IPv6CidrRange): boolean
Parameters
- otherRange: AbstractIPNum | IPv4CidrRange | IPv6CidrRange
Returns boolean
- Defined in IPRange.ts:453

`Abstract`getFirst

getFirst(): T
Returns T
- Defined in IPRange.ts:429

`Abstract`getLast

getLast(): T
Returns T
- Defined in IPRange.ts:430

`Abstract`getPrefix

getPrefix(): P
Returns P
- Defined in IPRange.ts:431

`Abstract`getSize

getSize(): bigint
Returns bigint
- Defined in IPRange.ts:432

hasNextRange

hasNextRange(): boolean
Returns boolean
- Defined in IPRange.ts:435

hasPreviousRange

hasPreviousRange(): boolean
Returns boolean
- Defined in IPRange.ts:440

inside

inside(otherRange: IPv4CidrRange | IPv6CidrRange): boolean
Parameters
- otherRange: IPv4CidrRange | IPv6CidrRange
Returns boolean
- Defined in IPRange.ts:449

isCidrMergeable

isCidrMergeable(otherRange: IPv4CidrRange | IPv6CidrRange): boolean
Parameters
- otherRange: IPv4CidrRange | IPv6CidrRange
Returns boolean
- Defined in IPRange.ts:475

isConsecutive

isConsecutive(otherRange: IPv4CidrRange | IPv6CidrRange): boolean
Parameters
- otherRange: IPv4CidrRange | IPv6CidrRange
Returns boolean
- Defined in IPRange.ts:471

isEquals

isEquals(otherRange: IPv4CidrRange | IPv6CidrRange): boolean
Parameters
- otherRange: IPv4CidrRange | IPv6CidrRange
Returns boolean
- Defined in IPRange.ts:491

isMergeable

isMergeable(otherRange: IPv4CidrRange | IPv6CidrRange): boolean
Parameters
- otherRange: IPv4CidrRange | IPv6CidrRange
Returns boolean
- Defined in IPRange.ts:485

isOverlapping

isOverlapping(otherRange: IPv4CidrRange | IPv6CidrRange): boolean
Parameters
- otherRange: IPv4CidrRange | IPv6CidrRange
Returns boolean
- Defined in IPRange.ts:467

merge

merge(otherRange: IPv4CidrRange | IPv6CidrRange): IPv4CidrRange | IPv6CidrRange
Parameters
- otherRange: IPv4CidrRange | IPv6CidrRange
Returns IPv4CidrRange | IPv6CidrRange
- Defined in IPRange.ts:495

`Protected` `Abstract`newInstance

newInstance(
num: T,
prefix: IPv4Prefix | IPv6Prefix,
): IPv4CidrRange | IPv6CidrRange
Parameters
- num: T
- prefix: IPv4Prefix | IPv6Prefix
Returns IPv4CidrRange | IPv6CidrRange
- Defined in IPRange.ts:428

takeStream

takeStream(count?: number): Iterable<AbstractIPNum>
Returns a lazily evaluated representation of the IP range that produces IP numbers by either:
- iterating over using the for of syntax
- converting to array using spread syntax
- or assigning values to variables using deconstruction
Parameters
- Optionalcount: number
  the number of IP numbers to lazily evaluate. If none is given, the whole IP range is lazily returned.
Returns Iterable<AbstractIPNum>
- Defined in IPRange.ts:513

`Abstract`toCidrString

toCidrString(): string
Returns string
- Defined in IPRange.ts:433

toRangeSet

toRangeSet(): RangedSet<AbstractIPNum>
Returns RangedSet<AbstractIPNum>
- Defined in IPRange.ts:445

toRangeString

toRangeString(): string
Returns string
- Defined in IPRange.ts:463