e 92fdcc4d2a ts 10 bulan lalu
..
.github 92fdcc4d2a ts 10 bulan lalu
test 92fdcc4d2a ts 10 bulan lalu
.editorconfig 92fdcc4d2a ts 10 bulan lalu
.eslintrc 92fdcc4d2a ts 10 bulan lalu
.nycrc 92fdcc4d2a ts 10 bulan lalu
CHANGELOG.md 92fdcc4d2a ts 10 bulan lalu
LICENSE 92fdcc4d2a ts 10 bulan lalu
README.md 92fdcc4d2a ts 10 bulan lalu
index.d.ts 92fdcc4d2a ts 10 bulan lalu
index.js 92fdcc4d2a ts 10 bulan lalu
package.json 92fdcc4d2a ts 10 bulan lalu
tsconfig.json 92fdcc4d2a ts 10 bulan lalu

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