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

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

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

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.

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

Usage: code-point-at [options] --pos=<index> [<string>]

Options:

  -h,    --help                Print this message.
  -V,    --version             Print the package version.
  -b,    --backward            Backward iteration for low surrogates.
         --pos index           Position in string.

$ code-point-at --pos=2 अनुच्छेद
2369

To use as a standard stream,

$ echo -n 'अनुच्छेद' | code-point-at --pos=2
2369

• @stdlib/string/from-code-point: create a string from a sequence of Unicode code points.