Skip to content

Generate readable hash or encoding in the style of license plates 📦 鄂A·22391

License

Notifications You must be signed in to change notification settings

Leizhenpeng/platecode

Repository files navigation

platecode

npm version npm downloads bundle JSDocs License

Generate readable hashes or encodings in the style of license plates

platecode 是一个 JavaScript 库,用于生成类似车牌的可读哈希或 Base32 编码,使其更加有趣和直观。

Features

  • 车牌风格的哈希: 使用 hash 函数可以生成带有或不带有表情符号的车牌风格哈希。
  • Base32 编码和解码: 支持通过 encodedecode 函数对字符串进行车牌风格的 Base32 编码和解码。
  • 定制选项: 支持在编码和哈希时选择是否包含表情符号。

Usage

Hash

import { hash } from 'platecode'

const hash = hash('hello world')
console.log(hash1) // '🍢 渝F·WGVA2 🪣

const encoded = encode('hello world', { emoji: false })
console.log(encoded) // '渝F·WGVA2'

Encoding and Decoding

import { decode, encode } from 'platecode'

const result = encode('hello world')
console.log(result) // 🎤 辽U·JBSWY 🥚 藏P·3DPFQ 🐟 苏H·QFO33 👞 湘U·SNRSC 🚿 琼M·CAAAA 🐱

const decoded = decode(result)
console.log(decoded) // 'hello world'

Credit

Thanks to my friend cunzaizhuyi for the new repository hashplate-cn, which I find quite interesting.

Since hash has its limitations, I'm considering giving encoding a try

License

MIT License © 2023-PRESENT leizhenpeng