# buffer-nexter

> A basic template for deving an ES6 app

Latest version **0.1.0** (published 2015-12-22) · MIT license · 0 weekly downloads

## Install

```sh
npm install buffer-nexter
pnpm add buffer-nexter
yarn add buffer-nexter
bun add buffer-nexter
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.0 |
| Published | 2015-12-22 |
| First published | 2015-12-22 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >0.12 |
| Dependencies | 3 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Ben Bradley |
| Maintainers | ben-bradley |

## Links

- npm: https://www.npmjs.com/package/buffer-nexter
- npm.io page: https://npm.io/package/buffer-nexter

## Dependencies (3)

- [q](https://npm.io/package/q.md) ^1.4.1
- [debug](https://npm.io/package/debug.md) ^2.2.0
- [config](https://npm.io/package/config.md) ^1.14.0

## Recent versions

- 0.1.0 (latest) — 2015-12-22

## README

# Buffer Nexter [![Build Status](https://secure.travis-ci.org/ben-bradley/buffer-nexter.png)](http://travis-ci.org/ben-bradley/buffer-nexter)


## About

Buffer Nexter will allow you to manually iterate a buffer based on an arbitrary separator (defaulting to `\n`).  Alternatively, you can stream the buffer based on the same separator.  The `next()` method behaves very similarly to an ES6 generator.


## Use

```javascript
import BufferNexter from 'buffer-nexter';

let lines = new Buffer('line1\nline2\line3');

let buf = new BufferNexter(lines);

console.log(buf.next()); // -> line1
console.log(buf.next()); // -> line2
console.log(buf.next()); // -> line3
console.log(buf.next()); // -> null
```


## Example

```
let buf = new BufferNexter(buffer[, options]);
```

### `buffer` (type: Buffer)

A standard buffer, typically a String, containing some value to use as a separator to iterate with.

### `options` (type: Object, optional)

- `separator` - The string value to use for iteration, default `\n`.
- `index` - The buffer index within the buffer to begin iteration, default `0`.
- `encoding` - The encoding type to use to read the buffer, default `utf8`.

### Code

```javascript
let buf = new BufferNexter('1,2,3', { separator: ',' });

console.log(buf.next()); // -> 1
console.log(buf.next()); // -> 2
console.log(buf.next()); // -> 3
console.log(buf.next()); // -> null
```


## Instance Methods

### `next()`

Calling `next()` will return the 'next' value from the provided buffer.

- Returns: `String` or `Null`

### `skip(n)`

This will call `next()` 'n' times and return `this` so you can chain `next()` calls.

- Returns: `this`

### `peek()`

This will give you a look at the 'next' value that will be returned on the subsequent `next()` call.

- Returns: `String` or `Null` without iterating

### `stream()`

This returns a `Readable` stream for piping or whatever you want to use a stream for.  The stream emits `data` events for each iteration of the buffer.

- Returns: `Stream.Readable`


## Static Methods

### `BufferNexter.readFile(file[, options])`

If you just want to read a file and iterate `next()` calls on `\n`, then this is the easiest way to do that.

- Returns: `Promise -> BufferNexter instance`

```javascript
/* sample.txt
foo
bar
baz
 */

import { readFile } from 'buffer-nexter';

readFile('sample.txt')
  .then((buf) => {
    console.log(buf.next()); // -> foo
    console.log(buf.next()); // -> bar
    console.log(buf.next()); // -> baz
  })
```

```javascript
/* sample.csv
foo,bar,baz
 */

import { readFile } from 'buffer-nexter';

readFile('sample.csv', { separator: ',' })
  .then((buf) => {
    console.log(buf.next()); // -> foo
    console.log(buf.next()); // -> bar
    console.log(buf.next()); // -> baz
  })
```

What about `readFileSync()`?  If there's a demand for it or if someone submits a PR, I'll add it, but I prefer to use `Promise`s wherever possible.


## Versions

- 0.1.0 - 20151222 - Added `static readFile()`
- 0.0.1 - 20151221 - Initial release


## Credits

- Mark - Thanks for the encouragement!

---
_Source: https://npm.io/package/buffer-nexter · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._