tree: 7eb5c4d93f0552bdef0effc0cd7ec1cba7fe4e12 [path history] [tgz]
  1. .github/
  2. test/
  3. .editorconfig
  4. .eslintrc
  5. .nycrc
  6. CHANGELOG.md
  7. index.d.ts
  8. index.js
  9. LICENSE
  10. package.json
  11. README.md
  12. tsconfig.json
node_modules/side-channel-map/README.md

side-channel-map Version Badge

github actions coverage License Downloads

npm badge

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