summaryrefslogtreecommitdiffstats
path: root/js/vendor/es6-shim/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'js/vendor/es6-shim/README.md')
-rw-r--r--js/vendor/es6-shim/README.md98
1 files changed, 50 insertions, 48 deletions
diff --git a/js/vendor/es6-shim/README.md b/js/vendor/es6-shim/README.md
index 1d0d9a385..074dd5af2 100644
--- a/js/vendor/es6-shim/README.md
+++ b/js/vendor/es6-shim/README.md
@@ -8,6 +8,8 @@ closely as possible to ECMAScript 6 (Harmony).
[![Sauce Test Status](https://saucelabs.com/browser-matrix/es6-shim.svg)](https://saucelabs.com/u/es6-shim)
+[HTML version of the final ECMAScript 6 spec][spec-html-url]
+
## Installation
If you want to use it in browser:
@@ -33,39 +35,39 @@ In both browser and node you may also want to include `unorm`; see the [`String.
* `raw()`
* `String.prototype`:
* `codePointAt()` ([a standalone shim is also available](http://mths.be/codepointat))
- * `repeat()` ([a standalone shim is also available](http://mths.be/repeat))
- * `startsWith()` ([a standalone shim is also available](http://mths.be/startswith))
* `endsWith()` ([a standalone shim is also available](http://mths.be/endswith))
* `includes()` ([a standalone shim is also available](http://mths.be/includes))
+ * `repeat()` ([a standalone shim is also available](http://mths.be/repeat))
+ * `startsWith()` ([a standalone shim is also available](http://mths.be/startswith))
* `RegExp`:
* `new RegExp`, when given a RegExp as the pattern, will no longer throw when given a "flags" string argument. (requires ES5)
* `RegExp.prototype`:
* `flags` (requires ES5) ([a standalone shim is also available](https://github.com/es-shims/RegExp.prototype.flags))
* `Number`:
+ * `EPSILON`
* `MAX_SAFE_INTEGER`
* `MIN_SAFE_INTEGER`
- * `EPSILON`
- * `parseInt()`
- * `parseFloat()`
* `isNaN()`([a standalone shim is also available](https://npmjs.org/package/is-nan))
* `isInteger()`
* `isSafeInteger()`
* `isFinite()`
+ * `parseInt()`
+ * `parseFloat()`
* `Array`:
* `from()` ([a standalone shim is also available](https://npmjs.org/package/array.from))
* `of()` ([a standalone shim is also available](https://npmjs.org/package/array.of))
* `Array.prototype`:
* `copyWithin()`
+ * `entries()`
* `fill()`
* `find()` ([a standalone shim is also available](https://github.com/paulmillr/Array.prototype.find))
* `findIndex()` ([a standalone shim is also available](https://github.com/paulmillr/Array.prototype.findIndex))
* `keys()` (note: keys/values/entries return an `ArrayIterator` object)
- * `entries()`
* `values()`
* `Object`:
- * `keys()` (in ES5, but no longer throws on non-object non-null/undefined values in ES6)
- * `is()` ([a standalone shim is also available](https://github.com/ljharb/object-is))
* `assign()` ([a standalone shim is also available](https://github.com/ljharb/object.assign))
+ * `is()` ([a standalone shim is also available](https://github.com/ljharb/object-is))
+ * `keys()` (in ES5, but no longer throws on non-object non-null/undefined values in ES6)
* `setPrototypeOf()` (IE >= 11)
* `Math`:
* `acosh()`
@@ -75,16 +77,16 @@ In both browser and node you may also want to include `unorm`; see the [`String.
* `clz32()`
* `cosh()`
* `expm1()`
+ * `fround()`
* `hypot()`
- * `log2()`
+ * `imul()`
* `log10()`
* `log1p()`
+ * `log2()`
* `sign()`
* `sinh()`
* `tanh()`
* `trunc()`
- * `imul()`
- * `fround()`
Math functions’ accuracy is 1e-11.
@@ -122,12 +124,15 @@ These methods are part of "Annex B", which means that although they are a defact
## Subclassing
The `Map`, `Set`, and `Promise` implementations are subclassable.
-You should use the following pattern to create a subclass in ES5 which
-will continue to work in ES6:
+You should use the following pattern to create a subclass in ES5 which will continue to work in ES6:
```javascript
+require('es6-shim');
+
function MyPromise(exec) {
- Promise.call(this, exec);
+ var promise = new Promise(exec);
+ Object.setPrototypeOf(promise, MyPromise.prototype);
// ...
+ return promise;
}
Object.setPrototypeOf(MyPromise, Promise);
MyPromise.prototype = Object.create(Promise.prototype, {
@@ -136,49 +141,45 @@ MyPromise.prototype = Object.create(Promise.prototype, {
```
## String.prototype.normalize
-Including a proper shim for `String.prototype.normalize` would
-increase the size of this library by a factor of more than 4.
-So instead we recommend that you install the
-[`unorm`](https://github.com/walling/unorm)
-package alongside `es6-shim` if you need `String.prototype.normalize`.
-See https://github.com/paulmillr/es6-shim/issues/134 for more
-discussion.
+Including a proper shim for `String.prototype.normalize` would increase the size of this library by a factor of more than 4.
+So instead we recommend that you install the [`unorm`](https://github.com/walling/unorm) package alongside `es6-shim` if you need `String.prototype.normalize`.
+See https://github.com/paulmillr/es6-shim/issues/134 for more discussion.
## WeakMap shim
It is not possible to implement WeakMap in pure javascript.
-The [es6-collections](https://github.com/WebReflection/es6-collections)
-implementation doesn't hold values strongly, which is critical
-for the collection. es6-shim decided to not include an incorrect shim.
+The [es6-collections](https://github.com/WebReflection/es6-collections) implementation doesn't hold values strongly, which is critical for the collection. `es6-shim` decided to not include an incorrect shim.
-WeakMap has a very unusual use-case so you probably won't need it at all
-(use simple `Map` instead).
+`WeakMap` has very unusual use-cases, so you probably won't need it at all (use simple `Map` instead).
## Getting started
```javascript
-'abc'.startsWith('a') // true
-'abc'.endsWith('a') // false
-'john alice'.includes('john') // true
-'123'.repeat(2) // '123123'
+var assert = require('assert');
+require('es6-shim');
+
+'abc'.startsWith('a'); // true
+'abc'.endsWith('a'); // false
+'john alice'.includes('john'); // true
+'123'.repeat(2); // '123123'
-Object.is(NaN, NaN) // Fixes ===. 0 isnt -0, NaN is NaN
-Object.assign({a: 1}, {b: 2}) // {a: 1, b: 2}
+Object.is(NaN, NaN); // Fixes ===. 0 isnt -0, NaN is NaN
+Object.assign({a: 1}, {b: 2}); // {a: 1, b: 2}
-Number.isNaN('123') // false. isNaN('123') will give true.
-Number.isFinite('asd') // false. Global isFinite() will give true.
+Number.isNaN('123'); // false. Global isNaN('123') will give true.
+Number.isFinite('asd'); // false. Global isFinite() will give true.
// Tests if value is a number, finite,
// >= -9007199254740992 && <= 9007199254740992 and floor(value) === value
-Number.isInteger(2.4) // false.
+Number.isInteger(2.4); // false.
-Math.sign(400) // 1, 0 or -1 depending on sign. In this case 1.
+Math.sign(400); // 1, 0 or -1 depending on sign. In this case 1.
-[5, 10, 15, 10].find(function (item) {return item / 2 === 5;}) // 10
-[5, 10, 15, 10].findIndex(function (item) {return item / 2 === 5;}) // 1
+[5, 10, 15, 10].find(function (item) { return item / 2 === 5; }); // 10
+[5, 10, 15, 10].findIndex(function (item) { return item / 2 === 5; }); // 1
// Replacement for `{}` key-value storage.
// Keys can be anything.
-var map = new Map();
+var map = new Map([['Bob', 42], ['Foo', 'bar']]);
map.set('John', 25);
map.set('Alice', 400);
map.set(['meh'], 555);
@@ -186,13 +187,15 @@ assert(map.get(['meh']) === undefined); // undefined because you need to use exa
map.delete('Alice');
map.keys();
map.values();
-assert(map.size === 2);
+assert(map.size === 4);
// Useful for storing unique items.
-var set = new Set();
-set.add(1);
+var set = new Set([0, 1]);
+set.add(2);
set.add(5);
+assert(set.has(0) === true);
assert(set.has(1) === true);
+assert(set.has(2) === true);
assert(set.has(4) === false);
set.delete(5);
@@ -200,7 +203,7 @@ set.delete(5);
// http://www.slideshare.net/domenicdenicola/callbacks-promises-and-coroutines-oh-my-the-evolution-of-asynchronicity-in-javascript
// https://github.com/petkaantonov/bluebird/#what-are-promises-and-why-should-i-use-them
Promise.resolve(5).then(function (value) {
- if ( ... ) throw new Error("whoops!");
+ if (value) throw new Error("whoops!");
// do some stuff
return anotherPromise();
}).catch(function (e) {
@@ -208,10 +211,10 @@ Promise.resolve(5).then(function (value) {
});
```
-Other stuff:
+## Caveats
-* [HTML version of the latest ECMAScript 6 spec draft][spec-html-url]
-* [PDFs of ECMAScript 6 spec drafts][spec-drafts-url]
+- `Object.setPrototypeOf` / `Reflect.setPrototypeOf`
+ - Note that null objects (`Object.create(null)`, eg, an object with `null` as its `[[Prototype]]`) can not have their `[[Prototype]]` changed except via a native `Object.setPrototypeOf`.
## [License][license-url]
@@ -222,6 +225,5 @@ Other stuff:
[5]: https://david-dm.org/paulmillr/es6-shim/dev-status.svg
[6]: https://david-dm.org/paulmillr/es6-shim#info=devDependencies
[license-url]: https://github.com/paulmillr/es6-shim/blob/master/LICENSE
-[spec-html-url]: https://people.mozilla.org/~jorendorff/es6-draft.html
-[spec-drafts-url]: http://wiki.ecmascript.org/doku.php?id=harmony:specification_drafts
+[spec-html-url]: http://www.ecma-international.org/ecma-262/6.0/
[es5-shim-url]: https://github.com/es-shims/es5-shim
generated by cgit v1.2.3 (git 2.25.1) at 2024-06-07 17:53:21 +0000