https://github.com/floatdrop/node-parsetrace
Minimal library for parsing and printing node stacktrace
https://github.com/floatdrop/node-parsetrace
Last synced: about 1 year ago
JSON representation
Minimal library for parsing and printing node stacktrace
- Host: GitHub
- URL: https://github.com/floatdrop/node-parsetrace
- Owner: floatdrop
- License: mit
- Created: 2014-01-02T07:53:56.000Z (over 12 years ago)
- Default Branch: master
- Last Pushed: 2014-07-14T16:35:53.000Z (almost 12 years ago)
- Last Synced: 2025-03-12T20:37:26.743Z (about 1 year ago)
- Language: JavaScript
- Size: 297 KB
- Stars: 10
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# node-parsetrace [![NPM version][npm-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Dependency Status][depstat-image]][depstat-url]
Minimal library for parsing and printing node stacktrace. Mostly for use in [express-error-with-sources](https://github.com/floatdrop/express-error-with-sources).
## Installation
`npm install --save parsetrace`
## Example
```javascript
var parsetrace = require('parsetrace');
try {
throw new Error('My cool error');
} catch (e) {
console.log(parsetrace(e, { sources: true }).json());
}
```
## API
### parsetrace(error, [options], [callback])
Parses stack trace from `Error`, `string` or `object`, that have `.stack` and `.message` property.
If callback is passed - all source code fetching will be async and error will be passed to it (even if `strict` is `true`).
```javascript
parsetrace(err, function(error, trace) {
console.log(trace.toString());
});
```
__Options__:
* `sources` - fetch source code from files, that are mentioned in stacktrace. If file can not be found or readed - sources will be fetched silently (unless you enabled `strict` option) (default: `false`)
* `strict` - throws errors, while parsing stacktrace and fetching source code (default: `false`)
* `contextSize` - number of lines before and after the error line (default: `3`)
__Returns__ `Object` with methods described below:
### json()
```json
{
"error": "My cool error",
"frames": [
{
"line": 4,
"column": 11,
"function": "Object.",
"file": "/full/path/to/file.js",
"source": {
"2": { "code": "" },
"3": { "code": "try {" },
"4": { "code": " throw new Error('My cool error');" },
"5": { "code": "} catch (e) {" },
"6": { "code": " console.log(parsetrace(e).json());" }
}
}
]
}
```
__Returns__ stacktrace as Json string
### object()
Format of object you can see in `json()` section.
__Returns__ stacktrace as Object
### toString([options])
__Options__:
* `excludeSources` - if stacktrace was parsed with sources, this will exclude them from output (default: `false`)
__Returns__ stacktrace as NodeJS formatted stacktracke string.
[npm-url]: https://npmjs.org/package/parsetrace
[npm-image]: https://badge.fury.io/js/parsetrace.png
[travis-url]: http://travis-ci.org/floatdrop/node-parsetrace
[travis-image]: https://secure.travis-ci.org/floatdrop/node-parsetrace.png?branch=master
[depstat-url]: https://david-dm.org/floatdrop/node-parsetrace
[depstat-image]: https://david-dm.org/floatdrop/node-parsetrace.png