hashids-bn is small JavaScript library to generate YouTube-like ids from numbers. This fork uses BigNumber so that number isn't limited. http://hashids.org/javascript
Getting started
Install Hashids via:
- node.js:
npm install --save hashids-bn
This fork is only intended to use in nodejs server (> 10), but modern browser should also work.
Use in Node.js:
var Hashids = ;var hashids = ; console;
Quick example
var hashids = ; var id = hashids; // o2fXhVvar numbers = hashids; // [1, 2, 3]
More options
A few more ways to pass to encode()
:
var hashids = ; console; // o2fXhV
Make your ids unique:
Pass a project name to make your ids unique:
var hashids = 'My Project';console; // Z4UrtW var hashids = 'My Other Project';console; // gPUasb
Use padding to make your ids longer:
Note that ids are only padded to fit at least a certain length. It doesn't mean that your ids will be exactly that length.
var hashids = ; // no paddingconsole; // jR var hashids = '' 10; // pad to length 10console; // VolejRejNm
Pass a custom alphabet:
var hashids = '' 0 'abcdefghijklmnopqrstuvwxyz'; // all lowercaseconsole; // mdfphx
Default alphabet is abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890
.
Pitfalls
-
When decoding, output is always an array of numbers (even if you encode only one number):
var hashids = ;var id = hashids;console; // [1] -
Encoding negative numbers is not supported.
-
If you pass bogus input to
encode()
, a TypeError is raised:var hashids = ;var id = hashids; // TypeError -
Do not use this library as a security tool and do not encode sensitive data. This is not an encryption library.
Randomness
The primary purpose of Hashids is to obfuscate ids. It's not meant or tested to be used as a security or compression tool. Having said that, this algorithm does try to make these ids random and unpredictable:
No repeating patterns showing there are 3 identical numbers in the id:
var hashids = ;console; // A6t1tQ
Same with incremented numbers:
var hashids = ; console; // wpfLh9iwsqt0uyCEFjHM console; // jRconsole; // k5console; // l5console; // mOconsole; // nR
Curses! #$%@
This code was written with the intent of placing created ids in visible places, like the URL. Therefore, the algorithm tries to avoid generating most common English curse words by generating ids that never have the following letters next to each other:
c, f, h, i, s, t, u
License
MIT