https://github.com/electron/node-minidump

Node module to process minidump files
https://github.com/electron/node-minidump

Last synced: 2 months ago
JSON representation

Node module to process minidump files

• Host: GitHub
• URL: https://github.com/electron/node-minidump
• Owner: electron
• License: mit
• Created: 2013-11-15T09:06:08.000Z (over 11 years ago)
• Default Branch: main
• Last Pushed: 2025-04-01T20:57:26.000Z (2 months ago)
• Last Synced: 2025-04-11T13:44:34.865Z (2 months ago)
• Language: JavaScript
• Homepage:
• Size: 447 KB
• Stars: 73
• Watchers: 19
• Forks: 44
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
# minidump - Process minidump files

[![Test](https://github.com/electron/node-minidump/actions/workflows/test.yml/badge.svg)](https://github.com/electron/node-minidump/actions/workflows/test.yml)

[![npm version](http://img.shields.io/npm/v/minidump.svg)](https://npmjs.org/package/minidump)

## Installing

```sh

npm install minidump

```

## Building (for development)

* `git clone --recurse-submodules https://github.com/electron/node-minidump`

* `npm install`

## Docs

```javascript

var minidump = require('minidump');

```

### minidump.addSymbolPath(path1, ..., pathN)

Add search paths for looking up symbol files.

### minidump.walkStack(minidumpFilePath, [symbolPaths, ]callback)

Get the stack trace from `minidumpFilePath`, the `callback` would be called

with `callback(error, report)` upon completion.

### minidump.dump(minidumpFilePath, callback)

Parse and dump the raw contents of the minidump as text using `minidump_dump`.

### minidump.dumpSymbol(binaryPath, callback)

Dump debug symbols in minidump format from `binaryPath`, the `callback` would

be called with `callback(error, minidump)` upon completion.