node_modules/ipaddr.js/lib/ipaddr.js.d.ts

   1
   2
   3 declare module "ipaddr.js" {
   4
   5     type IPv4Range = 'unicast' | 'unspecified' | 'broadcast' | 'multicast' | 'linkLocal' | 'loopback' | 'carrierGradeNat' | 'private' | 'reserved';
   6     type IPv6Range = 'unicast' | 'unspecified' | 'linkLocal' | 'multicast' | 'loopback' | 'uniqueLocal' | 'ipv4Mapped' | 'rfc6145' | 'rfc6052' | '6to4' | 'teredo' | 'reserved';
   7
   8     interface RangeList<T> {
   9         [name: string]: [T, number] | [T, number][];
  10     }
  11
  12
  13     // Common methods/properties for IPv4 and IPv6 classes.
  14     class IP {
  15
  16         prefixLengthFromSubnetMask(): number | false;
  17         toByteArray(): number[];
  18         toNormalizedString(): string;
  19         toString(): string;
  20     }
  21
  22     namespace Address {
  23
  24         export function isValid(addr: string): boolean;
  25         export function fromByteArray(bytes: number[]): IPv4 | IPv6;
  26         export function parse(addr: string): IPv4 | IPv6;
  27         export function parseCIDR(mask: string): [IPv4 | IPv6, number];
  28         export function process(address: string): IPv4 | IPv6;
  29         export function subnetMatch(addr: IPv4, rangeList: RangeList<IPv4>, defaultName?: string): string;
  30         export function subnetMatch(addr: IPv6, rangeList: RangeList<IPv6>, defaultName?: string): string;
  31
  32         export class IPv4 extends IP {
  33             static broadcastAddressFromCIDR(addr: string): IPv4;
  34             static isIPv4(addr: string): boolean;
  35             static isValidFourPartDecimal(addr: string): boolean;
  36             static isValid(addr: string): boolean;
  37             static networkAddressFromCIDR(addr: string): IPv4;
  38             static parse(addr: string): IPv4;
  39             static parseCIDR(addr: string): [IPv4, number];
  40             static subnetMaskFromPrefixLength(prefix: number): IPv4;
  41             constructor(octets: number[]);
  42
  43             kind(): 'ipv4';
  44             match(addr: IPv4, bits: number): boolean;
  45             match(mask: [IPv4, number]): boolean;
  46             range(): IPv4Range;
  47             subnetMatch(rangeList: RangeList<IPv4>, defaultName?: string): string;
  48             toIPv4MappedAddress(): IPv6;
  49         }
  50
  51         export class IPv6 extends IP {
  52             static broadcastAddressFromCIDR(addr: string): IPv6;
  53             static isIPv6(addr: string): boolean;
  54             static isValid(addr: string): boolean;
  55             static parse(addr: string): IPv6;
  56             static parseCIDR(addr: string): [IPv6, number];
  57             static subnetMaskFromPrefixLength(prefix: number): IPv6;
  58             constructor(octets: number[]);
  59
  60             isIPv4MappedAddress(): boolean;
  61             kind(): 'ipv6';
  62             match(addr: IPv6, bits: number): boolean;
  63             match(mask: [IPv6, number]): boolean;
  64             range(): IPv6Range;
  65             subnetMatch(rangeList: RangeList<IPv6>, defaultName?: string): string;
  66             toIPv4Address(): IPv4;
  67         }
  68     }
  69
  70     export = Address;
  71 }