You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
PhilipOsztromok d28cb5a9ed Initial commit 10 months ago
..
.github Initial commit 10 months ago
test Initial commit 10 months ago
.editorconfig Initial commit 10 months ago
.eslintrc Initial commit 10 months ago
.nycrc Initial commit 10 months ago
CHANGELOG.md Initial commit 10 months ago
LICENSE Initial commit 10 months ago
README.md Initial commit 10 months ago
index.d.ts Initial commit 10 months ago
index.js Initial commit 10 months ago
package.json Initial commit 10 months ago
tsconfig.json Initial commit 10 months ago

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