https://github.com/es-shims/string.prototype.iswellformed
An ESnext spec-compliant `String.prototype.isWellFormed` shim/polyfill/replacement that works as far down as ES3.
https://github.com/es-shims/string.prototype.iswellformed
ecmascript javascript pair polyfill shim string surrogate unicode well-formed
Last synced: 4 months ago
JSON representation
An ESnext spec-compliant `String.prototype.isWellFormed` shim/polyfill/replacement that works as far down as ES3.
- Host: GitHub
- URL: https://github.com/es-shims/string.prototype.iswellformed
- Owner: es-shims
- License: mit
- Created: 2022-09-13T17:57:19.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-03-18T22:03:58.000Z (almost 2 years ago)
- Last Synced: 2025-08-24T03:52:55.182Z (5 months ago)
- Topics: ecmascript, javascript, pair, polyfill, shim, string, surrogate, unicode, well-formed
- Language: JavaScript
- Homepage:
- Size: 51.8 KB
- Stars: 1
- Watchers: 4
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# string.prototype.iswellformed [![Version Badge][npm-version-svg]][package-url]
[![github actions][actions-image]][actions-url]
[![coverage][codecov-image]][codecov-url]
[![dependency status][deps-svg]][deps-url]
[![dev dependency status][dev-deps-svg]][dev-deps-url]
[![License][license-image]][license-url]
[![Downloads][downloads-image]][downloads-url]
[![npm badge][npm-badge-png]][package-url]
An ESnext spec-compliant `String.prototype.isWellFormed` shim/polyfill/replacement that works as far down as ES3.
This package implements the [es-shim API](https://github.com/es-shims/api) interface. It works in an ES3-supported environment and complies with the expected ES2024 [spec](https://tc39.es/proposal-is-usv-string/).
Because `String.prototype.isWellFormed` depends on a receiver (the `this` value), the main export takes the string to operate on as the first argument.
## Getting started
```sh
npm install --save string.prototype.iswellformed
```
## Usage/Examples
```js
var isWellFormed = require('string.prototype.iswellformed');
var assert = require('assert');
var leadingPoo = '\uD83D';
var trailingPoo = '\uDCA9';
var wholePoo = leadingPoo + trailingPoo;
assert.ok(isWellFormed(wholePoo));
assert.notOk(isWellFormed(leadingPoo));
assert.notOk(isWellFormed(trailingPoo));
```
```js
var isWellFormed = require('string.prototype.iswellformed');
var assert = require('assert');
/* when String#isWellFormed is not present */
delete String.prototype.isWellFormed;
var shimmed = isWellFormed.shim();
assert.equal(shimmed, isWellFormed.getPolyfill());
assert.deepEqual(wholePoo.isWellFormed(), isWellFormed(wholePoo));
```
```js
var isWellFormed = require('string.prototype.iswellformed');
var assert = require('assert');
/* when String#at is present */
var shimmed = isWellFormed.shim();
assert.equal(shimmed, String.prototype.isWellFormed);
assert.deepEqual(wholePoo.isWellFormed(), isWellFormed(wholePoo));
```
## Tests
Simply clone the repo, `npm install`, and run `npm test`
[package-url]: https://npmjs.org/package/string.prototype.iswellformed
[npm-version-svg]: https://versionbadg.es/es-shims/String.prototype.isWellFormed.svg
[deps-svg]: https://david-dm.org/es-shims/String.prototype.isWellFormed.svg
[deps-url]: https://david-dm.org/es-shims/String.prototype.isWellFormed
[dev-deps-svg]: https://david-dm.org/es-shims/String.prototype.isWellFormed/dev-status.svg
[dev-deps-url]: https://david-dm.org/es-shims/String.prototype.isWellFormed#info=devDependencies
[npm-badge-png]: https://nodei.co/npm/string.prototype.iswellformed.png?downloads=true&stars=true
[license-image]: https://img.shields.io/npm/l/string.prototype.iswellformed.svg
[license-url]: LICENSE
[downloads-image]: https://img.shields.io/npm/dm/string.prototype.iswellformed.svg
[downloads-url]: https://npm-stat.com/charts.html?package=string.prototype.iswellformed
[codecov-image]: https://codecov.io/gh/es-shims/String.prototype.isWellFormed/branch/main/graphs/badge.svg
[codecov-url]: https://app.codecov.io/gh/es-shims/String.prototype.isWellFormed/
[actions-image]: https://img.shields.io/endpoint?url=https://github-actions-badge-u3jn4tfpocch.runkit.sh/es-shims/String.prototype.isWellFormed
[actions-url]: https://github.com/es-shims/String.prototype.isWellFormed/actions