README.zh-CN.md

base64

Base64 编码、解码 JS 实现，支持长青浏览器和 Node.js，基于 base64-js 。 同时支持 URL安全的base64

特色

• 编码输入参数支持 string, number 和 bigint 类型
• 编码输入参数支持 ArrayBuffer 或者 Uint8Array
• 编码解码的实现： 浏览器下通过 TextEncoder/TextDecoder，Node.js 下通过 Buffer
• 编译输出多种模块格式 ESM，UMD，以及 CJS

浏览器需求

• 支持 TextEncoder 和 TextDecoder 功能
• text-encoding 补丁用于 Edge

Node.js 需求

• 对 bigint 进行 base64 编码需要版本 v10.4.0 及以上
• 若 base64 解码输出 utf-8 and utf-16le 之外的编码需要安装 ICU

安装

npm install @waiting/base64

Node.js 使用

详见 接口文档

编码

import { b64encode, b64fromBuffer, b64urlEncode } from '@waiting/base64'

b64encode('A') === 'QQ=='
b64encode('schöne') === 'c2Now7ZuZQ=='
b64encode(1n) === b64encode(1) // bigint -> 'MQ==' 
b64encode('𠮷') === b64encode('\uD842\uDFB7') === b64encode('\u{20BB7}') // '8KCutw=='

const u8arr = Uint8Array.from([0xe4, 0xb8, 0xad, 0xe6, 0x96, 0x87])
b64fromBuffer(u8arr) === b64encode('中文')  // '5Lit5paH'

// URL-safe
b64urlEncode('A') === 'QQ'
b64urlEncode('中文测试') === '5Lit5paH5rWL6K-V'

解码

import { b64decode, b64urlDecode } from '@waiting/base64'

b64decode('MQ==') === '1'
b64urlDecode('MQ') === '1'

转换

import { b64toURLSafe, b64fromURLSafe } from '@waiting/base64'

// base64 -> URL-safe base64
b64toURLSafe('QQ==') === 'QQ'
b64toURLSafe('5Lit5paH5rWL6K+V') === '5Lit5paH5rWL6K-V'

// URL-safe base64 -> base64
b64fromURLSafe('QQ') === 'QQ=='
b64fromURLSafe('0J_RgNC40LLQtdGCLCDQvNC40YAh') === '0J/RgNC40LLQtdGCLCDQvNC40YAh'

浏览器使用

详见 接口文档

ESM

<script type="module">
  import { b64encode, b64urlEncode } from './base64.esm.min.js' 
  
  console.log( b64encode('A') ) // 'QQ=='
  console.log( b64urlEncode('A') )  // 'QQ'
  console.log( b64encode('\uD842\uDFB7') ) // '8KCutw=='
</script>

UMD

<!-- Edge 补丁 
  Note: text-encoder-lite 不能正确处理四字节UTF-8字符，
  故使用 text-encoding 替代。
  see: https://github.com/solderjs/TextEncoderLite/issues/16
-->
<!--
<script src="https://raw.githubusercontent.com/inexorabletash/text-encoding/master/lib/encoding-indexes.js"></script>
<script src="https://raw.githubusercontent.com/inexorabletash/text-encoding/master/lib/encoding.js"></script>
-->
<script src="./base64.umd.min.js"></script>
<script>
  // 全局变量 base64
  console.log( base64.b64encode('A') )
  console.log( base64.b64urlEncode('A') )
  console.log( base64.b64encode('\uD842\uDFB7') )
</script>

测试

npm run test

# for browsers FireFox and Chrome
npm run test:browser

# for browsers all available on this client
cd .config && npm i
npm run browser:detect

Demo

• Browser
• Node.js

License

MIT

Languages

• English
• 中文