review.tizen.org Git - platform/framework/web/crosswalk-tizen.git/blob

   1 # es6-set
   2 ## Set collection as specified in ECMAScript6
   3
   4 ### Usage
   5
   6 If you want to make sure your environment implements `Set`, do:
   7
   8 ```javascript
   9 require('es6-set/implement');
  10 ```
  11
  12 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:
  13
  14 ```javascript
  15 var Set = require('es6-set');
  16 ```
  17
  18 If you strictly want to use polyfill even if native `Set` exists, do:
  19
  20 ```javascript
  21 var Set = require('es6-set/polyfill');
  22 ```
  23
  24 ### Installation
  25
  26         $ npm install es6-set
  27
  28 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/)
  29
  30 #### API
  31
  32 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:
  33
  34 ```javascript
  35 var Set = require('es6-set');
  36
  37 var set = new Set(['raz', 'dwa', {}]);
  38
  39 set.size;          // 3
  40 set.has('raz');    // true
  41 set.has('foo');    // false
  42 set.add('foo');    // set
  43 set.size           // 4
  44 set.has('foo');    // true
  45 set.has('dwa');    // true
  46 set.delete('dwa'); // true
  47 set.size;          // 3
  48
  49 set.forEach(function (value) {
  50  // 'raz', {}, 'foo' iterated
  51 });
  52
  53 // FF nightly only:
  54 for (value of set) {
  55  // 'raz', {}, 'foo' iterated
  56 }
  57
  58 var iterator = set.values();
  59
  60 iterator.next(); // { done: false, value: 'raz' }
  61 iterator.next(); // { done: false, value: {} }
  62 iterator.next(); // { done: false, value: 'foo' }
  63 iterator.next(); // { done: true, value: undefined }
  64
  65 set.clear(); // undefined
  66 set.size; // 0
  67 ```
  68
  69 ## Tests [![Build Status](https://travis-ci.org/medikoo/es6-set.png)](https://travis-ci.org/medikoo/es6-set)
  70
  71         $ npm test