# sized-map

> ES6 Map with a configurable max size.

Latest version **1.1.0** (published 2023-02-13) · MIT license · 0 weekly downloads

## Install

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

## Health

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

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.0 |
| Published | 2023-02-13 |
| First published | 2022-02-25 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM |
| Dependencies | 0 |
| Unpacked size | 10.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | bitomic |
| Maintainers | bitomic |
| Keywords | map, sized, sized map, collection |

## Links

- npm: https://www.npmjs.com/package/sized-map
- npm.io page: https://npm.io/package/sized-map

## Recent versions

- 1.1.0 (latest) — 2023-02-13
- 1.0.3 — 2022-02-25
- 1.0.2 — 2022-02-25
- 1.0.0 — 2022-02-25
- 0.0.1 — 2022-02-25

## README

# Sized Map
> ES6 Map with a configurable max size.

![npm](https://img.shields.io/npm/v/sized-map)
![NPM](https://img.shields.io/npm/l/sized-map)

## Features
* Written using TypeScript (and thus fully typed, supporting TypeScript and JavaScript).
* Lightweight.
* Same interface as [ECMAScript's Map](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map), you can substitute it **almost** seamlessly (only need to set its `maxSize` in the constructor).
* Supports ESM and CJS.

## Installation
```
# npm
npm i sized-map

# yarn
yarn add sized-map
```

## Usage
> The following examples use TypeScript and ESM `import ... from ...`, but it works the same with JavaScript and/or CJS.

Create a new instance:
```ts
import SizedMap from 'sized-map'
const map = new Map<string, number>(3)
```

Add keys and values:
```ts
map.set('a', 1)
map.set('b', 2)
map.set('c', 3)
console.log(map)
// SizedMap(3) [Map] { 'a' => 1, 'b' => 2, 'c' => 3 }
```

When you try to set a new key and it has reached its max length, it will remove the oldest key.

```ts
map.set('d', 4)
console.log(map)
// SizedMap(3) [Map] { 'b' => 2, 'c' => 3, 'd' => 4 }
```

You can also change the max size of an already created `SizedMap`:

```ts
map.maxSize = 1
console.log(map)
// SizedMap(1) [Map] { 'd' => 4 }
```

If the `newSize` is smaller than its `originalSize`, it will remove `originalSize - newSize` elements, keeping the most recent ones.

## Notes
Setting an already set key will be treated as a new key. In the following example, `a` isn't removed because it was re-set after `b`.

```ts
const map = new Map<string, number>(2)
map.set('a', 1)
map.set('b', 2)
map.set('a', 3)
map.set('c', 4)
map.set('d', 5)
// SizedMap(3) [Map] { 'a' => 3, 'c' => 4, 'd' => 5 }
```

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