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

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