iterator-result

A basic iterator result.


Keywords
iterator, result, protocol, standard, done, next, value
License
Zlib
Install
npm install iterator-result@1.0.0

Documentation

Iterator Result

Build status NPM version Dependencies

The iterator protocol defines a standard way to produce a sequence of values. An object is an iterator when it implements a next() method which returns objects that have at least the two properties value and done. This module provides a base class for such iterator results.

API Reference

Installation

npm install iterator-result

Usage

import IteratorResult from "iterator-result";

export class InfiniteIterator {

	constructor() {

		this.result = new IteratorResult();

	}

	next() {

		return this.result;

	}

}

Contributing

Maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code.