Blame view

node_modules/es6-set/README.md 1.89 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
64
65
66
67
68
69
70
71
72
73
74
  # es6-set
  ## Set collection as specified in ECMAScript6
  
  __Warning:  
  v0.1 version does not ensure O(1) algorithm complexity (but O(n)). This shortcoming will be addressed in v1.0__
  
  ### Usage
  
  If you want to make sure your environment implements `Set`, do:
  
  ```javascript
  require('es6-set/implement');
  ```
  
  If you'd like to use native version when it exists and fallback to polyfill if it doesn't, but without implementing `Set` on global scope, do:
  
  ```javascript
  var Set = require('es6-set');
  ```
  
  If you strictly want to use polyfill even if native `Set` exists, do:
  
  ```javascript
  var Set = require('es6-set/polyfill');
  ```
  
  ### Installation
  
  	$ npm install es6-set
  
  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/)
  
  #### API
  
  Best is to refer to [specification](http://people.mozilla.org/~jorendorff/es6-draft.html#sec-set-objects). Still if you want quick look, follow examples:
  
  ```javascript
  var Set = require('es6-set');
  
  var set = new Set(['raz', 'dwa', {}]);
  
  set.size;          // 3
  set.has('raz');    // true
  set.has('foo');    // false
  set.add('foo');    // set
  set.size           // 4
  set.has('foo');    // true
  set.has('dwa');    // true
  set.delete('dwa'); // true
  set.size;          // 3
  
  set.forEach(function (value) {
   // 'raz', {}, 'foo' iterated
  });
  
  // FF nightly only:
  for (value of set) {
   // 'raz', {}, 'foo' iterated
  }
  
  var iterator = set.values();
  
  iterator.next(); // { done: false, value: 'raz' }
  iterator.next(); // { done: false, value: {} }
  iterator.next(); // { done: false, value: 'foo' }
  iterator.next(); // { done: true, value: undefined }
  
  set.clear(); // undefined
  set.size; // 0
  ```
  
  ## Tests [![Build Status](https://travis-ci.org/medikoo/es6-set.png)](https://travis-ci.org/medikoo/es6-set)
  
  	$ npm test