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

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