Add type definitions for TypeScript (#70)

Closes #48

Signed-off-by: Jon Koops <[email protected]>

README.md

@@ -19,7 +19,7 @@ npm i [email protected] -g
 ## Usage
 
 ```js
-import why from 'why-is-node-running' // should be your first import
+import whyIsNodeRunning from 'why-is-node-running' // should be your first import
 import net from 'node:net'
 
 function createServer () {
@@ -32,7 +32,7 @@ createServer()
 createServer()
 
 setTimeout(function () {
-  why() // logs out active handles that are keeping node running
+  whyIsNodeRunning() // logs out active handles that are keeping node running
 }, 100)
 ```
 

example.js

@@ -1,4 +1,4 @@
-import why from './index.js'
+import whyIsNodeRunning from './index.js'
 import net from 'node:net'
 
 function createServer () {
@@ -11,5 +11,5 @@ createServer()
 createServer()
 
 setTimeout(function () {
-  why()
+  whyIsNodeRunning()
 }, 100)

include.js

@@ -1,4 +1,4 @@
-import why from './index.js'
+import whyIsNodeRunning from './index.js'
 import siginfo from 'siginfo'
 
-siginfo(why, true)
+siginfo(whyIsNodeRunning, true)

index.d.ts

@@ -0,0 +1,25 @@
+/**
+ * An interface that can be implemented to customize how information is logged. For example:
+ *
+ * ```ts
+ * import whyIsNodeRunning, { type Logger } from 'why-is-node-running'
+ * 
+ * const logger: Logger = {
+ *   error(message) {
+ *     console.error(message)
+ *   }
+ * }
+ * 
+ * whyIsNodeRunning(logger)
+ * ```
+ */
+export interface Logger {
+  error(message: string): void
+}
+
+/**
+ * Logs the locations of all the active handles that prevent Node.js from exiting.
+ * 
+ * @param logger An optional {@link Logger} to use for logging messages. If not provided, the console will be used.
+ */
+export default function whyIsNodeRunning(logger?: Logger): void

package.json

@@ -4,7 +4,10 @@
   "version": "3.0.0",
   "description": "Node is running but you don't know why? why-is-node-running is here to help you.",
   "exports": {
-    ".": "./index.js",
+    ".": {
+      "types": "./index.d.ts",
+      "default": "./index.js"
+    },
     "./include": "./include.js"
   },
   "dependencies": {