fix: rename scale to scaleFactor in Device type

Author: tahmarrrr23

README.md

@@ -38,7 +38,7 @@ const device: Device = {
   name: "iPhone 12 Pro",
   width: 390,
   height: 844,
-  scale: 3,
+  scaleFactor: 3,
   ppi: 460,
 };
 

examples/visualization.ts

@@ -13,7 +13,7 @@ const device: Device = {
   name: "iPhone 12 Pro",
   width: 390,
   height: 844,
-  scale: 3,
+  scaleFactor: 3,
   ppi: 460,
 };
 

src/adapters/puppeteer.ts

@@ -23,7 +23,7 @@ export class PuppeteerAdapter implements Adapter {
     await this.page.setViewport({
       width: device.width,
       height: device.height,
-      deviceScaleFactor: device.scale,
+      deviceScaleFactor: device.scaleFactor,
     });
     await this.page.goto(url);
     await this.page.evaluate(async () => {

src/tappy.ts

@@ -17,8 +17,8 @@ export class Tappy {
     const html = await this.adapter.getHtml();
 
     const resultElements = elements.map((element) => {
-      const mmWidth = pixelToMm(element.width, device.ppi, device.scale);
-      const mmHeight = pixelToMm(element.height, device.ppi, device.scale);
+      const mmWidth = pixelToMm(element.width, device.ppi, device.scaleFactor);
+      const mmHeight = pixelToMm(element.height, device.ppi, device.scaleFactor);
       const sigmaX = Math.sqrt(0.0091 * mmWidth ** 2 + 1.0949);
       const sigmaY = Math.sqrt(0.0149 * mmHeight ** 2 + 0.9414);
       const tapSuccessRate =

src/types.ts

@@ -25,7 +25,7 @@ export type Device = {
   /**
    * The scale factor of the device.
    */
-  scale: number;
+  scaleFactor: number;
 };
 
 /**

test/tappy.test.ts

@@ -9,7 +9,7 @@ describe("Tappy", () => {
       name: "MockDevice",
       width: 800,
       height: 600,
-      scale: 2,
+      scaleFactor: 2,
       ppi: 96,
     };
 
@@ -63,7 +63,7 @@ describe("Tappy", () => {
       name: "MockDevice",
       width: 800,
       height: 600,
-      scale: 2,
+      scaleFactor: 2,
       ppi: 96,
     };