# large-map

> A wrapper to deal with a large number of elements in Map.

Latest version **1.0.0** (published 2023-04-09) · MIT license · 0 weekly downloads

## Install

```sh
npm install large-map
pnpm add large-map
yarn add large-map
bun add large-map
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2023-04-09 |
| First published | 2023-04-09 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 8.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 5 |
| Author | Aldi Permana Etika Putra |
| Maintainers | aldipermanaetikaputra |
| Keywords | map, big-map, large-map |

## Links

- npm: https://www.npmjs.com/package/large-map
- Repository: https://github.com/aldipermanaetikaputra/large-map
- Issues: https://github.com/aldipermanaetikaputra/large-map/issues
- npm.io page: https://npm.io/package/large-map

## Alternatives

- [random-seedable](https://npm.io/package/random-seedable.md) — 27.9K weekly downloads
- [n2words](https://npm.io/package/n2words.md) — 22.2K weekly downloads
- [@stdlib/math-base-special-factorialln](https://npm.io/package/@stdlib/math-base-special-factorialln.md) — 5.7K weekly downloads
- [@stdlib/math-base-special-abs2](https://npm.io/package/@stdlib/math-base-special-abs2.md) — 1.7K weekly downloads
- [commons-math-interpolation](https://npm.io/package/commons-math-interpolation.md) — 1.4K weekly downloads

## Recent versions

- 1.0.0 (latest) — 2023-04-09

## README

# LargeMap

`LargeMap` is a wrapper for the built-in `Map` data structure that enables storage and handling of a large number of elements without worrying about the maximum limit of 16.777.216 (2^24) entries in a `Map`. However, `LargeMap` is optimized to handle a much larger number of elements than the built-in `Map` while maintaining high performance. It has zero external dependencies and written in TypeScript.

```js
import LargeMap from 'large-map';

// using LargeMap
const largeMap = new LargeMap();
for (let i = 0; i <= 16777216; i++) {
  largeMap.set(i, 1); // No errors will be thrown
}

// using built-in Map
const map = new Map();
for (let i = 0; i <= 16777216; i++) {
  map.set(i, 1); // Throws a 'RangeError: Value undefined out of range for undefined options property undefined'
}
```

## Install

```bash
# using npm
npm install large-map
# using yarn
yarn add large-map
```

## Usage

`LargeMap` has the identical interface as built-in `Map`, which means that it can be used in the same way as `Map`.

```js
import LargeMap from 'large-map';

const map = new LargeMap();

map.set('foo', 'hello');
map.set('bar', 'world');

console.log(map.has('foo')); // true
console.log(map.has('baz')); // false
console.log(map.size); // 2
console.log(map.get('bar')); // 'world'
```

## Limitations

The `LargeMap` class is designed for use cases where the size of the map may exceed the maximum limit of a built-in `Map`. However, it is not a drop-in replacement for `Map`, and may not be suitable for all use cases. Additionally, the partitioning of the map into smaller maps can incur a performance penalty, particularly for operations that involve searching for elements or iterating over the map. It is recommended to use `LargeMap` only when dealing with very large maps, and to test its performance against built-in `Map` for your specific use case.

## Related

- [large-set](https://github.com/aldipermanaetikaputra/large-set) - A wrapper to deal with a large number of elements in Set.

## Testing

This library is well tested. You can test the code as follows:

```bash
# using npm
npm test
# using yarn
yarn test
```

## Contribute

If you have anything to contribute, or functionality that you lack - you are more than welcome to participate in this!

## License

Feel free to use this library under the conditions of the MIT license.

---
_Source: https://npm.io/package/large-map · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._