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

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