# cat-tail

**Repository Path**: mirrors_limulus/cat-tail

## Basic Information

- **Project Name**: cat-tail
- **Description**: Get a readable stream spanning an array of files from a given position
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-08-09
- **Last Updated**: 2026-04-04

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# cat-tail

Get a readable stream spanning an array of files from a given position

## Installation

```
npm install cat-tail
```

## API

```javascript
var CatTail = require("cat-tail")
```

### Constructor `new CatTail(files, [options])`

Instantiates a new `CatTail` object, which is a `Readable` stream object. It will immediately open the files in the given `files` array, reading them in order and pushing them into the stream. The `options` argument takes the standard properties for readable streams, plus the following:

  - `start`: Starting byte offset to begin reading from in the first file.
  - `end`: Byte position in the last file where reading should stop.

## Contributing

Patches are welcome! This module uses ES2015. To compile the source, use `npm run compile`. All changes need test coverage. To run the tests, use `npm test`.