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

README.md

side-channel Version Badge

github actions coverage License Downloads

npm badge

Store information about any JS value in a side channel. Uses WeakMap if available.

Warning: in an environment that lacks WeakMap, this implementation will leak memory until you delete the key.

Getting started

npm install --save side-channel

Usage/Examples

const assert = require('assert');
const getSideChannel = require('side-channel');

const channel = getSideChannel();

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