e 92fdcc4d2a ts 10 månader sedan
..
.github 92fdcc4d2a ts 10 månader sedan
test 92fdcc4d2a ts 10 månader sedan
.editorconfig 92fdcc4d2a ts 10 månader sedan
.eslintrc 92fdcc4d2a ts 10 månader sedan
.nycrc 92fdcc4d2a ts 10 månader sedan
CHANGELOG.md 92fdcc4d2a ts 10 månader sedan
LICENSE 92fdcc4d2a ts 10 månader sedan
README.md 92fdcc4d2a ts 10 månader sedan
index.d.ts 92fdcc4d2a ts 10 månader sedan
index.js 92fdcc4d2a ts 10 månader sedan
package.json 92fdcc4d2a ts 10 månader sedan
tsconfig.json 92fdcc4d2a ts 10 månader 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