Closes gulpjs#10

gucong3000 · Jan 23, 2018 · 87d0b3e · 87d0b3e
1 parent 4dfcef3
commit 87d0b3e
Showing 2 changed files with 33 additions and 0 deletions.
diff --git a/index.d.ts b/index.d.ts
@@ -19,6 +19,13 @@ declare namespace PluginError {
      */
     new <E extends Error>(plugin: string, error: E, options?: Options): PluginError<E>;
 
+    /**
+     * @param plugin Plugin name
+     * @param error Base error / Error message
+     * @param options Error options
+     */
+    new <E extends Error>(plugin: string, error: E | string, options?: Options): PluginError<E | {[K in keyof E]: undefined}>;
+
     /**
      * @param plugin Plugin name
      * @param options Options with message

diff --git a/test/types/test.ts b/test/types/test.ts
@@ -51,3 +51,29 @@ import PluginError = require("plugin-error");
   }
 }
 
+{
+  const PLUGIN_NAME = 'test'
+
+  function createPluginError(err: Error | string) {
+    return new PluginError(PLUGIN_NAME, err);
+  }
+}
+
+{
+  // Inference with union type on second parameter
+  const PLUGIN_NAME = "test";
+
+  interface FooError extends Error {
+    foo: number;
+  }
+
+  function createPluginError(err: FooError | string) {
+    return new PluginError(PLUGIN_NAME, err);
+  }
+
+  const fooError: FooError = Object.assign(new Error("something broke"), {foo: 1});
+  const pluginError = createPluginError(fooError);
+  if (pluginError.foo !== undefined) {
+    const foo: number = pluginError.foo;
+  }
+}