diff options
Diffstat (limited to 'tools/eslint/node_modules/es6-weak-map/README.md')
-rw-r--r-- | tools/eslint/node_modules/es6-weak-map/README.md | 63 |
1 files changed, 0 insertions, 63 deletions
diff --git a/tools/eslint/node_modules/es6-weak-map/README.md b/tools/eslint/node_modules/es6-weak-map/README.md deleted file mode 100644 index ccbade23a2..0000000000 --- a/tools/eslint/node_modules/es6-weak-map/README.md +++ /dev/null @@ -1,63 +0,0 @@ -# es6-weak-map -## WeakMap collection as specified in ECMAScript6 - -_Roughly inspired by Mark Miller's and Kris Kowal's [WeakMap implementation](https://github.com/drses/weak-map)_. - -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](http://browserify.org/), [Webmake](https://github.com/medikoo/modules-webmake) or [Webpack](http://webpack.github.io/) - -### Usage - -If you want to make sure your environment implements `WeakMap`, do: - -```javascript -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: - -```javascript -var WeakMap = require('es6-weak-map'); -``` - -If you strictly want to use polyfill even if native `WeakMap` exists, do: - -```javascript -var WeakMap = require('es6-weak-map/polyfill'); -``` - -#### API - -Best is to refer to [specification](http://people.mozilla.org/~jorendorff/es6-draft.html#sec-weakmap-objects). Still if you want quick look, follow example: - -```javascript -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 [![Build Status](https://travis-ci.org/medikoo/es6-weak-map.svg)](https://travis-ci.org/medikoo/es6-weak-map) - - $ npm test |