You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
jakub 8f2c8d3cff bliat 11 months ago
..
.github bliat 11 months ago
test bliat 11 months ago
.editorconfig bliat 11 months ago
.eslintrc bliat 11 months ago
.nycrc bliat 11 months ago
CHANGELOG.md bliat 11 months ago
LICENSE bliat 11 months ago
README.md bliat 11 months ago
index.d.ts bliat 11 months ago
index.js bliat 11 months ago
package.json bliat 11 months ago
tsconfig.json bliat 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