Add new error type—"resulting image is too large"

screenshotone · Nov 10, 2024 · 9143303 · 9143303
1 parent 7bb18ed
commit 9143303
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 1 deletion.
diff --git a/package.json b/package.json
@@ -1,7 +1,7 @@
 {
   "name": "screenshotone-errors",
   "homepage": "https://screenshotone.com",
-  "version": "1.0.14",
+  "version": "1.0.15",
   "description": "Errors produced by the ScreenshotOne API.",
   "repository": {
     "type": "git",

diff --git a/src/main.ts b/src/main.ts
@@ -19,6 +19,7 @@ export enum ErrorCode {
     StorageReturnedTransientError = "storage_returned_transient_error",
     ContentContainsSpecifiedString = "content_contains_specified_string",
     TemporaryUnavailable = "temporary_unavailable",
+    ResultingImageTooLarge = "resulting_image_too_large",
 }
 
 interface APIError {
@@ -39,6 +40,15 @@ const allErrors: Record<ErrorCode, APIError> = {
         documentationUrl:
             "https://screenshotone.com/docs/errors/selector-not-found/",
     },
+    [ErrorCode.ResultingImageTooLarge]: {
+        httpStatusCode: 400,
+        title: "Resulting Image Too Large",
+        code: "resulting_image_too_large",
+        description:
+            "The resulting image is too large for the specified format.",
+        documentationUrl:
+            "https://screenshotone.com/docs/errors/resulting-image-too-large/",
+    },
     [ErrorCode.NameNotResolved]: {
         httpStatusCode: 400,
         title: "Name Not Resolved",