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
..
lib test 11 months ago
primitive test 11 months ago
test test 11 months ago
.lint test 11 months ago
.npmignore test 11 months ago
.travis.yml 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-map.js test 11 months ago
is-native-implemented.js test 11 months ago
package.json test 11 months ago
polyfill.js test 11 months ago
valid-map.js test 11 months ago

README.md

es6-map

Map 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

Its safest to use es6-map as a ponyfill a polyfill which doesnt touch global objects:

var Map = require('es6-map');

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

require('es6-map/implement');

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

var Map = require('es6-map/polyfill');

Installation

$ npm install es6-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

API

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

var Map = require('es6-map');

var x = {}, y = {}, map = new Map([['raz', 'one'], ['dwa', 'two'], [x, y]]);

map.size;                 // 3
map.get('raz');           // 'one'
map.get(x);               // y
map.has('raz');           // true
map.has(x);               // true
map.has('foo');           // false
map.set('trzy', 'three'); // map
map.size                  // 4
map.get('trzy');          // 'three'
map.has('trzy');          // true
map.has('dwa');           // true
map.delete('dwa');        // true
map.size;                 // 3

map.forEach(function (value, key) {
  // { 'raz', 'one' }, { x, y }, { 'trzy', 'three' } iterated
});

// FF nightly only:
for (value of map) {
 // ['raz', 'one'], [x, y], ['trzy', 'three'] iterated
}

var iterator = map.values();

iterator.next(); // { done: false, value: 'one' }
iterator.next(); // { done: false, value: y }
iterator.next(); // { done: false, value: 'three' }
iterator.next(); // { done: true, value: undefined }

map.clear(); // undefined
map.size; // 0

Tests Build Status

$ npm test