@stdlib/string-code-point-at NPM

codePointAt

Return a Unicode code point from a string at a specified position.

Installation

npm install @stdlib/string-code-point-at

Usage

var codePointAt = require( '@stdlib/string-code-point-at' );

codePointAt( string, position[, backward] )

Returns a Unicode code point from a string at a specified position.

var out = codePointAt( 'last man standing', 4 );
// returns 32

The function supports providing a backward argument for performing backward iteration for low surrogates.

var out = codePointAt( '🌷', 1, true );
// returns 127799

The function supports providing a negative position.

var out = codePointAt( 'last man standing', -13 );
// returns 32

Notes

This function differs from String.prototype.codePointAt in the following ways:

The function supports providing a negative position. If provided a negative position, the function determines the string position relative to the end of the string.
The function supports providing a backward argument for performing backward iteration for low surrogates. String.prototype.codePointAt simply returns the low surrogate value if no UTF-16 surrogate pair begins at the specified position. If invoked with backward set to true, this function will return the code point after aggregating with the preceding high surrogate, if the specified position does not mark the start of a surrogate pair.
The function raises an exception if provided a position which exceeds the bounds of the input string.

Examples

var codePointAt = require( '@stdlib/string-code-point-at' );

var v = codePointAt( 'last man standing', 4 );
// returns 32

v = codePointAt( 'presidential election', 8, true );
// returns 116

v = codePointAt( 'अनुच्छेद', 2 );
// returns 2369

v = codePointAt( '🌷', 1, true );
// returns 127799

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.