Merge pull request #124 from kevcenteno/kevin/reader-types

Update typescript types
runk · Nov 5, 2018 · 6d7a7f4 · 6d7a7f4
2 parents 638464b + 6a34752
commit 6d7a7f4
Showing 1 changed file with 94 additions and 46 deletions.
diff --git a/index.d.ts b/index.d.ts
@@ -8,18 +8,18 @@ export interface IOpenOpts {
 }
 
 export interface INames {
-  de: string;
+  de?: string;
   en: string;
-  es: string;
-  fr: string;
-  ja: string;
-  'pt-BR': string;
-  ru: string;
-  'zh-CN': string;
+  es?: string;
+  fr?: string;
+  ja?: string;
+  'pt-BR'?: string;
+  ru?: string;
+  'zh-CN'?: string;
 }
 
 export interface ICity {
-  confidence: number;
+  confidence?: number;
   geoname_id: number;
   names: INames;
 }
@@ -38,50 +38,50 @@ export interface IBaseCountry {
 }
 
 export interface ICountry extends IBaseCountry {
-  confidence: number;
+  confidence?: number;
 }
 
 export interface ILocation {
-  accuracy_radius: number;
+  accuracy_radius?: number;
   average_income?: number;
-  latitude: number;
-  longitude: number;
+  latitude?: number;
+  longitude?: number;
   metro_code?: number;
   population_density?: number;
-  time_zone: string;
+  time_zone?: string;
 }
 
 export interface IPostal {
   code?: string;
-  confidence: number;
+  confidence?: number;
 }
 
 export interface IRepresentedCountry extends IBaseCountry {
   type: string;
 }
 
 export interface ISubdivisions {
-  confidence: number;
-  geoname_id: number;
-  iso_code: number;
-  names: INames;
+  confidence?: number;
+  geoname_id?: number;
+  iso_code?: string;
+  names?: INames;
 }
 
 export interface ITraits {
-  autonomous_system_number: number;
-  autonomous_system_organization: string;
-  domain: string;
+  autonomous_system_number?: number;
+  autonomous_system_organization?: string;
+  domain?: string;
   ip_address: string;
-  is_anonymous: boolean;
-  is_anonymous_proxy: boolean;
-  is_anonymous_vpn: boolean;
-  is_hosting_provider: boolean;
-  is_public_proxy: boolean;
-  is_satellite_provider: boolean;
-  is_tor_exit_node: boolean;
-  isp: string;
-  organization: string;
-  user_type: 'business'
+  is_anonymous?: boolean;
+  is_anonymous_proxy?: boolean;
+  is_anonymous_vpn?: boolean;
+  is_hosting_provider?: boolean;
+  is_public_proxy?: boolean;
+  is_satellite_provider?: boolean;
+  is_tor_exit_node?: boolean;
+  isp?: string;
+  organization?: string;
+  user_type?: 'business'
   | 'cafe'
   | 'cellular'
   | 'college'
@@ -98,26 +98,74 @@ export interface ITraits {
   | 'traveler';
 }
 
-export interface IFields {
-  city: ICity;
-  continent: IContinent;
-  country: ICountry;
-  location: ILocation;
-  postal: IPostal;
-  registered_country: IBaseCountry;
-  represented_country: IRepresentedCountry;
-  subdivisions: ISubdivisions;
-  traits: ITraits;
+export interface ICountryResponse {
+  continent?: IContinent;
+  country?: ICountry;
+  registered_country?: IBaseCountry;
+  represented_country?: IRepresentedCountry;
+  traits?: ITraits;
 }
 
-export interface IReader {
-  get: (ipAddress: string) => IFields;
+export interface ICityResponse extends ICountryResponse {
+  city?: ICity;
+  location?: ILocation;
+  postal?: IPostal;
+  subdivisions?: ISubdivisions[];
+}
+
+export interface IAnonymousIPResponse {
+  ip_address: string;
+  is_anonymous?: boolean;
+  is_anonymous_proxy?: boolean;
+  is_anonymous_vpn?: boolean;
+  is_hosting_provider?: boolean;
+  is_public_proxy?: boolean;
+  is_tor_exit_node?: boolean;
+}
+
+export interface IAsnResponse {
+  autonomous_system_number: number;
+  autonomous_system_organization: string;
+  ip_address: string;
+}
+
+export interface IConnectionTypeResponse {
+  connection_type: string;
+  ip_address: string;
+}
+
+export interface IDomainResponse {
+  domain: string;
+  ip_address: string;
+}
+
+export interface IIspResponse extends IAsnResponse {
+  isp: string;
+  organization: string;
+}
+
+export interface IReader<T> {
+  get: (ipAddress: string) => T | null;
+  metadata: {
+    binaryFormatMajorVersion: number;
+    binaryFormatMinorVersion: number;
+    buildEpoch: Date;
+    databaseType: string;
+    languages: string[];
+    description: any;
+    ipVersion: number;
+    nodeCount: number;
+    recordSize: number;
+    nodeByteSize: number;
+    searchTreeSize: number;
+    treeDepth: number;
+  };
 }
 
-export type openCb = (err: Error, cb: IReader) => void;
+export type openCb<T> = (err: Error, cb: IReader<T>) => void;
 
-export function open(filepath: string, opts?: IOpenOpts | openCb, cb?: openCb): void;
+export function open<T>(filepath: string, opts?: IOpenOpts | openCb<T>, cb?: openCb<T>): void;
 
-export function openSync(filepath: string, opts?: IOpenOpts): IReader;
+export function openSync<T>(filepath: string, opts?: IOpenOpts): IReader<T>;
 
 export function validate(ipAddress: string): boolean;