es-map/README.md

An ES-spec-compliant Map shim/polyfill/replacement that works as far down as ES3

# es-map <sup>[![Version Badge][npm-version-svg]][package-url]</sup>

[![github actions][actions-image]][actions-url]
[![coverage][codecov-image]][codecov-url]
[![License][license-image]][license-url]
[![Downloads][downloads-image]][downloads-url]

[![npm badge][npm-badge-png]][package-url]

An ESnext spec-compliant `Map` shim/polyfill/replacement that works as far down as ES3.

This package implements the [es-shim API](https://github.com/es-shims/api) interface. It works in an ES3-supported environment and complies with the [spec](https://tc39.es/ecma262/#sec-map-objects).

## Getting started

```sh
npm install --save es-map
```

## Usage/Examples

```js
var map = new Map();
var obj = {};

map.set(1, 2).set(obj, 4);

map.get(obj); // 4
map.has(3); // false
```

## Tests
Simply clone the repo, `npm install`, and run `npm test`

[package-url]: https://npmjs.org/package/es-map
[npm-version-svg]: https://versionbadg.es/es-shims/es-map.svg
[deps-svg]: https://david-dm.org/es-shims/es-map.svg
[deps-url]: https://david-dm.org/es-shims/es-map
[dev-deps-svg]: https://david-dm.org/es-shims/es-map/dev-status.svg
[dev-deps-url]: https://david-dm.org/es-shims/es-map#info=devDependencies
[npm-badge-png]: https://nodei.co/npm/es-map.png?downloads=true&stars=true
[license-image]: https://img.shields.io/npm/l/es-map.svg
[license-url]: LICENSE
[downloads-image]: https://img.shields.io/npm/dm/es-map.svg
[downloads-url]: https://npm-stat.com/charts.html?package=es-shims/es-map
[codecov-image]: https://codecov.io/gh/es-shims/es-map/branch/main/graphs/badge.svg
[codecov-url]: https://app.codecov.io/gh/es-shims/es-map/
[actions-image]: https://img.shields.io/endpoint?url=https://github-actions-badge-u3jn4tfpocch.runkit.sh/es-shims/es-map
[actions-url]: https://github.com/es-shims/es-map/actions