MIF_E31222519/API/node_modules/side-channel
MOH. DANI KURNIAWAN SUGIARTO c0b8fc8fee first commit 2025-05-15 16:08:48 +07:00
..
.github first commit 2025-05-15 16:08:48 +07:00
test first commit 2025-05-15 16:08:48 +07:00
.editorconfig first commit 2025-05-15 16:08:48 +07:00
.eslintrc first commit 2025-05-15 16:08:48 +07:00
.nycrc first commit 2025-05-15 16:08:48 +07:00
CHANGELOG.md first commit 2025-05-15 16:08:48 +07:00
LICENSE first commit 2025-05-15 16:08:48 +07:00
README.md first commit 2025-05-15 16:08:48 +07:00
index.d.ts first commit 2025-05-15 16:08:48 +07:00
index.js first commit 2025-05-15 16:08:48 +07:00
package.json first commit 2025-05-15 16:08:48 +07:00
tsconfig.json first commit 2025-05-15 16:08:48 +07: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