feat: Add TypeScript type definition file (#12)

Co-authored-by: Jordan Mele <jordan.mele@4mation.com.au>

index.d.ts

@@ -0,0 +1,36 @@
+/**
+ * Highest log level. Typically used for debugging purposes.
+ *
+ * If the first argument is a string, all arguments are passed to node's util.format() before being emitted.
+ * @param msg Message to log
+ * @param args Arguments to format message with via util.format()
+ */
+export function debug(msg: string, ...args: any[]): void;
+export function debug(msg: any): void;
+/**
+ * Standard log level. Typically used for user information.
+ *
+ * If the first argument is a string, all arguments are passed to node's util.format() before being emitted.
+ * @param msg Message to log
+ * @param args Arguments to format message with via util.format()
+ */
+export function info(msg: string, ...args: any[]): void;
+export function info(msg: any): void;
+/**
+ * Warning log level. Typically used for warnings.
+ *
+ * If the first argument is a string, all arguments are passed to node's util.format() before being emitted.
+ * @param msg Message to log
+ * @param args Arguments to format message with via util.format()
+ */
+export function warn(msg: string, ...args: any[]): void;
+export function warn(msg: any): void;
+/**
+ * Error log level. Typically used when things went horribly wrong.
+ *
+ * If the first argument is a string, all arguments are passed to node's util.format() before being emitted.
+ * @param msg Message to log
+ * @param args Arguments to format message with via util.format()
+ */
+export function error(msg: string, ...args: any[]): void;
+export function error(msg: any): void;

package.json

@@ -10,6 +10,7 @@
     "node": ">= 0.10"
   },
   "main": "index.js",
+  "types": "index.d.ts",
   "files": [
     "LICENSE",
     "index.js"