Blame view

node_modules/es6-weak-map/README.md 1.77 KB
aaac7fed   liuqimichale   add
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
  # 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