https://github.com/segment-boneyard/hash-mod

Node module to hash strings into numbers and then mod them into buckets
https://github.com/segment-boneyard/hash-mod

Last synced: about 5 hours ago
JSON representation

Node module to hash strings into numbers and then mod them into buckets

• Host: GitHub
• URL: https://github.com/segment-boneyard/hash-mod
• Owner: segment-boneyard
• Created: 2013-09-11T03:59:50.000Z (about 11 years ago)
• Default Branch: master
• Last Pushed: 2019-04-01T00:40:30.000Z (over 5 years ago)
• Last Synced: 2024-10-14T00:12:18.635Z (about 1 month ago)
• Language: JavaScript
• Size: 191 KB
• Stars: 8
• Watchers: 38
• Forks: 5
• Open Issues: 1
• Metadata Files:
  • Readme: Readme.md
  • Changelog: History.md

Awesome Lists containing this project

README

        

# hash-mod

  Hash strings into numbers and then mod them into buckets

## Install

    npm install hash-mod

## Example

```js

var mod = require('hash-mod')(100);

mod('string');

// 13

```

## CLI

```shell

$ hash-mod abvegegf --bins 100

49

```

## API

### hashMod(buckets)

  Returns a mod-hashing function that first takes the integer hash, and then mods it by `buckets`. Defaults to `100` buckets.

## License

```

WWWWWW||WWWWWW

 W W W||W W W

      ||

    ( OO )__________

     /  |           \

    /o o|    MIT     \

    \___/||_||__||_|| *

         || ||  || ||

        _||_|| _||_||

       (__|__|(__|__|

```

Copyright (c) 2013 Segment.io <[email protected]>

Permission is hereby granted, free of charge, to any person obtaining

a copy of this software and associated documentation files (the

'Software'), to deal in the Software without restriction, including

without limitation the rights to use, copy, modify, merge, publish,

distribute, sublicense, and/or sell copies of the Software, and to

permit persons to whom the Software is furnished to do so, subject to

the following conditions:

The above copyright notice and this permission notice shall be

included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,

EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF

MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.

IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY

CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,

TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE

SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.