# token-stream

> Take an array of token and produce a more useful API to give to a parser

Latest version **1.0.0** (published 2016-06-01) · MIT license · 0 weekly downloads

## Install

```sh
npm install token-stream
pnpm add token-stream
yarn add token-stream
bun add token-stream
```

## Health

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

Positive: has types package; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2016-06-01 |
| First published | 2014-11-20 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | separate (@types/token-stream) |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 12 |
| Author | ForbesLindesay |
| Maintainers | alubbe, bloodyowl, forbeslindesay, jbnicolai, timothygu |

## Links

- npm: https://www.npmjs.com/package/token-stream
- Repository: https://github.com/pugjs/token-stream
- Homepage: https://github.com/pugjs/token-stream#readme
- Issues: https://github.com/pugjs/token-stream/issues
- npm.io page: https://npm.io/package/token-stream

## Recent versions

- 1.0.0 (latest) — 2016-06-01
- 0.0.1 — 2014-11-20

## README

# token-stream

Take an array of token and produce a more useful API to give to a parser.

[![Build Status](https://img.shields.io/travis/pugjs/token-stream/master.svg)](https://travis-ci.org/pugjs/token-stream)
[![Dependency Status](https://img.shields.io/david/pugjs/token-stream.svg)](https://david-dm.org/pugjs/token-stream)
[![NPM version](https://img.shields.io/npm/v/token-stream.svg)](https://www.npmjs.org/package/token-stream)

## Installation

    npm install token-stream

## Usage

```js
var TokenStream = require('token-stream');

var stream = new TokenStream([
  'a',
  'b',
  'c',
  'd'
]);
assert(stream.peek() === 'a');
assert(stream.lookahead(0) == 'a');
assert(stream.lookahead(1) == 'b');

assert(stream.advance() === 'a');
assert(stream.peek() === 'b');
assert(stream.lookahead(0) == 'b');
assert(stream.lookahead(1) == 'c');

stream.defer('z');
assert(stream.peek() === 'z');
assert(stream.lookahead(0) == 'z');
assert(stream.lookahead(1) == 'b');
assert(stream.advance() === 'z');
assert(stream.advance() === 'b');
assert(stream.advance() === 'c');
assert(stream.advance() === 'd');

// an error is thrown if you try and advance beyond the end of the stream
assert.throws(function () {
  stream.advance();
});
```

## API

### stream.peek()

Gets and returns the next item in the stream without advancing the stream's position.

### stream.advance()

Returns the next item in the stream and advances the stream by one item.

### stream.defer(token)

Put a token on the start of the stream (useful if you need to back track after calling advance).

### stream.lookahead(index)

Return the item at `index` position from the start of the stream, but don't advance the stream.  `stream.lookahead(0)` is equivalent to `stream.peek()`.

## License

  MIT

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