ljoaquim 1590311121 first commit 10 months ago
..
.github 1590311121 first commit 10 months ago
test 1590311121 first commit 10 months ago
.editorconfig 1590311121 first commit 10 months ago
.eslintrc 1590311121 first commit 10 months ago
.nycrc 1590311121 first commit 10 months ago
CHANGELOG.md 1590311121 first commit 10 months ago
LICENSE 1590311121 first commit 10 months ago
README.md 1590311121 first commit 10 months ago
index.d.ts 1590311121 first commit 10 months ago
index.js 1590311121 first commit 10 months ago
list.d.ts 1590311121 first commit 10 months ago
package.json 1590311121 first commit 10 months ago
tsconfig.json 1590311121 first commit 10 months ago

README.md

side-channel-list Version Badge

github actions coverage License Downloads

npm badge

Store information about any JS value in a side channel, using a linked list.

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-list

Usage/Examples

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

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