🤖 Merge PR DefinitelyTyped#74558 fix(formidable): FormidableError became a default export in v3, add missing erorr codes, add emitting 'error' event by @pazaderey

Co-authored-by: Петр Задерей <zaderey@trueconf.ru>

Author: pazaderey

types/formidable/Formidable.d.ts

@@ -35,6 +35,7 @@ declare class IncomingForm extends EventEmitter {
     on(eventName: string, listener: () => void): this;
 
     emit(eventName: "data", data: EmitData): boolean;
+    emit(eventName: "error", error: any): boolean;
 
     /**
      * A method that allows you to extend the Formidable library. By default we include 4 plugins,

types/formidable/FormidableError.d.ts

@@ -6,7 +6,7 @@ declare class FormidableError extends Error {
 
 declare const errors:
     & {
-        FormidableError: typeof FormidableError;
+        default: typeof FormidableError;
     }
     & Record<
         | "missingPlugin"
@@ -17,13 +17,17 @@ declare const errors:
         | "filenameNotString"
         | "maxFieldsSizeExceeded"
         | "maxFieldsExceeded"
+        | "maxFilesExceeded"
         | "smallerThanMinFileSize"
         | "biggerThanMaxFileSize"
         | "noEmptyFiles"
         | "missingContentType"
         | "malformedMultipart"
         | "missingMultipartBoundary"
-        | "unknownTransferEncoding",
+        | "unknownTransferEncoding"
+        | "biggerThanTotalMaxFileSize"
+        | "pluginFailed"
+        | "cannotCreateDir",
         number
     >;
 

types/formidable/formidable-tests.ts

@@ -2,9 +2,11 @@ import formidable = require("formidable");
 import {
     defaultOptions,
     enabledPlugins,
+    errors as formidableErrors,
     File,
     Formidable,
     formidable as formidableAlias,
+    FormidableError,
     IncomingForm,
     json,
     multipart,
@@ -145,6 +147,11 @@ form.on("data", data => {
         bytesReceived;
         // $ExpectType number
         bytesExpected;
+
+        form.emit(
+            "error",
+            new formidableErrors.default("bytes received exceeded", formidableErrors.biggerThanTotalMaxFileSize, 400),
+        );
     })
     .on("field", (name, value) => {
         // $ExpectType string
@@ -233,3 +240,44 @@ querystring;
 multipart;
 // $ExpectType PluginFunction
 json;
+// $ExpectType number
+formidableErrors.missingPlugin;
+// $ExpectType number
+formidableErrors.pluginFunction;
+// $ExpectType number
+formidableErrors.aborted;
+// $ExpectType number
+formidableErrors.noParser;
+// $ExpectType number
+formidableErrors.uninitializedParser;
+// $ExpectType number
+formidableErrors.filenameNotString;
+// $ExpectType number
+formidableErrors.maxFieldsSizeExceeded;
+// $ExpectType number
+formidableErrors.maxFieldsExceeded;
+// $ExpectType number
+formidableErrors.maxFilesExceeded;
+// $ExpectType number
+formidableErrors.smallerThanMinFileSize;
+// $ExpectType number
+formidableErrors.biggerThanMaxFileSize;
+// $ExpectType number
+formidableErrors.noEmptyFiles;
+// $ExpectType number
+formidableErrors.missingContentType;
+// $ExpectType number
+formidableErrors.malformedMultipart;
+// $ExpectType number
+formidableErrors.missingMultipartBoundary;
+// $ExpectType number
+formidableErrors.unknownTransferEncoding;
+// $ExpectType number
+formidableErrors.biggerThanTotalMaxFileSize;
+// $ExpectType number
+formidableErrors.pluginFailed;
+// $ExpectType number
+formidableErrors.cannotCreateDir;
+
+// $ExpectType FormidableError
+new formidableErrors.default("invalid type", 0, 400);

types/formidable/index.d.ts

@@ -309,6 +309,8 @@ declare namespace formidable {
     type EnabledPlugins = {
         [P in Plugin]: PluginFunction;
     };
+
+    type FormidableError = InstanceType<typeof errors.default>;
 }
 
 declare const formidable: {

types/formidable/package.json

@@ -1,7 +1,7 @@
 {
     "private": true,
     "name": "@types/formidable",
-    "version": "3.4.9999",
+    "version": "3.5.9999",
     "projects": [
         "https://github.com/node-formidable/formidable"
     ],