Types for the results.raw object added to the index.d.ts

src/index.d.ts

@@ -15,6 +15,47 @@ export type MeasurementConfig = {
   connectionTimeout?: number,
 };
 
+export interface RawResults {
+  download: {
+    finished: boolean,
+    results: {
+      '100000'?: ResultDownload,
+      '1000000'?: ResultDownload,
+      '10000000'?: ResultDownload,
+    },
+    stated: boolean
+  },
+  latency: {
+    finished: boolean,
+    results: {
+      numMeasurements: number,
+      timings: ResultTiming[],
+      start: boolean,
+    },
+    stated: boolean
+  },
+  packetLoss: {
+    finished: boolean,
+    results: {
+      lostMessages: any[],
+      numMessagesSent: number,
+      packetLoss: number,
+      totalMessages: number,
+    },
+    stated: boolean
+  },
+  upload: {
+    finished: boolean,
+    finishedCurrentRound: boolean,
+    results: {
+      '100000'?: ResultDownload,
+      '1000000'?: ResultDownload,
+      '10000000'?: ResultDownload,
+    },
+    stated: boolean
+  },
+}
+
 export interface ConfigOptions {
   autoStart?: boolean;
 
@@ -42,7 +83,7 @@ export interface ConfigOptions {
   loadedLatencyMaxPoints?: number
 }
 
-interface BandwidthPoint {
+export interface BandwidthPoint {
   bytes: number,
   bps: number,
   duration: number,
@@ -52,22 +93,43 @@ interface BandwidthPoint {
   transferSize: number
 }
 
+export interface ResultTiming extends BandwidthPoint {
+  payloadDownloadTime: number,
+  ttfb: number,
+}
+
+export interface ResultDownloadTiming extends ResultTiming {
+  type: string;
+}
+
+export interface ResultLatency extends ResultTiming {
+  bytes: number;
+}
+
+export interface ResultDownload {
+  numMeasurements: number,
+  sideLatency: ResultLatency[],
+  timings: ResultDownloadTiming[]
+}
+
+export interface GetSummary {
+  download?: number,
+  upload?: number,
+  latency?: number,
+  jitter?: number,
+  downLoadedLatency?: number,
+  downLoadedJitter?: number,
+  upLoadedLatency?: number,
+  upLoadedJitter?: number,
+  packetLoss?: number,
+}
+
 export declare class Results {
-  constructor();
+  constructor ();
 
   readonly isFinished: boolean;
 
-  getSummary: () => {
-    download?: number,
-    upload?: number,
-    latency?: number,
-    jitter?: number,
-    downLoadedLatency?: number,
-    downLoadedJitter?: number,
-    upLoadedLatency?: number,
-    upLoadedJitter?: number,
-    packetLoss?: number,
-  }
+  getSummary: () => GetSummary;
 
   getUnloadedLatency: () => number | undefined;
   getUnloadedJitter: () => number | undefined;
@@ -96,11 +158,12 @@ export declare class Results {
       classificationIdx: 0 | 1 | 2 | 3 | 4;
       classificationName: 'bad' | 'poor' | 'average' | 'good' | 'great';
     }
-  }
+  };
+  raw: RawResults;
 }
 
 declare class SpeedTestEngine {
-  constructor(config?: ConfigOptions);
+  constructor (config?: ConfigOptions);
 
   play: () => void;
   pause: () => void;
@@ -116,4 +179,4 @@ declare class SpeedTestEngine {
   onError: (error: string) => void;
 }
 
-export default SpeedTestEngine;
+export default SpeedTestEngine;