lhl 2bdf874dbb create 11 månader sedan
..
.github 2bdf874dbb create 11 månader sedan
test 2bdf874dbb create 11 månader sedan
.editorconfig 2bdf874dbb create 11 månader sedan
.eslintrc 2bdf874dbb create 11 månader sedan
.nycrc 2bdf874dbb create 11 månader sedan
CHANGELOG.md 2bdf874dbb create 11 månader sedan
LICENSE 2bdf874dbb create 11 månader sedan
README.md 2bdf874dbb create 11 månader sedan
index.d.ts 2bdf874dbb create 11 månader sedan
index.js 2bdf874dbb create 11 månader sedan
package.json 2bdf874dbb create 11 månader sedan
tsconfig.json 2bdf874dbb create 11 månader sedan

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