chore: docs for quality and format (#157)

supabase · Apr 9, 2023 · 2c3fcde · 2c3fcde
1 parent 3aa1b27
commit 2c3fcde
Showing 1 changed file with 5 additions and 3 deletions.
diff --git a/src/lib/types.ts b/src/lib/types.ts
@@ -96,14 +96,16 @@ export interface TransformOptions {
    */
   resize?: 'cover' | 'contain' | 'fill'
   /**
-   * Set the quality of the returned image, this is percentage based, default 80
+   * Set the quality of the returned image.
+   * A number from 20 to 100, with 100 being the highest quality.
+   * Defaults to 80
    */
   quality?: number
   /**
    * Specify the format of the image requested.
    *
-   * When using 'origin' we force the format to be the same as the original image,
-   * bypassing automatic browser optimisation such as webp conversion
+   * When using 'origin' we force the format to be the same as the original image.
+   * When this option is not passed in, images are optimized to modern image formats like Webp.
    */
   format?: 'origin'
 }