https://github.com/hex7c0/startline

stream readline with starting point for Nodejs
https://github.com/hex7c0/startline

nodejs startline

Last synced: about 1 month ago
JSON representation

stream readline with starting point for Nodejs

• Host: GitHub
• URL: https://github.com/hex7c0/startline
• Owner: hex7c0
• License: gpl-3.0
• Created: 2014-07-08T09:15:50.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2023-04-04T09:57:42.000Z (almost 2 years ago)
• Last Synced: 2024-11-21T07:38:56.344Z (about 1 month ago)
• Topics: nodejs, startline
• Language: JavaScript
• Homepage: https://github.com/hex7c0/startline
• Size: 197 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# [startline](https://github.com/hex7c0/startline)

[![NPM version](https://img.shields.io/npm/v/startline.svg)](https://www.npmjs.com/package/startline)

[![Linux Status](https://img.shields.io/travis/hex7c0/startline.svg?label=linux-osx)](https://travis-ci.org/hex7c0/startline)

[![Dependency Status](https://img.shields.io/david/hex7c0/startline.svg)](https://david-dm.org/hex7c0/startline)

[![Coveralls](https://img.shields.io/coveralls/hex7c0/startline.svg)](https://coveralls.io/r/hex7c0/startline)

Stream readline with starting and ending point for [nodejs](http://nodejs.org/).

You can even encode a file with [rc4](https://github.com/hex7c0/arc4) cipher, or [autokey](https://github.com/hex7c0/autokey).

## Installation

Install through NPM

```bash

npm install startline

```

or

```bash

git clone git://github.com/hex7c0/startline.git

```

## API

inside nodejs project

```js

var readline = startline({

  file: 'lorem.txt'

});

readline.on('line',function(line) {

  console.log(line);

});

```

### Methods

get head of string (bytes red)

```js

readline.head

```

get tail of string

```js

readline.tail

```

restart reading (building a new Class)

```js

readline.read(start, end)

```

### startline(options)

#### options

 - `file` - **String** Path of file *(required)*

 - `arc4` - **String** Password for reading a encrypted file with [rc4](https://github.com/hex7c0/arc4) *(default "disabled")*

 - `autokey` - **String** Password for reading a encrypted file with [autokey](https://github.com/hex7c0/autokey) *(default "disabled")*

 - `encoding` - **utf8 | ascii | base64 | null** File encoding *(default "null")*

 - `mode` - **String** File permission *(default "444")*

 - `start` - **Integer** Starting bytes *(default "starting file")*

 - `end` - **Integer** Ending bytes *(default "entire file")*

 - `autoClose` - **Boolean** If file descriptor will be closed automatically *(default "true")*

 - `lodash` - **Boolean** Use lodash library with encrypted file *(default "disabled")*

related to http://nodejs.org/api/fs.html#fs_fs_createreadstream_path_options

## Examples

Take a look at my [examples](examples)

### [License GPLv3](LICENSE)