diff options
| author | pack <pack@packgekko.xyz> | 2026-08-09 10:54:08 +0000 |
|---|---|---|
| committer | pack <pack@packgekko.xyz> | 2026-08-09 10:54:08 +0000 |
| commit | d3adc16a08d95d6e331de55d7d3bf05a66a874a8 (patch) | |
| tree | a2dabd199501e67c547c2ce79e1374ca3aa55443 /node_modules/side-channel-map/README.md | |
| parent | 55a4f1fc869e41aca748c63d3018f0448b1606e0 (diff) | |
| download | crud-d3adc16a08d95d6e331de55d7d3bf05a66a874a8.tar.gz | |
stop tracking node_modules/
Diffstat (limited to '')
| -rw-r--r-- | node_modules/side-channel-map/README.md | 62 |
1 files changed, 0 insertions, 62 deletions
diff --git a/node_modules/side-channel-map/README.md b/node_modules/side-channel-map/README.md deleted file mode 100644 index 8fa6f77..0000000 --- a/node_modules/side-channel-map/README.md +++ /dev/null @@ -1,62 +0,0 @@ -# side-channel-map <sup>[![Version Badge][npm-version-svg]][package-url]</sup> - -[![github actions][actions-image]][actions-url] -[![coverage][codecov-image]][codecov-url] -[![License][license-image]][license-url] -[![Downloads][downloads-image]][downloads-url] - -[![npm badge][npm-badge-png]][package-url] - -Store information about any JS value in a side channel, using a Map. - -Warning: if the `key` is an object, this implementation will leak memory until you `delete` it. -Use [`side-channel`](https://npmjs.com/side-channel) for the best available strategy. - -## Getting started - -```sh -npm install --save side-channel-map -``` - -## Usage/Examples - -```js -const assert = require('assert'); -const getSideChannelMap = require('side-channel-map'); - -const channel = getSideChannelMap(); - -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` - -[package-url]: https://npmjs.org/package/side-channel-map -[npm-version-svg]: https://versionbadg.es/ljharb/side-channel-map.svg -[deps-svg]: https://david-dm.org/ljharb/side-channel-map.svg -[deps-url]: https://david-dm.org/ljharb/side-channel-map -[dev-deps-svg]: https://david-dm.org/ljharb/side-channel-map/dev-status.svg -[dev-deps-url]: https://david-dm.org/ljharb/side-channel-map#info=devDependencies -[npm-badge-png]: https://nodei.co/npm/side-channel-map.png?downloads=true&stars=true -[license-image]: https://img.shields.io/npm/l/side-channel-map.svg -[license-url]: LICENSE -[downloads-image]: https://img.shields.io/npm/dm/side-channel-map.svg -[downloads-url]: https://npm-stat.com/charts.html?package=side-channel-map -[codecov-image]: https://codecov.io/gh/ljharb/side-channel-map/branch/main/graphs/badge.svg -[codecov-url]: https://app.codecov.io/gh/ljharb/side-channel-map/ -[actions-image]: https://img.shields.io/endpoint?url=https://github-actions-badge-u3jn4tfpocch.runkit.sh/ljharb/side-channel-map -[actions-url]: https://github.com/ljharb/side-channel-map/actions |