opusdev/vector-similarity-api

1# side-channel-map <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, using a Map.11 12Warning: if the `key` is an object, this implementation will leak memory until you `delete` it.13Use [`side-channel`](https://npmjs.com/side-channel) for the best available strategy.14 15## Getting started16 17```sh18npm install --save side-channel-map19```20 21## Usage/Examples22 23```js24const assert = require('assert');25const getSideChannelMap = require('side-channel-map');26 27const channel = getSideChannelMap();28 29const key = {};30assert.equal(channel.has(key), false);31assert.throws(() => channel.assert(key), TypeError);32 33channel.set(key, 42);34 35channel.assert(key); // does not throw36assert.equal(channel.has(key), true);37assert.equal(channel.get(key), 42);38 39channel.delete(key);40assert.equal(channel.has(key), false);41assert.throws(() => channel.assert(key), TypeError);42```43 44## Tests45 46Clone the repo, `npm install`, and run `npm test`47 48[package-url]: https://npmjs.org/package/side-channel-map49[npm-version-svg]: https://versionbadg.es/ljharb/side-channel-map.svg50[deps-svg]: https://david-dm.org/ljharb/side-channel-map.svg51[deps-url]: https://david-dm.org/ljharb/side-channel-map52[dev-deps-svg]: https://david-dm.org/ljharb/side-channel-map/dev-status.svg53[dev-deps-url]: https://david-dm.org/ljharb/side-channel-map#info=devDependencies54[npm-badge-png]: https://nodei.co/npm/side-channel-map.png?downloads=true&stars=true55[license-image]: https://img.shields.io/npm/l/side-channel-map.svg56[license-url]: LICENSE57[downloads-image]: https://img.shields.io/npm/dm/side-channel-map.svg58[downloads-url]: https://npm-stat.com/charts.html?package=side-channel-map59[codecov-image]: https://codecov.io/gh/ljharb/side-channel-map/branch/main/graphs/badge.svg60[codecov-url]: https://app.codecov.io/gh/ljharb/side-channel-map/61[actions-image]: https://img.shields.io/endpoint?url=https://github-actions-badge-u3jn4tfpocch.runkit.sh/ljharb/side-channel-map62[actions-url]: https://github.com/ljharb/side-channel-map/actions63