/obsolete-string-at

A robust & optimized ES3-compatible polyfill for the `String.prototype.at` proposal for ECMAScript - based on https://mths.be/at

Primary LanguageJavaScriptMIT LicenseMIT

Note: This proposal was not upstreamed into the ECMAScript specification! This repository is kept for historical purposes. Years later, in November 2020, a distinct proposal adds String.prototype.at with different semantics.

Please use string.prototype.at instead.

string-at Version Badge

Build Status dependency status dev dependency status License Downloads

npm badge

browser support

A robust & optimized ES3-compatible polyfill for the String.prototype.at proposal for ECMAScript 6/7.

This code is almost entirely copied from @mathiasbynens's excellent polyfill at https://mths.be/at - I created this one so that it did not automatically modify String.prototype, and so that it would fit in more neatly with the es7-shim.

Use it as a standalone function, or call its shim method to install it as a polyfill.

Example

var at = require('string-at');
var assert = require('assert');

var surrogatePair = '\uD834\uDF06 abc'; // a surrogate pair
assert(surrogatePair.length === 6);
assert(at(surrogatePair, 0) === '\uD834\uDF06');
assert(at(surrogatePair, 1) === '\uDF06');

var i = 0;
var str = '';
while (str.length < surrogatePair.length) {
	str += at(surrogatePair, str.length);
	i += 1;
}
assert(str === surrogatePair);
assert(i === 4); // 4 code points
assert(str.length === 6); // 6 "characters"

at.shim();
assert(surrogatePair.at(0) === at(surrogatePair, 0));

Tests

Simply clone the repo, npm install, and run npm test