type for the raw object in the results

cloudflare · j-d-carmichael · Oct 29, 2023 · Oct 29, 2023 · Oct 29, 2023 · Oct 29, 2023
commit f720d8072a3db00155abab2e9f723a1112cfc372
diff --git a/.idea/.gitignore b/.idea/.gitignore
diff --git a/.idea/cloudflare-speedtest.iml b/.idea/cloudflare-speedtest.iml
diff --git a/.idea/markdown.xml b/.idea/markdown.xml
diff --git a/.idea/modules.xml b/.idea/modules.xml
diff --git a/.idea/php.xml b/.idea/php.xml
diff --git a/.idea/vcs.xml b/.idea/vcs.xml
diff --git a/src/index.d.ts b/src/index.d.ts
@@ -42,7 +42,7 @@ export interface ConfigOptions {
   loadedLatencyMaxPoints?: number
 }
 
-interface BandwidthPoint {
+export interface BandwidthPoint {
   bytes: number,
   bps: number,
   duration: number,
@@ -52,8 +52,33 @@ interface BandwidthPoint {
   transferSize: number
 }
 
+export interface ResultTiming {
+  bps: number,
+  duration: number,
+  measTime: Date,
+  payloadDownloadTime: number,
+  ping: number,
+  serverTime: number,
+  transferSize: 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 declare class Results {
-  constructor();
+  constructor ();
 
   readonly isFinished: boolean;
 
@@ -67,7 +92,7 @@ export declare class Results {
     upLoadedLatency?: number,
     upLoadedJitter?: number,
     packetLoss?: number,
-  }
+  };
 
   getUnloadedLatency: () => number | undefined;
   getUnloadedJitter: () => number | undefined;
@@ -96,11 +121,51 @@ export declare class Results {
       classificationIdx: 0 | 1 | 2 | 3 | 4;
       classificationName: 'bad' | 'poor' | 'average' | 'good' | 'great';
     }
-  }
+  };
+  raw: {
+    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
+    },
+  };
 }
 
 declare class SpeedTestEngine {
-  constructor(config?: ConfigOptions);
+  constructor (config?: ConfigOptions);
 
   play: () => void;
   pause: () => void;
@@ -116,4 +181,4 @@ declare class SpeedTestEngine {
   onError: (error: string) => void;
 }
 
-export default SpeedTestEngine;
+export default SpeedTestEngine;