fix: viewport.deviceScaleFactor can be set to system default (#9911)

puppeteer · Mar 24, 2023 · 022c909 · 022c909
1 parent c09b1b6
commit 022c909
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 1 deletion.
diff --git a/docs/api/puppeteer.viewport.devicescalefactor.md b/docs/api/puppeteer.viewport.devicescalefactor.md
@@ -17,3 +17,7 @@ interface Viewport {
 #### Default value:
 
 1
+
+## Remarks
+
+Setting this value to `0` will set the deviceScaleFactor to the system default.
diff --git a/packages/puppeteer-core/src/common/EmulationManager.ts b/packages/puppeteer-core/src/common/EmulationManager.ts
@@ -34,7 +34,7 @@ export class EmulationManager {
     const mobile = viewport.isMobile || false;
     const width = viewport.width;
     const height = viewport.height;
-    const deviceScaleFactor = viewport.deviceScaleFactor || 1;
+    const deviceScaleFactor = viewport.deviceScaleFactor ?? 1;
     const screenOrientation: Protocol.Emulation.ScreenOrientation =
       viewport.isLandscape
         ? {angle: 90, type: 'landscapePrimary'}

diff --git a/packages/puppeteer-core/src/common/PuppeteerViewport.ts b/packages/puppeteer-core/src/common/PuppeteerViewport.ts
@@ -30,6 +30,10 @@ export interface Viewport {
   /**
    * Specify device scale factor.
    * See {@link https://developer.mozilla.org/en-US/docs/Web/API/Window/devicePixelRatio | devicePixelRatio} for more info.
+   *
+   * @remarks
+   * Setting this value to `0` will set the deviceScaleFactor to the system default.
+   *
    * @defaultValue 1
    */
   deviceScaleFactor?: number;