side-channel-map ^{[![Version Badge][npm-version-svg]][package-url]}

[![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]

Store information about any JS value in a side channel, using a Map.

Warning: if the key is an object, this implementation will leak memory until you delete it. Use side-channel for the best available strategy.

Getting started

npm install --save side-channel-map

Usage/Examples

const assert = require('assert');
const getSideChannelMap = require('side-channel-map');
const channel = getSideChannelMap();
const key = {};
assert.equal(channel.has(key), false);
assert.throws(() => channel.assert(key), TypeError);
channel.set(key, 42);
channel.assert(key); // does not throw
assert.equal(channel.has(key), true);
assert.equal(channel.get(key), 42);
channel.delete(key);
assert.equal(channel.has(key), false);
assert.throws(() => channel.assert(key), TypeError);

Tests

Clone the repo, npm install, and run npm test

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