https://github.com/eknkc/consistent

Fast consistent hashing module for Node.JS
https://github.com/eknkc/consistent

Last synced: 9 days ago
JSON representation

Fast consistent hashing module for Node.JS

• Host: GitHub
• URL: https://github.com/eknkc/consistent
• Owner: eknkc
• Created: 2014-12-06T00:15:41.000Z (about 10 years ago)
• Default Branch: master
• Last Pushed: 2015-01-05T00:31:47.000Z (almost 10 years ago)
• Last Synced: 2024-12-17T01:34:12.000Z (17 days ago)
• Language: JavaScript
• Size: 136 KB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

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