ljoaquim 1590311121 first commit 10 mesiacov pred
..
.github 1590311121 first commit 10 mesiacov pred
test 1590311121 first commit 10 mesiacov pred
.editorconfig 1590311121 first commit 10 mesiacov pred
.eslintrc 1590311121 first commit 10 mesiacov pred
.nycrc 1590311121 first commit 10 mesiacov pred
CHANGELOG.md 1590311121 first commit 10 mesiacov pred
LICENSE 1590311121 first commit 10 mesiacov pred
README.md 1590311121 first commit 10 mesiacov pred
index.d.ts 1590311121 first commit 10 mesiacov pred
index.js 1590311121 first commit 10 mesiacov pred
package.json 1590311121 first commit 10 mesiacov pred
tsconfig.json 1590311121 first commit 10 mesiacov pred

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