https://github.com/bugsplat-git/node-minidump-stackwalk
Node.js wrapper for calling Breakpad's minidump-stackwalk
https://github.com/bugsplat-git/node-minidump-stackwalk
breakpad crash-reporting crashpad minidump minidumpstackwalk
Last synced: 6 months ago
JSON representation
Node.js wrapper for calling Breakpad's minidump-stackwalk
- Host: GitHub
- URL: https://github.com/bugsplat-git/node-minidump-stackwalk
- Owner: BugSplat-Git
- License: mit
- Created: 2023-05-18T17:05:41.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-11-27T00:32:44.000Z (about 1 year ago)
- Last Synced: 2025-02-28T22:16:12.522Z (10 months ago)
- Topics: breakpad, crash-reporting, crashpad, minidump, minidumpstackwalk
- Language: TypeScript
- Homepage: https://bugsplat.com
- Size: 10.1 MB
- Stars: 1
- Watchers: 4
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://bugsplat.com)
#
BugSplat
### **Crash and error reporting built for busy developers.**
## 👋 Introduction
node-minidump-stackwalk is a thin wrapper around the [Breakpad](https://chromium.googlesource.com/breakpad/breakpad/) minidump_stackwalk utility that allows minidump_stackwalk to be added to your project via [npm](https://www.npmjs.com/). This package can be invoked via the `node-minidump-stackwalk` command-line command, or used as a library by importing `minidumpStackwalk`.
## 🏗️ Installation
Install `node-minidump-stackwalk` as a package dependency.
```sh
npm i node-minidump-stackwalk
```
Or install `node-minidump-stackwalk` globally as a command-line tool.
```sh
npm i -g node-minidump-stackwalk
```
## 🧑💻 Command
If you installed `node-minidump-stackwalk` globally you can invoke it in via a terminal window.
```sh
node-minidump-stackwalk [-p ] [-m] [-s] [-c] [-b] [-v]
```
The first argument is the path to your minidump file. The second argument is a path or array of paths to search for sym files. Specify a platform with `-p `. Valid platforms are `darwin`, and `bullseye`. You can also specify the `-m`, `-s`, `-c`, and `-b` minidump_stackwalk arguments. The `-v` argument will print stderr to the terminal.
For additional platform support, please [open an issue](https://github.com/BugSplat-Git/node-minidump-stackwalk/issues/new).
## 📚 Library
Import or require `minidumpStackwalk`.
```ts
import { minidumpStackwalk, minidumpStackwalkSync } from 'node-minidump-stackwalk'
```
Await a call to `minidumpStackwalk`, providing it a path to your minidump file, and an array of symbol folder paths, and optionally the platform you're running on as well as options to forward to the minidump_stackwalk executable.
```ts
const options: MinidumpStackwalkOptions = {
machineReadable: true,
stackContents: false,
dumpingThreadOnly: false,
threadBrief: falst
};
await minidumpStackwalk('/path/to/minidump.dmp', ['/path/to/symbols'], 'darwin', options);
```
You can also call `minidumpStackwalkSync` to perform the same operation synchronously.
```ts
minidumpStackwalkSync('/path/to/minidump.dmp', ['/path/to/symbols'], 'darwin', options);
```
## 🐛 About
[BugSplat](https://bugsplat.com) is a software crash and error reporting service with support for [Qt](https://docs.bugsplat.com/introduction/getting-started/integrations/cross-platform/qt), [Linux](https://docs.bugsplat.com/introduction/getting-started/integrations/desktop/linux), [Android](https://docs.bugsplat.com/introduction/getting-started/integrations/mobile/android) and [many more](https://docs.bugsplat.com/introduction/getting-started/integrations). BugSplat automatically captures critical diagnostic data such as stack traces, log files, and other runtime information. BugSplat also provides automated incident notifications, a convenient dashboard for monitoring trends and prioritizing engineering efforts, and integrations with popular development tools to maximize productivity and ship more profitable software.