feat: Add TypeScript types

lib/nettime.d.ts

@@ -0,0 +1,49 @@
+declare interface NettimeOptions {
+  url: string;
+  credentials?: NettimeRequestCredentials;
+  method?: string;
+  headers?: object;
+  timeout?: number;
+  rejectUnauthorized?: boolean;
+  requestCount?: number;
+  requestDelay?: number;
+  outputFile?: string;
+  returnResponse?: boolean;
+  includeHeaders?: boolean;
+  appendToOutput?: any;
+  failOnOutputFileError?: boolean;
+  httpVersion?: string;
+  data?: any;
+}
+
+declare interface NettimeRequestCredentials {
+  username: string;
+  password: string;
+}
+
+declare interface NettimeResponse {
+  timings: NettimeTimings;
+  httpVersion: string;
+  statusCode: number;
+  statusMessage: string;
+  headers?: object;
+  response?: Buffer;
+}
+
+declare interface NettimeTimings {
+  socketOpen: number[];
+  dnsLookup: number[];
+  tcpConnection: number[];
+  tlsHandshake: number[];
+  firstByte: number[];
+  contentTransfer: number[];
+  socketClose: number[];
+}
+
+declare function nettime(options: NettimeOptions): Promise<NettimeResponse>;
+declare namespace nettime {
+  export function getDuration (start: number, end: number): number;
+  export function getMilliseconds (timings: number[]): number;
+}
+
+export = nettime

package.json

@@ -26,6 +26,7 @@
     "node": ">=12"
   },
   "main": "./lib/nettime.js",
+  "types": "./lib/nettime.d.ts",
   "bin": {
     "nettime": "./bin/nettime"
   },