Use stricter type for os

digidem · Apr 23, 2024 · c6be498 · c6be498
1 parent 9b3b7c0
commit c6be498
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 3 deletions.
diff --git a/src/frontend/metrics/generateMetricsReport.test.ts b/src/frontend/metrics/generateMetricsReport.test.ts
@@ -48,14 +48,18 @@ describe('generateMetricsReport', () => {
   });
 
   it('includes the OS (iOS style)', () => {
-    const options = {...defaultOptions, os: 'ios', osVersion: '1.2.3'};
+    const options = {...defaultOptions, os: 'ios' as const, osVersion: '1.2.3'};
     const report = generateMetricsReport(options);
     expect(report.os).toBe('ios');
     expect(report.osVersion).toBe('1.2.3');
   });
 
   it('includes the OS (desktop style)', () => {
-    const options = {...defaultOptions, os: 'win32', osVersion: '1.2.3'};
+    const options = {
+      ...defaultOptions,
+      os: 'win32' as const,
+      osVersion: '1.2.3',
+    };
     const report = generateMetricsReport(options);
     expect(report.os).toBe('win32');
     expect(report.osVersion).toBe('1.2.3');

diff --git a/src/frontend/metrics/generateMetricsReport.ts b/src/frontend/metrics/generateMetricsReport.ts
@@ -10,7 +10,7 @@ export default function generateMetricsReport({
   observations,
 }: ReadonlyDeep<{
   packageJson: {version: string};
-  os: string;
+  os: 'android' | 'ios' | NodeJS.Platform;
   osVersion: number | string;
   screen: {width: number; height: number};
   observations: ReadonlyArray<Pick<Observation, 'lat' | 'lon'>>;