time-to-botec/squiggle/node_modules/@stdlib/symbol/async-iterator/README.md

Async Iterator Symbol

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

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.' );
}