README.zh_CN.md

egg-hashids

Hashids 是一个小型 JavaScript 库，可以从数字中生成类似 YouTube 的 ID。 当您不希望向用户公开数据库真实 ID 时可以使用它。

此插件仅用于 egg.js。

安装

$ npm i eggjs-hashids --save

开启插件

// config/plugin.js
exports.hashids = {
  enable: true,
  package: 'eggjs-hashids',
};

详细配置

// {app_root}/config/config.default.js
exports.hashids = {
  salt: '',
  minLength: 0,
  alphabet: 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890',
};

有关更多详细信息，请参阅 config/config.default.js 和 hashids 。

使用方法

this.app.hashids.encode(1);   // => 'jR'
this.app.hashids.decode('jR'); // => [ 1 ]
this.app.hashids.encodeHex('507f1f77bcf86cd799439011'); // => 'y42LW46J9luq3Xq9XMly'
this.app.hashids.decodeHex('y42LW46J9luq3Xq9XMly'); // => '507f1f77bcf86cd799439011'

提问交流

请到 egg issues 异步交流。

License

MIT