Return a Unicode code point from a string at a specified position.
npm install @stdlib/string-base-code-point-atWe believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js. The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases. When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there. To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!
About stdlib...
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]
> Return a Unicode [code point][code-point] from a string at a specified position.
``bash`
npm install @stdlib/string-base-code-point-at
`javascript`
var codePointAt = require( '@stdlib/string-base-code-point-at' );
#### codePointAt( string, position, backward )
Returns a Unicode [code point][code-point] from a string at a specified position.
`javascript`
var out = codePointAt( 'last man standing', 4, false );
// returns 32
The function supports a backward argument for performing backward iteration for low surrogates.
`javascript`
var out = codePointAt( '🌷', 1, true );
// returns 127799
The function supports providing a negative position.
`javascript`
var out = codePointAt( 'last man standing', -13, false );
// returns 32
This function differs from [String.prototype.codePointAt][mdn-string-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.backward
- The function supports a argument for performing backward iteration for low surrogates. [String.prototype.codePointAt][mdn-string-codepointat] simply returns the low surrogate value if no [UTF-16][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.
`javascript
var codePointAt = require( '@stdlib/string-base-code-point-at' );
var v = codePointAt( 'last man standing', 4, false );
// returns 32
v = codePointAt( 'presidential election', 8, true );
// returns 116
v = codePointAt( 'अनुच्छेद', 2, false );
// returns 2369
v = codePointAt( '🌷', 1, true );
// returns 127799
`
*
This package is part of [stdlib][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][stdlib], see the main project [repository][stdlib].
#### Community
[![Chat][chat-image]][chat-url]
---
See [LICENSE][stdlib-license].
Copyright © 2016-2026. The Stdlib [Authors][stdlib-authors].
[npm-image]: http://img.shields.io/npm/v/@stdlib/string-base-code-point-at.svg
[npm-url]: https://npmjs.org/package/@stdlib/string-base-code-point-at
[test-image]: https://github.com/stdlib-js/string-base-code-point-at/actions/workflows/test.yml/badge.svg?branch=v0.2.3
[test-url]: https://github.com/stdlib-js/string-base-code-point-at/actions/workflows/test.yml?query=branch:v0.2.3
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/string-base-code-point-at/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/string-base-code-point-at?branch=main
[chat-image]: https://img.shields.io/badge/zulip-join_chat-brightgreen.svg
[chat-url]: https://stdlib.zulipchat.com
[stdlib]: https://github.com/stdlib-js/stdlib
[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors
[umd]: https://github.com/umdjs/umd
[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
[deno-url]: https://github.com/stdlib-js/string-base-code-point-at/tree/deno
[deno-readme]: https://github.com/stdlib-js/string-base-code-point-at/blob/deno/README.md
[umd-url]: https://github.com/stdlib-js/string-base-code-point-at/tree/umd
[umd-readme]: https://github.com/stdlib-js/string-base-code-point-at/blob/umd/README.md
[esm-url]: https://github.com/stdlib-js/string-base-code-point-at/tree/esm
[esm-readme]: https://github.com/stdlib-js/string-base-code-point-at/blob/esm/README.md
[branches-url]: https://github.com/stdlib-js/string-base-code-point-at/blob/main/branches.md
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/string-base-code-point-at/main/LICENSE
[code-point]: https://en.wikipedia.org/wiki/Code_point
[mdn-string-codepointat]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/codePointAt
[utf-16]: https://en.wikipedia.org/wiki/UTF-16