feat: allow deprecated formatQuality with logged warning

Signed-off-by: Nathan Reed <nathreed@gmail.com>
maptiler · Jul 31, 2024 · c5895d9 · c5895d9
1 parent a436a67
commit c5895d9
Showing 1 changed file with 11 additions and 2 deletions.
diff --git a/src/serve_rendered.js b/src/serve_rendered.js
@@ -503,6 +503,15 @@ const respondImage = (
         image.composite(composites);
       }
 
+      // Legacy formatQuality is deprecated but still works
+      const formatQualities = options.formatQuality || {};
+      if (Object.keys(formatQualities).length !== 0) {
+        console.log(
+          'WARNING: The formatQuality option is deprecated and has been replaced with formatOptions. Please see the documentation. The values from formatQuality will be used if a quality setting is not provided via formatOptions.',
+        );
+      }
+      const formatQuality = formatQualities[format];
+
       const formatOptions = (options.formatOptions || {})[format] || {};
 
       if (format === 'png') {
@@ -517,9 +526,9 @@ const respondImage = (
           dither: formatOptions.dither,
         });
       } else if (format === 'jpeg') {
-        image.jpeg({ quality: formatOptions.quality || 80 });
+        image.jpeg({ quality: formatOptions.quality || formatQuality || 80 });
       } else if (format === 'webp') {
-        image.webp({ quality: formatOptions.quality || 90 });
+        image.webp({ quality: formatOptions.quality || formatQuality || 90 });
       }
       image.toBuffer((err, buffer, info) => {
         if (!buffer) {