e 92fdcc4d2a ts 10 ماه پیش
..
.github 92fdcc4d2a ts 10 ماه پیش
test 92fdcc4d2a ts 10 ماه پیش
.editorconfig 92fdcc4d2a ts 10 ماه پیش
.eslintrc 92fdcc4d2a ts 10 ماه پیش
.nycrc 92fdcc4d2a ts 10 ماه پیش
CHANGELOG.md 92fdcc4d2a ts 10 ماه پیش
LICENSE 92fdcc4d2a ts 10 ماه پیش
README.md 92fdcc4d2a ts 10 ماه پیش
index.d.ts 92fdcc4d2a ts 10 ماه پیش
index.js 92fdcc4d2a ts 10 ماه پیش
package.json 92fdcc4d2a ts 10 ماه پیش
tsconfig.json 92fdcc4d2a ts 10 ماه پیش

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