z85-codec
TypeScript icon, indicating that this package has built-in type declarations

0.1.0 • Public • Published

z85-codec

NPM Coverage Status

Z85 - ZeroMQ's ascii85 encoding format

Why should i use this package instead of z85?

This package and z85 uses the same reference implementation provided by ZeroMQ. The difference is that this library provides Typescript declarations and uses typed arrays to be compatible in the browser.

API

encode(data: Uint8Array | string): string | null

Encode data with the Z85 codec

Parameters

  • data: Uint8Array | string - data to encode
    • Data length must be divisible by 4
    • String encoding must be UTF-8

Returns

  • string - encoded data
  • null - when data length is not divisible by 4

decode(string: string): Uint8Array | null

Decode data with the Z85 codec

Parameters

  • string - string to decode
    • Length must be divisible by 5
    • Encoding must be UTF-8

Returns

  • Uint8Array - decoded string
  • null - when data length is not divisible by 5 or string includes invalid characters

License

Licensed under the MIT License.

Package Sidebar

Install

npm i z85-codec

Weekly Downloads

119

Version

0.1.0

License

MIT

Unpacked Size

40.2 kB

Total Files

14

Last publish

Collaborators

  • matthiasschwarz