es6-collections

ES6 Harmony like collections such Map, WeakMap, and Set

npm install es6-collections
115 downloads in the last day
750 downloads in the last week
3 517 downloads in the last month

ES6 Harmony Collections Fast Polyfill

The aim of this repository is to provide an unobtrusive, performances oriented shim for ES6 collections such WeakMap, Map, and Set.

These global functions are already available in Firefox Nightly and Chrome Dev channel through Enable Experimental JavaScript in chrome://flags/ section.

Features

  • compatible with all browsers and both node.js (npm install es6-collections) and Rhino
  • 100% unobtrusive with any environment. If implemented in node V8 it exports native constructors rather than shims
  • size and performances oriented polyfill. It does not matter if the WeakMap is not perfect, it's just fast and not much more memory leaks prone than other shims. If you don't rely in magic, simply remember to wm.delete(referedObject) when referedObject is not needed anymore.
  • for browsers, it fits in less than 1Kb once minzipped ... the smallest shim out there so far
  • 100% of code coverage through Web or console wru based tests
  • completely private shared behavior in order to easily maintain and update three collections at once

New On Version 0.2.0

  • removed both keys and values properties since these are not in specs anymore
  • improved checks in order to do not fail with NaN or -0 and +0 as specified via specs
  • native Array.prototype.indexOf used when key/value to retrieve is not NaN or -0 and +0 (performances regardless checks)
  • updated tests including all methods behaviors plus (Map|Set)#size() test for Mozilla only

The WeakMap Is Not Weak ... And Why

  • first of all, ES6 Collections is not about WeakMap only ... most likely is about Map ... anyway ...
  • O(n) against O(1) to link keyObject and value is a no-go for different reasons:
    • the random property attached to the object will be easily discoverable via for/in loop in all non ES5 capable engines, obtrusive
    • even in ES5 capable browser, to make the random property not discoverable we need to wrap native Object.defineProperty, Object.defineProperties, Object.create, Object.getOwnPropertyNames, plus eventually Proxy, which means the whole application will be O(n) times slower for everything, not Map or WeakMap only
    • there are situations where a random property cannot be attached, as example in Internet Explorer some object exposed in JavaScript may not accept runtime attached properties. The purpose of this shim is to be as cross platform as possible and as safe as possible while others polyfills are able to break, just as example, objects defined via VB Classes
  • it's simply not possible to create 100% WeakMap in ES5 only, the aim of this polyfill is to bring a 1:1 unobtrusive and reliable API rather than 1:1 implementation
  • if you think WeakMap, never existed until now, is the only thing you need, you may consider the first proposed alternative and simply walk away from this page
  • a polyfill aim is to bring a reliable API until the browser supports it and you can simply remove the polyfill dependency. The perfect implementation may be unnecessary, in this case obtrusive, or simply YAGNI

Alternatives

  • the bigger and rich in dependencies WeakMap shim from Mark S. Miller, the best attempt to avoid undesired memory leaks. Bear in mind some leak is still possible plus Object natives are wrapped plus it brings WeakMap only
  • the unfortunately and so far slower and heavier, memory usage speaking, alternative from Benvie Harmony Collections Shim
  • differently implemented Map and Set (no WeakMap) from Paul Millr, together with few others ES6 prototypes
  • another attempt based on valueOf to avoid IE enumerability, still problematic with unknown objects but less leaks prone from Gozala

Tests

To run tests via node.js from the root folder of this project simply write node tests/console.js. To run tests via Rhino from the root folder of this project simply write java -jar builder/jar/js.jar tests/console.js. To run test via browser simply drag and drop tests/web.html file.

Build

To build the browser version from the root of this project folder simply write python builder/build.py.

License

es6-collections and the rest of the project is under Mit Style License

Copyright (C) 2011 by Andrea Giammarchi, @WebReflection

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
npm loves you