Name	Last modified	Size	Description
	Parent Directory		-
	test/	2023-06-01 15:53	-
	CHANGELOG.md	2023-06-01 15:53	279
	CHANGES	2023-06-01 15:53	1.4K
	LICENSE	2023-06-01 15:53	773
	README.md	2023-06-01 15:53	2.3K	9b1f1b9 rm old utils [كارل مبارك]
	implement.js	2023-06-01 15:53	222
	index.js	2023-06-01 15:53	97	9b1f1b9 rm old utils [كارل مبارك]
	is-implemented.js	2023-06-01 15:53	621
	is-native-implemented.js	2023-06-01 15:53	273
	is-weak-map.js	2023-06-01 15:53	403
	package.json	2023-06-01 15:53	899	2324c9f added npm start script [كارل مبارك]
	polyfill.js	2023-06-01 15:53	2.2K
	valid-weak-map.js	2023-06-01 15:53	186

[![Build status][nix-build-image]][nix-build-url]
[![Windows status][win-build-image]][win-build-url]
![Transpilation status][transpilation-image]
[![npm version][npm-image]][npm-url]

# 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

    $ npm test

[nix-build-image]: https://semaphoreci.com/api/v1/medikoo-org/es6-weak-map/branches/master/shields_badge.svg
[nix-build-url]: https://semaphoreci.com/medikoo-org/es6-weak-map
[win-build-image]: https://ci.appveyor.com/api/projects/status/1c73c57pg4s6lwmu?svg=true
[win-build-url]: https://ci.appveyor.com/project/medikoo/es6-weak-map
[transpilation-image]: https://img.shields.io/badge/transpilation-free-brightgreen.svg
[npm-image]: https://img.shields.io/npm/v/es6-weak-map.svg
[npm-url]: https://www.npmjs.com/package/es6-weak-map