shorthash2
TypeScript icon, indicating that this package has built-in type declarations

1.0.5 • Public • Published

shorthash2

NPM

Build Status Codecov branch GitHub package.json version

Mainly based on shorthash (apparently abandoned), by Bibig, shorthash2 offers a small optimization in memory usage, small features, typescript declarations and is available for browser and nodejs.

  • A mini js lib to generate short, alpha-number, undecryptable and unique hash id from a long string (utf8 format).
  • Use shorthash2 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 shorthash2, 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 书本画, a book search engine in China.

Install

As NPM package:

$ npm i shorthash2

Or yarn...

$ yarn add shorthash2

Usage

import shortHash from "shorthash2";

shortHash('foobar@example.com');
// => Z1bL2tE

shortHash('my name is really big big and big...');
// => Z1TirWS

shortHash('万里长城永不倒。。。');
// => 2r6EFF

shortHash('和平');
// => 33NM

Development

  1. Clone repo
  2. Install dev dependencies: $ npm i
  3. Run tests: $ npm test

Package Sidebar

Install

npm i shorthash2

Weekly Downloads

3,528

Version

1.0.5

License

MIT

Unpacked Size

4.91 kB

Total Files

5

Last publish

Collaborators

  • jecsham