opusdev/vector-similarity-api

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 10Store information about any JS value in a side channel. Uses WeakMap if available.11 12Warning: in an environment that lacks `WeakMap`, this implementation will leak memory until you `delete` the `key`.13 14## Getting started15 16```sh17npm install --save side-channel18```19 20## Usage/Examples21 22```js23const assert = require('assert');24const getSideChannel = require('side-channel');25 26const channel = getSideChannel();27 28const key = {};29assert.equal(channel.has(key), false);30assert.throws(() => channel.assert(key), TypeError);31 32channel.set(key, 42);33 34channel.assert(key); // does not throw35assert.equal(channel.has(key), true);36assert.equal(channel.get(key), 42);37 38channel.delete(key);39assert.equal(channel.has(key), false);40assert.throws(() => channel.assert(key), TypeError);41```42 43## Tests44 45Clone the repo, `npm install`, and run `npm test`46 47[package-url]: https://npmjs.org/package/side-channel48[npm-version-svg]: https://versionbadg.es/ljharb/side-channel.svg49[deps-svg]: https://david-dm.org/ljharb/side-channel.svg50[deps-url]: https://david-dm.org/ljharb/side-channel51[dev-deps-svg]: https://david-dm.org/ljharb/side-channel/dev-status.svg52[dev-deps-url]: https://david-dm.org/ljharb/side-channel#info=devDependencies53[npm-badge-png]: https://nodei.co/npm/side-channel.png?downloads=true&stars=true54[license-image]: https://img.shields.io/npm/l/side-channel.svg55[license-url]: LICENSE56[downloads-image]: https://img.shields.io/npm/dm/side-channel.svg57[downloads-url]: https://npm-stat.com/charts.html?package=side-channel58[codecov-image]: https://codecov.io/gh/ljharb/side-channel/branch/main/graphs/badge.svg59[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-channel61[actions-url]: https://github.com/ljharb/side-channel/actions62