node-ip-collection/index.d.ts

Nodejs ip collection (fast search ip in custom range)

import { Address4, Address6 } from 'ip-address';

export interface IpCollectionOptions {
  resultFormat?: ResultFormat;
}

export type DefaultResult = string[] | number[];

export interface StatResult {
  time: number;
  result: DefaultResult;
}

export type IpType = 'v4' | 'v6' | 'unk';
export type ResultFormat = 'default' | 'stat-result';

export interface DataSize {
  v4: number;
  v6: number;
}

export interface Interval {
  start: bigint;
  end: bigint;
}

export class IntervalNode {
  constructor(interval: Interval, value: any);

  interval: Interval;
  value: any;
  maxEnd: bigint;
  left: IntervalNode | null;
  right: IntervalNode | null;
  intervals: Interval[];
}


export class IntervalMultiTree {
  root: IntervalNode | null;
  insert(start: string | number | bigint, end: string | number | bigint, value: any): void;
  search(ip:  string | number | bigint): any[];
}

export interface DataCollection {
  [key: string]: IntervalMultiTree;
}

export default class IpCollection {

  resultFormat?: ResultFormat;

  dataV4?: DataCollection;
  dataV6?: DataCollection;

  get size(): DataSize;

  get height(): DataSize;

  constructor(options?: IpCollectionOptions);

  lookup(ip: string, all: boolean): any[];

  castIpV6ToNum(ip: string): string;

  castIpV4ToNum(ip: string): string;

  castBigIntIpToV4Str(val: bigint): string;

  castBigIntIpToV6Str(val: bigint): string;

  formatIP(ip: string): string;

  insertRange(start: string, end: string, ipType: IpType, value: string | number): void;

  insertRangeAddress(
    startAddr: Address6 | Address4,
    endAddr: Address6 | Address4,
    ipType: IpType,
    value: any
  ): void;

  loadFromString(listString: string, value: string | number): void;

  clear(): void;

  analytics(): any;
}