feat: add typescript definition (#34)

Author: pd4d10

index.d.ts

@@ -0,0 +1,41 @@
+/**
+ * Add search paths for looking up symbol files.
+ */
+export function addSymbolPath(...paths: string[]): void
+
+/**
+ * Get the stack trace from `minidumpFilePath`
+ * The `callback` would be called with `callback(error, report)` upon completion.
+ */
+export function walkStack(
+  minidump: string,
+  callback: (err: Error, result: string) => void,
+  commandArgs?: string[]
+): void
+export function walkStack(
+  minidump: string,
+  symbolPaths: string[],
+  callback: (err: Error, result: string) => void,
+  commandArgs?: string[]
+): void
+
+/**
+ * Dump debug symbols in minidump format from `binaryPath`
+ * The `callback` would be called with `callback(error, minidump)` upon completion.
+ */
+export function dumpSymbol(
+  binaryPath: string,
+  callback: (err: Error, result: string) => void
+): void
+
+type ModuleInfo = {
+  version: string
+  name: string
+  pdb_file_name?: string
+  debug_identifier?: string
+}
+
+export function moduleList(
+  minidump: string,
+  callback: (err: Error, result: ModuleInfo[]) => void
+): void

package.json

@@ -6,6 +6,7 @@
   "bin": {
     "minidump_stackwalk": "bin/minidump_stackwalk"
   },
+  "types": "index.d.ts",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -29,6 +30,7 @@
     "LICENSE.md",
     "README.md",
     "/bin",
-    "/lib"
+    "/lib",
+    "index.d.ts"
   ]
 }