zheng 3cabbb3159 webpack 18 timmar sedan
..
.github 3cabbb3159 webpack 18 timmar sedan
test 3cabbb3159 webpack 18 timmar sedan
.editorconfig 3cabbb3159 webpack 18 timmar sedan
.eslintrc 3cabbb3159 webpack 18 timmar sedan
.nycrc 3cabbb3159 webpack 18 timmar sedan
CHANGELOG.md 3cabbb3159 webpack 18 timmar sedan
LICENSE 3cabbb3159 webpack 18 timmar sedan
README.md 3cabbb3159 webpack 18 timmar sedan
index.d.ts 3cabbb3159 webpack 18 timmar sedan
index.js 3cabbb3159 webpack 18 timmar sedan
package.json 3cabbb3159 webpack 18 timmar sedan
tsconfig.json 3cabbb3159 webpack 18 timmar sedan

README.md

side-channel-weakmap Version Badge

github actions coverage License Downloads

npm badge

Store information about any JS value in a side channel. Uses WeakMap if available.

Warning: this implementation will leak memory until you delete the key. Use side-channel for the best available strategy.

Getting started

npm install --save side-channel-weakmap

Usage/Examples

const assert = require('assert');
const getSideChannelList = require('side-channel-weakmap');

const channel = getSideChannelList();

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