string-character-is-astral-surrogate
TypeScript icon, indicating that this package has built-in type declarations

3.0.9 • Public • Published

string-character-is-astral-surrogate

Tells, is given character a part of astral character, specifically, a high and low surrogate

page on codsen.com page on npm page on github Downloads per month changelog MIT Licence

Install

This package is pure ESM. If you're not ready yet, install an older version of this program, 1.13.0 (npm i string-character-is-astral-surrogate@1.13.0).

npm i string-character-is-astral-surrogate

Quick Take

import { strict as assert } from "assert";

import {
  isHighSurrogate,
  isLowSurrogate,
} from "string-character-is-astral-surrogate";

// 🧢 = \uD83E\uDDE2

assert.equal(isHighSurrogate("\uD83E"), true);
// the first character, high surrogate of the cap is indeed a high surrogate

assert.equal(isHighSurrogate("\uDDE2"), false);
// the second character, low surrogate of the cap is NOT a high surrogate

assert.equal(isLowSurrogate("\uD83E"), false);
// the first character, high surrogate of the cap is NOT a low surrogate
// it's a high surrogate

assert.equal(isLowSurrogate("\uDDE2"), true);
// the second character, low surrogate of the cap is indeed a low surrogate

Documentation

Please visit codsen.com for a full description of the API.

Contributing

To report bugs or request features or assistance, raise an issue on GitHub.

Licence

MIT License.

Copyright © 2010-2024 Roy Revelt and other contributors.

ok codsen star

Package Sidebar

Install

npm i string-character-is-astral-surrogate

Weekly Downloads

16,393

Version

3.0.9

License

MIT

Unpacked Size

11.6 kB

Total Files

7

Last publish

Collaborators

  • royston