You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
mn a0e4803194
test
11 months ago
..
test test 11 months ago
.editorconfig test 11 months ago
CHANGELOG.md test 11 months ago
CHANGES test 11 months ago
LICENSE test 11 months ago
README.md test 11 months ago
implement.js test 11 months ago
index.js test 11 months ago
is-implemented.js test 11 months ago
is-native-implemented.js test 11 months ago
is-weak-map.js test 11 months ago
package.json test 11 months ago
polyfill.js test 11 months ago
valid-weak-map.js test 11 months ago

README.md

Build status Windows status Transpilation status npm version

es6-weak-map

WeakMap collection as specified in ECMAScript6

Roughly inspired by Mark Miller's and Kris Kowal's WeakMap implementation.

Differences are:

  • Assumes compliant ES5 environment (no weird ES3 workarounds or hacks)
  • Well modularized CJS style
  • Based on one solution.

Limitations

  • Will fail on non extensible objects provided as keys

Installation

$ npm install es6-weak-map

To port it to Browser or any other (non CJS) environment, use your favorite CJS bundler. No favorite yet? Try: Browserify, Webmake or Webpack

Usage

If you want to make sure your environment implements WeakMap, do:

require("es6-weak-map/implement");

If you'd like to use native version when it exists and fallback to polyfill if it doesn't, but without implementing WeakMap on global scope, do:

var WeakMap = require("es6-weak-map");

If you strictly want to use polyfill even if native WeakMap exists, do:

var WeakMap = require("es6-weak-map/polyfill");

API

Best is to refer to specification. Still if you want quick look, follow example:

var WeakMap = require("es6-weak-map");

var map = new WeakMap();
var obj = {};

map.set(obj, "foo"); // map
map.get(obj); // 'foo'
map.has(obj); // true
map.delete(obj); // true
map.get(obj); // undefined
map.has(obj); // false
map.set(obj, "bar"); // map
map.has(obj); // false

Tests

$ npm test