todoApp/node_modules/side-channel
Fernando Escobar Robles 50469288e1 version 1.0 2025-03-26 08:18:28 -06:00
..
.github version 1.0 2025-03-26 08:18:28 -06:00
test version 1.0 2025-03-26 08:18:28 -06:00
.editorconfig version 1.0 2025-03-26 08:18:28 -06:00
.eslintrc version 1.0 2025-03-26 08:18:28 -06:00
.nycrc version 1.0 2025-03-26 08:18:28 -06:00
CHANGELOG.md version 1.0 2025-03-26 08:18:28 -06:00
LICENSE version 1.0 2025-03-26 08:18:28 -06:00
README.md version 1.0 2025-03-26 08:18:28 -06:00
index.d.ts version 1.0 2025-03-26 08:18:28 -06:00
index.js version 1.0 2025-03-26 08:18:28 -06:00
package.json version 1.0 2025-03-26 08:18:28 -06:00
tsconfig.json version 1.0 2025-03-26 08:18:28 -06:00

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