Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
30 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
node_modules/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,30 @@ | ||
node-shorthash | ||
============== | ||
# shorthash | ||
|
||
get an unique short hash of a string | ||
A mini Node.js module to generate short, alpha-number, undecryptable and unique hash id from a long string (utf8 format). | ||
Use shorthash when you want to encrypt a string like a movie name or a people name to a short, unique and url friendly id. | ||
so with shorthash, you can build an id-string map. | ||
instead of quering the id from db each time, you just calculate the id out on the fly. | ||
it's quite convenient in many conditions if you want to build a site like (书本画)[http://shubenhua.com], a books search engine in China. | ||
|
||
|
||
## Usage | ||
|
||
#### less's more, no options, just unique the string. | ||
|
||
```javascript | ||
|
||
var sh = require("shorthash"); | ||
|
||
console.log(sh.unique('foobar@example.com')); | ||
// you will get: Z1bL2tE | ||
|
||
console.log(sh.unique('my name is really big big and big...')); | ||
// you will get: Z1TirWS | ||
|
||
console.log(sh.unique('万里长城永不倒。。。')); | ||
// you will get: 2r6EFF | ||
|
||
console.log(sh.unique('和平')); | ||
// you will get: 33NM | ||
|
||
``` |