Package Exports

@stdlib/iter-empty

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@stdlib/iter-empty) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

iterEmpty

Create an empty iterator.

Installation

npm install @stdlib/iter-empty

Usage

var iterEmpty = require( '@stdlib/iter-empty' );

iterEmpty()

Returns an "empty" iterator (i.e., an iterator which never returns an iterated value).

var it = iterEmpty();
// returns <Object>

var bool = it.next().done;
// returns true

The returned iterator protocol-compliant object has the following properties:

next: function which returns an iterator protocol-compliant object containing the next iterated value (if one exists) assigned to a value property and a done property having a boolean value indicating whether the iterator is finished.
return: function which closes an iterator and returns a single (optional) argument in an iterator protocol-compliant object.

Notes

If an environment supports Symbol.iterator, the returned iterator is iterable.

Examples

var iterEmpty = require( '@stdlib/iter-empty' );

// Create an iterator:
var it = iterEmpty();

// Perform manual iteration...
var v;
while ( true ) {
    v = it.next();
    if ( v.done ) {
        console.log( 'done' );
        break;
    }
    // The following should never run...
    console.log( v.value );
}

Notice

This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.

For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.

Community

License

See LICENSE.

@stdlib/iter-empty