feat: make encode types easier to use

Author: stropitek

src/save/encode.ts

@@ -23,30 +23,9 @@ export interface EncodeOptionsJpeg {
 const defaultPng: EncodeOptionsPng = { format: 'png' };
 
 /**
- * Encodes the image to an output format.
- * Defaults to PNG.
+ * Encodes the image to the specified format
  * @param image - Image to encode.
- * @returns The encoded image.
- */
-export function encode(image: Image): Uint8Array;
-/**
- * Encodes the image to PNG.
- * @param image - Image to encode.
- * @param options - Format and options passed to the PNG encoder.
- * @returns The encoded image.
- */
-export function encode(image: Image, options: EncodeOptionsPng): Uint8Array;
-/**
- * Encodes the image to JPEG.
- * @param image - Image to encode.
- * @param options - Format and options passed to the JPEG encoder.
- * @returns The encoded image.
- */
-export function encode(image: Image, options: EncodeOptionsJpeg): Uint8Array;
-/**
- * Encode an image in JPEG or PNG format.
- * @param image - Image to encode.
- * @param options - Encoding options.
+ * @param options - Format and options passed to the encoder.
  * @returns The encoded image.
  */
 export function encode(

src/save/write.ts

@@ -2,14 +2,9 @@ import fs from 'node:fs';
 import nodePath from 'node:path';
 import url from 'node:url';
 
-import { Mask, Image } from '..';
+import { Image, Mask } from '..';
 
-import {
-  encode,
-  ImageFormat,
-  EncodeOptionsPng,
-  EncodeOptionsJpeg,
-} from './encode';
+import { encode, EncodeOptionsJpeg, EncodeOptionsPng } from './encode';
 
 export interface WriteOptions {
   /**
@@ -123,25 +118,16 @@ function getDataToWrite(
   image: Image,
   options?: WriteOptionsPng | WriteOptionsJpeg | WriteOptions,
 ): Uint8Array {
-  let format: ImageFormat;
   if (!options || !('format' in options)) {
     const extension = nodePath.extname(destinationPath).slice(1).toLowerCase();
-    if (extension === 'png') {
-      format = 'png';
-      return encode(image, { format });
-    } else if (extension === 'jpg' || extension === 'jpeg') {
-      format = 'jpg';
-      return encode(image, { format });
+    if (extension === 'png' || extension === 'jpg' || extension === 'jpeg') {
+      return encode(image, { format: extension });
     } else {
       throw new RangeError(
         'image format could not be determined from file extension. Use a supported extension or specify the format option',
       );
     }
-  } else if (options.format === 'png') {
-    return encode(image, options);
-  } else if (options.format === 'jpg' || options.format === 'jpeg') {
-    return encode(image, options);
   } else {
-    throw new RangeError(`invalid format: ${options.format}`);
+    return encode(image, options);
   }
 }