docs: ✏️ Add convertFormat to the configuration page

Author: dc7290

docs/docs/configuration.md

@@ -99,3 +99,30 @@ Specifically, include the name, width, quality, and extension in the return valu
 
 You can set optimization options for each extension.  
 Please refer to the official sharp documentation for more information.
+
+### `convertFormat`
+
+**Available from ver. 1.2.0.**
+
+- Type: Array<Array<Format, Format>>  
+  Format → "jpeg" | "jpg" | "png" | "webp" | "avif"
+
+It allows you to convert images from any extension to another extension.
+
+e.g.
+
+```js
+const config = {
+  convertFormat: [
+    ['png', 'webp'],
+    ['jpg', 'avif'],
+  ],
+}
+```
+
+```jsx
+<Image src="/img.png" width={1280} height={640} alt="" />
+<Image src="/img.jpg" width={1280} height={640} alt="" />
+```
+
+The original image will be kept, `img.png` will be converted to webp format and `img.jpg` will be converted to avif format and output to the directory.

docs/docs/planned-features.md

@@ -9,18 +9,6 @@ description: This page is to introduce examples of use.
 
 We are planning the ability to save external images locally when they are specified.
 
-## Convert to specified format
-
-We plan to have the ability to convert to a specified format.
-
-For example, to convert to webp, the following configuration is used.
-
-```js title="export-images.config.js"
-module.exports = {
-  convertFormat: 'webp',
-}
-```
-
 :::caution
 This API is in the planning stage and is subject to change in practice.
 :::

src/utils/getConfig.ts

@@ -43,7 +43,7 @@ export type Config = {
    * You can set optimization options for each extension.
    * Please refer to the official sharp documentation for more information.
    *
-   * @type {{ png?: import('sharp').PngOptions, jpg?: import('sharp').JpegOptions, webp?: import('sharp').WebpOptions, avif?: import('sharp').AvifOptions } }}
+   * @type {{ png?: PngOptions, jpg?: JpegOptions, webp?: WebpOptions, avif?: AvifOptions } }}
    */
   sharpOptions?: {
     png?: PngOptions
@@ -53,6 +53,8 @@ export type Config = {
   }
   /**
    * It allows you to convert images from any extension to another extension.
+   *
+   * @type {[beforeConvert: AllowedFormat, afterConvert: AllowedFormat][]}
    */
   convertFormat?: [beforeConvert: AllowedFormat, afterConvert: AllowedFormat][]
 }