https://github.com/weihongyu12/egg-hashids

Generate a short unique ID from the integer for egg.js
https://github.com/weihongyu12/egg-hashids

Last synced: 2 months ago
JSON representation

Generate a short unique ID from the integer for egg.js

• Host: GitHub
• URL: https://github.com/weihongyu12/egg-hashids
• Owner: weihongyu12
• License: mit
• Created: 2018-09-18T12:06:20.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2021-03-25T07:07:07.000Z (almost 4 years ago)
• Last Synced: 2024-04-28T20:06:17.759Z (8 months ago)
• Language: JavaScript
• Size: 78.1 KB
• Stars: 9
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-egg - egg-hashids - generate a short unique ID from the integer for eg (Plugins)

README

        
# egg-hashids

[![NPM version][npm-image]][npm-url]

[![build status][travis-image]][travis-url]

[![Test coverage][codecov-image]][codecov-url]

[![David deps][david-image]][david-url]

[![Known Vulnerabilities][snyk-image]][snyk-url]

[![npm download][download-image]][download-url]

[npm-image]: https://img.shields.io/npm/v/eggjs-hashids.svg?style=flat-square

[npm-url]: https://npmjs.org/package/eggjs-hashids

[travis-image]: https://img.shields.io/travis/weihongyu12/egg-hashids.svg?style=flat-square

[travis-url]: https://travis-ci.org/weihongyu12/egg-hashids

[codecov-image]: https://img.shields.io/codecov/c/github/weihongyu12/egg-hashids.svg?style=flat-square

[codecov-url]: https://codecov.io/github/weihongyu12/egg-hashids?branch=master

[david-image]: https://img.shields.io/david/weihongyu12/egg-hashids.svg?style=flat-square

[david-url]: https://david-dm.org/weihongyu12/egg-hashids

[snyk-image]: https://snyk.io/test/npm/eggjs-hashids/badge.svg?style=flat-square

[snyk-url]: https://snyk.io/test/npm/eggjs-hashids

[download-image]: https://img.shields.io/npm/dm/eggjs-hashids.svg?style=flat-square

[download-url]: https://npmjs.org/package/eggjs-hashids

[Hashids](https://www.npmjs.com/package/hashids) is small JavaScript library to generate YouTube-like ids from numbers. Use it when you don't want to expose your database ids to the user.

> This plugin is only for [egg.js](https://eggjs.org/)

## Install

```bash

$ npm i eggjs-hashids --save

```

## Usage

```js

// {app_root}/config/plugin.js

exports.hashids = {

  enable: true,

  package: 'eggjs-hashids',

};

```

## Configuration

```javascript

// {app_root}/config/config.default.js

exports.hashids = {

  salt: '',

  minLength: 0,

  alphabet: 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890',

};

```

see [config/config.default.js](config/config.default.js) and [hashids](https://www.npmjs.com/package/hashids) for more detail.

## Example

```javascript

this.app.hashids.encode(1);   // => 'jR'

this.app.hashids.decode('jR'); // => [ 1 ]

this.app.hashids.encodeHex('507f1f77bcf86cd799439011'); // => 'y42LW46J9luq3Xq9XMly'

this.app.hashids.decodeHex('y42LW46J9luq3Xq9XMly'); // => '507f1f77bcf86cd799439011'

```

## Questions & Suggestions

Please open an issue [here](https://github.com/weihongyu12/egg-hashids/issues).

## License

[MIT](LICENSE)