# consistent

> Consistent hashing for Node.JS

Latest version **1.1.0** (published 2015-01-05) · MIT license · 0 weekly downloads

## Install

```sh
npm install consistent
pnpm add consistent
yarn add consistent
bun add consistent
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.0 |
| Published | 2015-01-05 |
| First published | 2014-12-06 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Ekin Koc |
| Maintainers | eknkc |
| Keywords | consistent, hashing |

## Links

- npm: https://www.npmjs.com/package/consistent
- Repository: https://github.com/eknkc/consistent
- Issues: https://github.com/eknkc/consistent/issues
- npm.io page: https://npm.io/package/consistent

## Dependencies (2)

- [lru-cache](https://npm.io/package/lru-cache.md) ^2.5.0
- [murmurhash](https://npm.io/package/murmurhash.md) 0.0.2

## Alternatives

- [@gemini-wallet/core](https://npm.io/package/@gemini-wallet/core.md) — 515.6K weekly downloads
- [utility](https://npm.io/package/utility.md) — 416.6K weekly downloads
- [@primno/dpapi](https://npm.io/package/@primno/dpapi.md) — 7.2K weekly downloads
- [pi-readseek](https://npm.io/package/pi-readseek.md) — 3.7K weekly downloads
- [@emilia-protocol/verify](https://npm.io/package/@emilia-protocol/verify.md) — 1.1K weekly downloads

## Recent versions

- 1.1.0 (latest) — 2015-01-05
- 1.0.3 — 2014-12-15
- 1.0.2 — 2014-12-08
- 1.0.1 — 2014-12-06
- 1.0.0 — 2014-12-06

## README

# consistent
Consistent hashing module for Node.JS

## installation

```
npm install consistent
```

## usage

```js
var consistent = require('consistent');

var ring = consistent({
  members: [
    "member1",
    "member2",
    {
      key: "member3",
      weight: 1.5 // optional, default weight is 1
    }
  ],
  hash: 'md5' // can use 'md5' or 'murmurhash'
});

console.log(ring.get('some key'));
// outputs member1 or member2 or member3
```

## api

### add member
adds a new member

```js
ring.add('member4');
// or
ring.add({
  key: "member4",
  weight: 3
})
```

### remove member
removes a member

```js
ring.remove("member2")
```

### replace member
this preserves the hash slots of old member, if you want to recalculate hashes for the new member, just remove the old one and add the new one.

```js
ring.replace('member1', 'member5');
```

### get member for hash slot

```js
ring.get('some key');
ring.getCached('some key'); //use lru cache
```

### check if a member exists

```js
ring.exists('member1') // returns true if a member has been added with name member1
```

### get member count

```js
ring.length; // returns number of members within the ring
```

## author
Ekin Koc

## license
MIT

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