ip-num
    Preparing search index...

    Class IPv4CidrRange

    Represents a continuous segment of IPv4 numbers following the classless inter-domain routing scheme for allocating IP addresses.

    Hierarchy (View Summary)

    Index

    Constructors

    • Constructor for creating an instance of an IPv4 range.

      The arguments taken by the constructor is inspired by the CIDR notation which basically consists of the IP number and the prefix.

      Parameters

      • ipv4: IPv4

        the IP number used to construct the range. By convention this is the first IP number in the range, but it could also be any IP number within the range

      • cidrPrefix: IPv4Prefix

        the prefix which is a representation of the number of bits used to mask the given IP number in other to create the range

      Returns IPv4CidrRange

    Properties

    bitValue: bigint = 32n
    cidrPrefix: IPv4Prefix

    the prefix which is a representation of the number of bits used to mask the given IP number in other to create the range

    Methods

    • Gets the size of IPv4 numbers contained within the IPv4 range

      Returns bigint

      the amount of IPv4 numbers in the range

    • Indicate if the given range is a container range.

      By container range, it means all the IP number in this current range can be found within the given range.

      Parameters

      Returns boolean

      true if the other Ipv4 range is a container range. False otherwise.

    • Indicates whether the given IPv4 range is an adjacent range.

      An adjacent range being one where the end of the given range, when incremented by one marks the start of the other range. Or where the start of the given range, when decreased by one, marks the end of the other range

      Parameters

      Returns boolean

      true if the two IPv4 ranges are consecutive, false otherwise

    • Method that takes IPv4 number from within an IPv4 range, starting from the first IPv4 number

      Parameters

      • count: bigint

        the amount of IPv4 number to take from the IPv4 range

      Returns IPv4[]

      an array of IPv4 number, taken from the IPv4 range

    • 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>

    • Method that returns the IPv4 range in string notation where the first IPv4 number and last IPv4 number are separated by an hyphen. eg. 192.198.0.0-192.198.0.255

      Returns string

      the range in [first IPv4 number] - [last IPv4 number] format

    • Convenience method for constructing an instance of an IPv4CidrRange from an IP range represented in CIDR notation

      Parameters

      • rangeIncidrNotation: string

        the range of the IPv4 number in CIDR notation

      Returns IPv4CidrRange

      the IPv4CidrRange