ShenNong/packages/字体精简工具/node_modules/code-points/README.md
2024-06-21 18:44:06 +08:00

54 lines
1.5 KiB
Markdown

# code-points
[![npm version](https://img.shields.io/npm/v/code-points.svg)](https://www.npmjs.com/package/code-points)
[![Build Status](https://travis-ci.com/shinnn/code-points.js.svg?branch=master)](https://travis-ci.com/shinnn/code-points.js)
[![Coverage Status](https://img.shields.io/coveralls/shinnn/code-points.js.svg)](https://coveralls.io/github/shinnn/code-points.js)
Get the [UTF-16](https://wikipedia.org/wiki/UTF-16)-encoded code points of each character in the string
```javascript
codePoints('Hello, 世界\n'); //=> [72, 101, 108, 108, 111, 44, 32, 19990, 30028]
```
## Installation
[Use](https://docs.npmjs.com/cli/install) [npm](https://docs.npmjs.com/about-npm/).
```
npm install code-points
```
## API
### codePoints(*str*, *option*)
*str*: `string`
*option*: `Object`
Return: `Array<integer>`
It returns the [code point](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String/codePointAt)s of each character in the string as an array.
```javascript
codePoints('\udada'); //=> [56026]
codePoints('\udfdf\udada\udada'); //=> [57311, 56026, 56026]
codePoints('\udada\udfdf\udada'); //=> [814047, 56026]
```
#### option.unique
Type: `boolean`
Default: `false`
Removes duplicates from result.
```javascript
codePoints('banana'); //=> [98, 97, 110, 97, 110, 97]
codePoints('banana', {unique: true}); //=> [98,97,110]
```
## License
Copyright (c) 2014 - 2019 [Shinnosuke Watanabe](https://github.com/shinnn)
Licensed under [the MIT License](https://github.com/shinnn/code-points/blob/master/LICENSE).