fixed possible value in resizing_type option (from fill_down to fill-…

…down)

.github/templates/ISSUE.md

@@ -3,5 +3,6 @@ title: Usage docs of imgproxy have been updated
 assignees: Alqanar
 labels: enhancement
 ---
+
 @{{ payload.client_payload.actor }} has just updated the [Usage](https://docs.imgproxy.net/category/usage) part of the documentation.
 Please, check [the difference]({{ payload.client_payload.link }}) and make the necessary changes.

src/options/resize.ts

@@ -11,7 +11,7 @@ const correctTypes = {
   fit: true,
   fill: true,
   auto: true,
-  fill_down: true,
+  "fill-down": true,
   force: true,
 };
 

src/options/resizingType.ts

@@ -7,7 +7,7 @@ import { guardIsUndef, guardIsValidVal } from "../utils";
 const correctValues = {
   fit: true,
   fill: true,
-  fill_down: true,
+  "fill-down": true,
   force: true,
   auto: true,
 };

src/types/resize.ts

@@ -9,7 +9,7 @@ import { ResizingType } from "./resizingType";
  *
  * - `fit`: resizes the image while keeping aspect ratio to fit a given size. (**default value**)
  * - `fill`: resizes the image while keeping aspect ratio to fill a given size and crops projecting parts.
- * - `fill_down`: the same as fill, but if the resized image is smaller than the requested size,
+ * - `fill-down`: the same as fill, but if the resized image is smaller than the requested size,
  * imgproxy will crop the result to keep the requested aspect ratio.
  * - `force`: resizes the image without keeping the aspect ratio.
  * - `auto`: if both source and resulting dimensions have the same orientation (portrait or landscape),

src/types/resizingType.ts

@@ -7,7 +7,7 @@
  *
  * `fill`: resizes the image while keeping aspect ratio to fill a given size and crops projecting parts.
  *
- * `fill_down`: the same as fill, but if the resized image is smaller than the requested size,
+ * `fill-down`: the same as fill, but if the resized image is smaller than the requested size,
  * imgproxy will crop the result to keep the requested aspect ratio.
  *
  * `force`: resizes the image without keeping the aspect ratio.
@@ -19,7 +19,7 @@
  *
  * @see https://docs.imgproxy.net/generating_the_url?id=resizing-type
  */
-type ResizingType = "fit" | "fill" | "fill_down" | "force" | "auto";
+type ResizingType = "fit" | "fill" | "fill-down" | "force" | "auto";
 
 /**
  * *Resizing type option*

tests/optionsBasic/resize.test.ts

@@ -24,7 +24,7 @@ describe("resize", () => {
     it("should return an error if resizing_type is incorrect", () => {
       // @ts-expect-error: Let's ignore an error (check for users with vanilla js).
       expect(() => build({ resize: { resizing_type: "fill-up" } })).toThrow(
-        "resize.resizing_type is invalid. Valid values are: fit, fill, auto, fill_down, force"
+        "resize.resizing_type is invalid. Valid values are: fit, fill, auto, fill-down, force"
       );
     });
 
@@ -68,10 +68,10 @@ describe("resize", () => {
       );
     });
 
-    it("should return rs:fill_down:::t if resizing_type is 'fill_down' and enlarge is true, other parametres are undefined", () => {
+    it("should return rs:fill-down:::t if resizing_type is 'fill-down' and enlarge is true, other parametres are undefined", () => {
       expect(
-        build({ rs: { resizing_type: "fill_down", enlarge: true } })
-      ).toEqual("rs:fill_down:::t");
+        build({ rs: { resizing_type: "fill-down", enlarge: true } })
+      ).toEqual("rs:fill-down:::t");
     });
 
     it("should return rs::::t:t if enlarge and extend are 't'", () => {

tests/optionsBasic/resizingType.test.ts

@@ -21,10 +21,10 @@ describe("resizingType", () => {
       expect(() => build({})).toThrow("resizing_type option is undefined");
     });
 
-    it("should throw an error if resizing_type is not one of 'fit', 'fill', 'fill_down', 'force', 'auto'", () => {
+    it("should throw an error if resizing_type is not one of 'fit', 'fill', 'fill-down', 'force', 'auto'", () => {
       // @ts-expect-error: Let's ignore an error (check for users with vanilla js).
       expect(() => build({ resizing_type: "foo" })).toThrow(
-        "resizing_type option is invalid. Valid values are: fit, fill, fill_down, force, auto"
+        "resizing_type option is invalid. Valid values are: fit, fill, fill-down, force, auto"
       );
     });