# log-reader

**Repository Path**: mirrors_mapbox/log-reader

## Basic Information

- **Project Name**: log-reader
- **Description**: simply read text-based log files in node and emit streams of data
- **Primary Language**: Unknown
- **License**: BSD-2-Clause
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-08-09
- **Last Updated**: 2025-11-01

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# log-reader


## API

`reader = LogReader(filename)`

Initialize a log reader given the specified filename.

`reader.read(callback, depth)`

Start to read the log into a stream. `depth` allows you to stream less
than all of the log. Calls `callback` with `err, path`.

## Example

```js
var reader = new LogReader(options.log).read();

return function(cb) {
    reader.read(function(err, path) {
        if (err) throw err;
        return cb(formatter(path));
    });
};
```