| 1 | # side-channel <sup>[![Version Badge][npm-version-svg]][package-url]</sup>
|
|---|
| 2 |
|
|---|
| 3 | [![github actions][actions-image]][actions-url]
|
|---|
| 4 | [![coverage][codecov-image]][codecov-url]
|
|---|
| 5 | [![License][license-image]][license-url]
|
|---|
| 6 | [![Downloads][downloads-image]][downloads-url]
|
|---|
| 7 |
|
|---|
| 8 | [![npm badge][npm-badge-png]][package-url]
|
|---|
| 9 |
|
|---|
| 10 | Store information about any JS value in a side channel. Uses WeakMap if available.
|
|---|
| 11 |
|
|---|
| 12 | Warning: in an environment that lacks `WeakMap`, this implementation will leak memory until you `delete` the `key`.
|
|---|
| 13 |
|
|---|
| 14 | ## Getting started
|
|---|
| 15 |
|
|---|
| 16 | ```sh
|
|---|
| 17 | npm install --save side-channel
|
|---|
| 18 | ```
|
|---|
| 19 |
|
|---|
| 20 | ## Usage/Examples
|
|---|
| 21 |
|
|---|
| 22 | ```js
|
|---|
| 23 | const assert = require('assert');
|
|---|
| 24 | const getSideChannel = require('side-channel');
|
|---|
| 25 |
|
|---|
| 26 | const channel = getSideChannel();
|
|---|
| 27 |
|
|---|
| 28 | const key = {};
|
|---|
| 29 | assert.equal(channel.has(key), false);
|
|---|
| 30 | assert.throws(() => channel.assert(key), TypeError);
|
|---|
| 31 |
|
|---|
| 32 | channel.set(key, 42);
|
|---|
| 33 |
|
|---|
| 34 | channel.assert(key); // does not throw
|
|---|
| 35 | assert.equal(channel.has(key), true);
|
|---|
| 36 | assert.equal(channel.get(key), 42);
|
|---|
| 37 |
|
|---|
| 38 | channel.delete(key);
|
|---|
| 39 | assert.equal(channel.has(key), false);
|
|---|
| 40 | assert.throws(() => channel.assert(key), TypeError);
|
|---|
| 41 | ```
|
|---|
| 42 |
|
|---|
| 43 | ## Tests
|
|---|
| 44 |
|
|---|
| 45 | Clone the repo, `npm install`, and run `npm test`
|
|---|
| 46 |
|
|---|
| 47 | [package-url]: https://npmjs.org/package/side-channel
|
|---|
| 48 | [npm-version-svg]: https://versionbadg.es/ljharb/side-channel.svg
|
|---|
| 49 | [deps-svg]: https://david-dm.org/ljharb/side-channel.svg
|
|---|
| 50 | [deps-url]: https://david-dm.org/ljharb/side-channel
|
|---|
| 51 | [dev-deps-svg]: https://david-dm.org/ljharb/side-channel/dev-status.svg
|
|---|
| 52 | [dev-deps-url]: https://david-dm.org/ljharb/side-channel#info=devDependencies
|
|---|
| 53 | [npm-badge-png]: https://nodei.co/npm/side-channel.png?downloads=true&stars=true
|
|---|
| 54 | [license-image]: https://img.shields.io/npm/l/side-channel.svg
|
|---|
| 55 | [license-url]: LICENSE
|
|---|
| 56 | [downloads-image]: https://img.shields.io/npm/dm/side-channel.svg
|
|---|
| 57 | [downloads-url]: https://npm-stat.com/charts.html?package=side-channel
|
|---|
| 58 | [codecov-image]: https://codecov.io/gh/ljharb/side-channel/branch/main/graphs/badge.svg
|
|---|
| 59 | [codecov-url]: https://app.codecov.io/gh/ljharb/side-channel/
|
|---|
| 60 | [actions-image]: https://img.shields.io/endpoint?url=https://github-actions-badge-u3jn4tfpocch.runkit.sh/ljharb/side-channel
|
|---|
| 61 | [actions-url]: https://github.com/ljharb/side-channel/actions
|
|---|
