Skip to main content
版本:v3+

cborEncode

API_LEVEL 5.0 开始支持,API 兼容性请参考 API_LEVEL。

将 JS 值编码为 CBOR 格式的 ArrayBuffer,适合需要 CBOR 格式的数据交换。若仅用于应用内持久化,推荐使用 JS 引擎内置的 valueToBuffer,稳定、可靠、高效,无需预估缓冲区大小。

类型​

function cborEncode(value: InputValue, estimatedSize?: EstimatedSize): Result

参数​

InputValue​

类型说明
unknown需要编码的 JS 值

EstimatedSize​

类型说明
number预估编码后的二进制大小,单位为字节。可选,内部默认 2KB(2048 字节),最大 32KB(32768 字节)。预估值应不小于实际编码大小,也不宜过大;预估不当可能影响性能

Result​

类型说明
ArrayBufferCBOR 编码后的 ArrayBuffer

代码示例​

import { cborEncode, cborDecode } from '@zos/utils'

const value = { enabled: true, count: 3 }
const buffer = cborEncode(value, 2 * 1024)
console.log(cborDecode(buffer))