Package Exports
- @stdlib/symbol-iterator
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/symbol-iterator) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
Iterator Symbol
Iterator symbol which specifies the default iterator for an object.
Installation
npm install @stdlib/symbol-iterator
Usage
var IteratorSymbol = require( '@stdlib/symbol-iterator' );
IteratorSymbol
Iterator symbol
which specifies the default iterator for an object.
var s = typeof IteratorSymbol;
// e.g., returns 'symbol'
Notes
Examples
var IteratorSymbol = require( '@stdlib/symbol-iterator' );
var obj;
var v;
function iterator() {
var iter;
var i;
i = -1;
iter = {};
iter.next = next;
iter.return = done;
if ( IteratorSymbol ) {
// Allow the iterator to work with `for...of`:
iter[ IteratorSymbol ] = iterator;
}
return iter;
function next() {
i += 1;
return {
'value': i,
'done': false
};
}
function done( value ) {
if ( arguments.length === 0 ) {
return {
'done': true
};
}
return {
'value': value,
'done': true
};
}
}
obj = iterator();
while ( v === void 0 || ( v.value < 10 && v.done === false ) ) {
v = obj.next();
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.
License
See LICENSE.
Copyright
Copyright © 2016-2021. The Stdlib Authors.