⛔️ DEPRECATED: This module has been superseded by the multiformats module

js-multibase

JavaScript implementation of the multibase specification

Lead Maintainer

Hugo Dias

Table of Contents

• Install
  • NPM
  • Browser through <script> tag
• Usage
  • Example
• API
• Contribute
• License

Install

NPM

$ npm install --save multibase

Browser through <script> tag

Loading this module through a script tag will make the Multibase obj available in the global namespace.

<script src="https://unpkg.com/multibase/dist/index.min.js"></script>

Usage

Example

const multibase = require('multibase')

const bytes = multibase.encode('base58btc', new TextEncoder().encode('hey, how is it going'))

const decodedBytes = multibase.decode(bytes)
console.log(decodedBytes.toString())
// hey, how is it going

API

https://multiformats.github.io/js-multibase/

Contribute

Contributions welcome. Please check out the issues.

Check out our contributing document for more information on how we work, and about contributing in general. Please be aware that all interactions related to multiformats are subject to the IPFS Code of Conduct.

Small note: If editing the README, please conform to the standard-readme specification.

License

MIT © Protocol Labs Inc.

4.0.6 (2021-08-24)

4.0.5 (2021-08-11)

4.0.4 (2021-04-07)

Bug Fixes

• return basename or boolean from isEncoded (#91) (5f9ebe8)

4.0.3 (2021-04-06)

4.0.2 (2021-03-03)

Bug Fixes

• revert node 14 to node 12 (f2fd464)

4.0.1 (2021-02-26)

4.0.0 (2021-02-26)

Features

• remove typeVersions and update aegir to v31 (#85) (e3d4811)

BREAKING CHANGES

• No longer supports deep type imports only from the entrypoint.

3.1.2 (2021-02-26)

Bug Fixes

• fix incompatibility with zii via @rvagg's fix (#84) (d5b670f)

3.1.1 (2021-01-13)

Bug Fixes

• update aegir and fix types (#79) (93ab644)

3.1.0 (2020-11-20)

Features

• add ts types (#72) (6e083f0)

3.0.1 (2020-09-18)

3.0.0 (2020-07-31)

Bug Fixes

• return Uint8Arrays (#63) (5e38957)

BREAKING CHANGES

• • node Buffers are not returned any more, only Uint8Arrays

2.0.0 (2020-07-24)

Features

• accept Uint8Arrays in place of Buffers (#61) (abc1595)

1.0.1 (2020-06-18)

Bug Fixes

• add buffer require (#58) (d8aef0a)

1.0.0 (2020-06-09)

Features

• more encoding, errors, spec tests (#55) (613363b), closes #49 #38 #46 #53 #26

BREAKING CHANGES

• names and codes export the full object that maps names/codes to base instances instead of just the keys

0.7.0 (2020-03-16)

Bug Fixes

• throw new error object so stack traces are valid (db415c9)

Features

• remove base1 and readme tweaks (05cd102), closes #48 #44

0.6.1 (2020-03-16)

Bug Fixes

• fix base32pad, cleanup (bd02451)

0.6.0 (2018-11-22)

Bug Fixes

• base64url encodes multiple occurances of + and / (#39) (84f79ba), closes #35
• decode example typo (4d0fc17)
• do not throw when non buffer/string passed to isEncoded (1ae01a0)

0.5.0 (2018-08-30)

Features

• export list of multibase names and codes (#31) (c9e221c)

0.4.0 (2018-01-01)

Bug Fixes

• base32 and base64 (#23) (a9b5150)

0.3.4 (2017-03-16)

0.3.3 (2017-03-15)

Bug Fixes

• base16: hex strings are always of even length (#16) (b02e0d3)