token-stream

WebJar for token-stream

License	MIT
GroupId	org.webjars.npm
ArtifactId	token-stream
Last Version	0.0.1
Release Date	Jul 4, 2018
Type	jar
Description	token-stream WebJar for token-stream
Project URL	http://webjars.org
Source Code Management	https://github.com/pugjs/token-stream

Download token-stream

Filename	Size
token-stream-0.0.1.pom
token-stream-0.0.1.jar	5 KB
token-stream-0.0.1-sources.jar	22 bytes
token-stream-0.0.1-javadoc.jar	22 bytes

How to add to project

Apache Maven

<!-- https://jarcasting.com/artifacts/org.webjars.npm/token-stream/ -->
<dependency>
    <groupId>org.webjars.npm</groupId>
    <artifactId>token-stream</artifactId>
    <version>0.0.1</version>
</dependency>

Gradle Groovy

// https://jarcasting.com/artifacts/org.webjars.npm/token-stream/
implementation 'org.webjars.npm:token-stream:0.0.1'

Gradle Kotlin

// https://jarcasting.com/artifacts/org.webjars.npm/token-stream/
implementation ("org.webjars.npm:token-stream:0.0.1")

Apache Buildr

'org.webjars.npm:token-stream:jar:0.0.1'

Apache Ivy

<dependency org="org.webjars.npm" name="token-stream" rev="0.0.1">
  <artifact name="token-stream" type="jar" />
</dependency>

Groovy Grape

@Grapes(
@Grab(group='org.webjars.npm', module='token-stream', version='0.0.1')
)

Scala SBT

libraryDependencies += "org.webjars.npm" % "token-stream" % "0.0.1"

Leiningen

[org.webjars.npm/token-stream "0.0.1"]

Dependencies

There are no dependencies for this project. It is a standalone project that does not depend on any other jars.

Project Modules

There are no modules declared in this project.

token-stream

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

Installation

npm install token-stream

Usage

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

Pug

Versions

Version
0.0.1 Jul 4, 2018