node-rs-minidump

Node.js native binding for rust-minidump. Useful if you want to parse minidump files in node.js(or electron app) environment.

Currently it is still in early development, only some of the functionalities supported, see Usage section below.

Install

Most of the cases, you can install node-rs-minidump directly, the package manager will choose a suitable prebuilt binary for you:

$ yarn add node-rs-minidump

However, if you want to ensure that all prebuilt binaries are included, for example, when building electron app that the development environment is not the same with the distribution environment, you can use node-rs-minidump-combined for replacement:

$ yarn add node-rs-minidump-combined

Usage

import { getCrashpadInfo } from 'node-rs-minidump';

const dumpFile = '/path/to/some/minidump-file.dmp';
const info = getCrashpadInfo(dumpFile);
console.log(info);

Support matrix

| | node14 | node16 | node18 | | ----------- | ------ | ------ | ------ | | Windows x64 | ✓ | ✓ | ✓ | | Windows x32 | ✓ | ✓ | ✓ | | macOS x64 | ✓ | ✓ | ✓ | | macOS arm64 | ✓ | ✓ | ✓ |

Develop requirements

• Install the latest Rust
• Install Node.js@18
• Install yarn@4

Test in local

$ yarn
$ yarn build
$ yarn test

Release package

$ npm version [<newversion> | major | minor | patch | premajor | preminor | prepatch | prerelease [--preid=<prerelease-id>] | from-git]
$ git push