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

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