forEach

Invokes a function for each UTF-16 code unit in a string.

Installation

npm install @stdlib/string-base-for-each

Usage

var forEach = require( '@stdlib/string-base-for-each' );

forEach( str, clbk[, thisArg ] )

Invokes a function for each UTF-16 code unit in a string.

function log( value, index ) {
    console.log( '%d: %s', index, value );
}

forEach( 'Beep!', log );
/* =>
    0: B
    1: e
    2: e
    3: p
    4: !
*/

The invoked function is provided three arguments:

• value: character.
• index: character index.
• str: input string.

To set the function execution context, provide a thisArg.

function clbk() {
    this.count += 1;
}

var str = '👉🏿';

var ctx = {
    'count': 0
};

forEach( str, clbk, ctx );

var cnt = ctx.count;
// returns 4

Examples

var forEach = require( '@stdlib/string-base-for-each' );

function log( value, index ) {
    console.log( '%d: %s', index, value );
}

forEach( 'presidential election', log );
forEach( 'Iñtërnâtiônàlizætiøn', log );
forEach( '🌷🍕', log );
forEach( '\uD834\uDD1E', log );

See Also

• @stdlib/string-base/for-each-code-point: invoke a function for each Unicode code point in a string.
• @stdlib/string-base/for-each-grapheme-cluster: invoke a function for each grapheme cluster (i.e., user-perceived character) in a string.
• @stdlib/string-for-each: invoke a function for each character in a string.

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.