ip2ldb-reader/lib/index.d.ts

Reader for IP2Location databases

interface Ip2lOptions {
    /**
     * Reload database when file changes (default: false)
     */
    reloadOnDbUpdate?: boolean;
    /**
     * Cache database in memory (default: false)
     */
    cacheDatabaseInMemory?: boolean;
    /**
     * Path to IP2Location subdivision CSV database (default: undefined)
     */
    subdivisionCsvPath?: string;
    /**
     * Path to IP2Location GeoNameID CSV database (default: undefined)
     */
    geoNameIdCsvPath?: string;
    /**
     * Path to IP2Location Country Info CSV database (default: undefined)
     */
    countryInfoCsvPath?: string;
    /**
     * Path to IATA/ICAO airport CSV database (default: undefined)
     */
    iataIcaoCsvPath?: string;
}
interface CountryInfoData {
    [key: string]: string | number | null | undefined;
    /**
     * Two-character country code based on ISO 3166
     */
    country_code: string;
    /**
     * Country name based on ISO 3166
     */
    country_name?: string;
    /**
     * Three-character country code based on ISO 3166
     */
    country_alpha3_code?: string;
    /**
     * Three-character country numeric code based on ISO 3166
     */
    country_numeric_code?: number | null;
    /**
     * Capital of the country
     */
    capital: string;
    /**
     * Demonym of the country
     */
    country_demonym?: string;
    /**
     * Total area in square-km
     */
    total_area: number | null;
    /**
     * Population of year 2014
     */
    population?: number | null;
    /**
     * The IDD prefix to call the city from another country
     */
    idd_code?: number | null;
    /**
     * Currency code based on ISO 4217
     */
    currency_code?: string;
    /**
     * Currency name
     */
    currency_name?: string;
    /**
     * Currency symbol
     */
    currency_symbol?: string;
    /**
     * Language code based on ISO 639
     */
    lang_code?: string;
    /**
     * Language name
     */
    lang_name?: string;
    /**
     * Country-Code Top-Level Domain
     */
    cctld?: string;
}
interface IataIcaoData {
    [key: string]: string | number | null | undefined;
    /**
     * Three-character code of IATA airport code
     */
    iata: string;
    /**
     * Four-character code of ICAO airport code
     */
    icao: string;
    /**
     * Airport name
     */
    airport: string;
    /**
     * Latitude of the airport
     */
    latitude: number | null;
    /**
     * Longitude of the airport
     */
    longitude: number | null;
}
interface Ip2lData {
    [key: string]: string | number | CountryInfoData | IataIcaoData[] | null | undefined;
    /**
     * IP address
     */
    ip: string | null;
    /**
     * IP number
     */
    ip_no: string | null;
    /**
     * Status of geolocation query
     */
    status: string | null;
    /**
     * ISO 3166-1 country code
     */
    country_short?: string;
    /**
     * Country name
     */
    country_long?: string;
    /**
     * Country info
     */
    country_info?: CountryInfoData | null;
    /**
     * Subdivision part of ISO 3166-2 country-subdivision code
     */
    subdivision?: string;
    /**
     * Region or state name
     */
    region?: string;
    /**
     * City name
     */
    city?: string;
    /**
     * Internet Service Provider or company name
     */
    isp?: string;
    /**
     * City latitude; defaults to capital city latitude if city is unknown
     */
    latitude?: number | null;
    /**
     * City longitude; defaults to capital city longitude if city is unknown
     */
    longitude?: number | null;
    /**
     * Internet domain name associated with IP address range
     */
    domain?: string;
    /**
     * ZIP/Postal code
     */
    zipcode?: string;
    /**
     * UTC time zone (DST is supported)
     */
    timezone?: string;
    /**
     * Internet connection type (DIAL, DSL, COMP)
     */
    netspeed?: string;
    /**
     * The IDD prefix to call the city from another country
     */
    iddcode?: string;
    /**
     * A varying length number assigned to geographic areas for calls between cities
     */
    areacode?: string;
    /**
     * The code of the nearest weather observation station
     */
    weatherstationcode?: string;
    /**
     * The name of the nearest weather observation station
     */
    weatherstationname?: string;
    /**
     * Mobile Country Code (MCC)
     */
    mcc?: string;
    /**
     * Mobile Network Code (MNC)
     */
    mnc?: string;
    /**
     * Commercial brand associated with the mobile carrier
     */
    mobilebrand?: string;
    /**
     * Average height of city above sea level in meters (m)
     */
    elevation?: string;
    /**
     * Usage type classification of ISP or company
     */
    usagetype?: string;
    /**
     * Address type
     */
    addresstype?: string;
    /**
     * IAB category
     */
    category?: string;
    /**
     * GeoName ID
     */
    geoname_id?: number | null;
    /**
     * IATA/ICAO airport info
     */
    airports?: IataIcaoData[];
    /**
     * District name
     */
    district?: string;
    /**
     * Autonomous system number
     */
    asn?: string;
    /**
     * Autonomous system
     */
    as?: string;
}

declare class Ip2lReader {
    private dbReader_;
    private subdivReader_?;
    private geoNameIdReader_?;
    private countryInfoReader_?;
    private iataIcaoReader_?;
    constructor();
    /**
     * Initialize IP2Location database reader(s)
     * @param dbPath IP2Location BIN database
     * @param options Options for database reader
     */
    init(dbPath: string, options?: Ip2lOptions): Promise<void>;
    /**
     * Query IP2Location database with an IP and get location information
     * @param ip IP address
     */
    get(ip: string): Ip2lData;
    /**
     * Close IP2Location database(s) and uninitialize reader(s)
     */
    close(): void;
}

export { type Ip2lData, type Ip2lOptions, Ip2lReader, Ip2lReader as default };