@sumor/short-id

short-id

一个Sumor Cloud工具。
更多文档

这是一个用于 Node.js 和浏览器的 short-id 库。 您可以轻松使用它从数字生成一个短 id。

CI Test Coverage Audit

安装

npm i @sumor/short-id --save

先决条件

Node.JS 版本

需要 Node.JS 版本 18.x 或以上

需要 Node.JS ES 模块

由于此包是用 ES 模块编写的, 请在您的 package.json 文件中更改以下代码:

{
  "type": "module"
}

用法

标准用法

import { encode, decode } from '@sumor/short-id'

// 默认使用规则 0123456789abcdefghigklmnopqrstuvwxyzABCDEFGHIGKLMNOPQRSTUVWXYZ
const shortId1 = encode(10)
console.log(shortId1) // 'a'
const shortId2 = encode(72)
console.log(shortId2) // '1a'

const number1 = decode('a')
console.log(number1) // 10
const number2 = decode('1a')
console.log(number2) // 72

自定义用法

import { encode, decode } from '@sumor/short-id'

const rule = '0123456789abcdefghigklmnopqrstuvwxyz'
const shortId1 = encode(10, rule)
console.log(shortId1) // 'a'
const shortId2 = encode(46, rule)
console.log(shortId2) // '1a'

const number1 = decode('a', rule)
console.log(number1) // 10
const number2 = decode('1a', rule)
console.log(number2) // 46