source-mapper/README.md

Replace strack traces with original sources using source maps

# Source Mapper

[![Build Status]](https://travis-ci.org/mantoni/source-mapper.js)
[![SemVer]](http://semver.org)
[![License]](https://github.com/mantoni/source-mapper.js/blob/master/LICENSE)

Replace stack traces with original sources using [source-map][]. For node and
the browser.

## Install

```
npm install source-mapper
```

## Usage

```js
var sourceMapper = require('source-mapper');

var extracted = sourceMapper.extract(js);
var throughStream = sourceMapper.stream(extracted.map);
```

## API

- `extract(string)` extracts an inline source map from the given string. The
  returned object has the `js` without source maps and a `map` with source
  maps.
- `consumer(map)` returns a source map consumer for the given `map`.
- `line(consumer, line[, offset])` maps the given line to the original source
  using a consumer. If `offset` is given, it is substracted from the line
  number.
- `stream(consumer[, offset])` returns a [through2][] stream that replaces URLs
  in stack traces with the original source location using a consumer. If
  `offset` is given, it is substracted from the line number.
- `stream(map[, offset])` returns a [through2][] stream that replaces URLs in
  stack traces with the original source location using a source map. If
  `offset` is given, it is substracted from the line number.

## Development

Clone the repository and then run:

```
npm install
npm test
```

## Compatibility

- Node 0.10 or later
- Browserify 5.9 or later

## License

MIT

[Build Status]: https://img.shields.io/travis/mantoni/source-mapper.js.svg
[SemVer]: https://img.shields.io/:semver-%E2%9C%93-brightgreen.svg
[License]: https://img.shields.io/npm/l/source-mapper.svg
[source-map]: https://github.com/mozilla/source-map
[through2]: https://github.com/rvagg/through2