Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/stdlib-js/string-from-code-point
Create a string from a sequence of Unicode code points.
https://github.com/stdlib-js/string-from-code-point
code javascript node node-js nodejs point pt stdlib str string unicode utf-16 utf16 util utilities utility utils
Last synced: 1 day ago
JSON representation
Create a string from a sequence of Unicode code points.
- Host: GitHub
- URL: https://github.com/stdlib-js/string-from-code-point
- Owner: stdlib-js
- License: apache-2.0
- Created: 2021-06-14T13:37:26.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-12-01T08:32:17.000Z (2 months ago)
- Last Synced: 2025-01-01T04:52:45.120Z (about 1 month ago)
- Topics: code, javascript, node, node-js, nodejs, point, pt, stdlib, str, string, unicode, utf-16, utf16, util, utilities, utility, utils
- Language: JavaScript
- Homepage: https://github.com/stdlib-js/stdlib
- Size: 898 KB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Citation: CITATION.cff
- Security: SECURITY.md
Awesome Lists containing this project
README
About stdlib...
We 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!
# fromCodePoint
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]
> Create a string from a sequence of Unicode [code points][code-point].
## Installation
```bash
npm install @stdlib/string-from-code-point
```
Alternatively,
- To load the package in a website via a `script` tag without installation and bundlers, use the [ES Module][es-module] available on the [`esm`][esm-url] branch (see [README][esm-readme]).
- If you are using Deno, visit the [`deno`][deno-url] branch (see [README][deno-readme] for usage intructions).
- For use in Observable, or in browser/node environments, use the [Universal Module Definition (UMD)][umd] build available on the [`umd`][umd-url] branch (see [README][umd-readme]).
- To use as a general utility for the command line, install the corresponding [CLI package][cli-section] globally.
The [branches.md][branches-url] file summarizes the available branches and displays a diagram illustrating their relationships.
To view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.
## Usage
```javascript
var fromCodePoint = require( '@stdlib/string-from-code-point' );
```
#### fromCodePoint( pt1\[, pt2\[, pt3\[, ...]]] )
Creates a `string` from a sequence of Unicode [code points][code-point].
```javascript
var out = fromCodePoint( 9731 );
// returns '☃'
```
In addition to providing [code points][code-point] as separate arguments, the function supports providing an array-like `object` as a single argument containing a sequence of [code points][code-point].
```javascript
var Uint16Array = require( '@stdlib/array-uint16' );
var out = fromCodePoint( 97, 98, 99 );
// returns 'abc'
out = fromCodePoint( new Uint16Array( [ 97, 98, 99 ] ) );
// returns 'abc'
```
## Notes
- This function differs from [`String.fromCharCode`][mdn-string-fromcharcode] in the following ways:
- The function provides support for all valid Unicode values (up to `21` bits). While most common Unicode values can be represented using one 16-bit unit, higher code point characters require two 16-bit units (a surrogate pair consisting of a high and a low surrogate) to form a single character. [`String.fromCharCode`][mdn-string-fromcharcode] does **not** support surrogate pairs, supporting only UCS-2, a subset of [UTF-16][utf-16].
- This function differs from [`String.fromCodePoint`][mdn-string-fromcodepoint] in the following ways:
- The function supports explicitly providing an array-like `object` containing a sequence of [code points][code-point].
- The function requires **at least** one [code point][code-point].
- The function requires that all [code points][code-point] be nonnegative integers. The function does **not** support values, such as `null`, `undefined`, `true`, `false`, `'0'`, `'1'`, etc., which can be cast to integer values.
## Examples
```javascript
var randu = require( '@stdlib/random-base-randu' );
var floor = require( '@stdlib/math-base-special-floor' );
var UNICODE_MAX_BMP = require( '@stdlib/constants-unicode-max-bmp' );
var fromCodePoint = require( '@stdlib/string-from-code-point' );
var x;
var i;
for ( i = 0; i < 100; i++ ) {
x = floor( randu()*UNICODE_MAX_BMP );
console.log( '%d => %s', x, fromCodePoint( x ) );
}
```
* * *
## CLI
## Installation
To use as a general utility, install the CLI package globally
```bash
npm install -g @stdlib/string-from-code-point-cli
```
### Usage
```text
Usage: from-code-point [options] [ ...]
Options:
-h, --help Print this message.
-V, --version Print the package version.
--split sep Delimiter for stdin data. Default: '/\\r?\\n/'.
```
### Notes
- If the split separator is a [regular expression][mdn-regexp], ensure that the `split` option is either properly escaped or enclosed in quotes.
```bash
# Not escaped...
$ echo -n $'97\n98\n99' | from-code-point --split /\r?\n/
# Escaped...
$ echo -n $'97\n98\n99' | from-code-point --split /\\r?\\n/
```
- The implementation ignores trailing delimiters.
### Examples
```bash
$ from-code-point 9731
☃
```
To use as a [standard stream][standard-streams],
```bash
$ echo -n '9731' | from-code-point
☃
```
By default, when used as a [standard stream][standard-streams], the implementation assumes newline-delimited data. To specify an alternative delimiter, set the `split` option.
```bash
$ echo -n '97\t98\t99\t' | from-code-point --split '\t'
abc
```
* * *
## See Also
- [`@stdlib/string-code-point-at`][@stdlib/string/code-point-at]: return a Unicode code point from a string at a specified position.
* * *
## Notice
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]
---
## License
See [LICENSE][stdlib-license].
## Copyright
Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors].
[npm-image]: http://img.shields.io/npm/v/@stdlib/string-from-code-point.svg
[npm-url]: https://npmjs.org/package/@stdlib/string-from-code-point
[test-image]: https://github.com/stdlib-js/string-from-code-point/actions/workflows/test.yml/badge.svg?branch=main
[test-url]: https://github.com/stdlib-js/string-from-code-point/actions/workflows/test.yml?query=branch:main
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/string-from-code-point/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/string-from-code-point?branch=main
[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
[chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im
[stdlib]: https://github.com/stdlib-js/stdlib
[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors
[cli-section]: https://github.com/stdlib-js/string-from-code-point#cli
[cli-url]: https://github.com/stdlib-js/string-from-code-point/tree/cli
[@stdlib/string-from-code-point]: https://github.com/stdlib-js/string-from-code-point/tree/main
[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-from-code-point/tree/deno
[deno-readme]: https://github.com/stdlib-js/string-from-code-point/blob/deno/README.md
[umd-url]: https://github.com/stdlib-js/string-from-code-point/tree/umd
[umd-readme]: https://github.com/stdlib-js/string-from-code-point/blob/umd/README.md
[esm-url]: https://github.com/stdlib-js/string-from-code-point/tree/esm
[esm-readme]: https://github.com/stdlib-js/string-from-code-point/blob/esm/README.md
[branches-url]: https://github.com/stdlib-js/string-from-code-point/blob/main/branches.md
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/string-from-code-point/main/LICENSE
[code-point]: https://en.wikipedia.org/wiki/Code_point
[standard-streams]: https://en.wikipedia.org/wiki/Standard_streams
[mdn-regexp]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions
[mdn-string-fromcharcode]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/fromCharCode
[mdn-string-fromcodepoint]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/fromCodePoint
[utf-16]: https://en.wikipedia.org/wiki/UTF-16
[@stdlib/string/code-point-at]: https://github.com/stdlib-js/string-code-point-at