Async Iterator Symbol

Async iterator symbol which specifies the default async iterator for an object.

Installation

npm install @stdlib/symbol-async-iterator

Usage

var AsyncIteratorSymbol = require( '@stdlib/symbol-async-iterator' );

AsyncIteratorSymbol

Async iterator symbol which specifies the default async iterator for an object.

var s = typeof AsyncIteratorSymbol;
// e.g., returns 'symbol'

Notes

• The symbol is only supported in environments which support symbols and async iterators. In non-supporting environments, the value is null.

Examples

var AsyncIteratorSymbol = require( '@stdlib/symbol-async-iterator' );

if ( AsyncIteratorSymbol === null ) {
    console.log( 'Environment does not support Symbol.asyncIterator.' );
} else {
    console.log( 'Environment does support Symbol.asyncIterator.' );
}

See Also

• @stdlib/symbol-ctor: symbols.
• @stdlib/symbol-iterator: symbol iterator.

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.

Copyright

Copyright © 2016-2024. The Stdlib Authors.