lhl 2bdf874dbb create 11 maanden geleden
..
.github 2bdf874dbb create 11 maanden geleden
test 2bdf874dbb create 11 maanden geleden
.editorconfig 2bdf874dbb create 11 maanden geleden
.eslintrc 2bdf874dbb create 11 maanden geleden
.nycrc 2bdf874dbb create 11 maanden geleden
CHANGELOG.md 2bdf874dbb create 11 maanden geleden
LICENSE 2bdf874dbb create 11 maanden geleden
README.md 2bdf874dbb create 11 maanden geleden
index.d.ts 2bdf874dbb create 11 maanden geleden
index.js 2bdf874dbb create 11 maanden geleden
package.json 2bdf874dbb create 11 maanden geleden
tsconfig.json 2bdf874dbb create 11 maanden geleden

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