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

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