# multibase

> JavaScript implementation of the multibase specification

Latest version **4.0.6** (published 2021-08-24) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install multibase
pnpm add multibase
yarn add multibase
bun add multibase
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 4.0.6 |
| Published | 2021-08-24 |
| First published | 2016-09-01 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | >=12.0.0 |
| Dependencies | 1 |
| Unpacked size | 32 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 23 |
| Maintainers | vmx, daviddias, dignifiedquire, achingbrain, olizilla, hugomrdias |
| Keywords | IPFS, multiformats, multibase, encode, decode, formats |

## Links

- npm: https://www.npmjs.com/package/multibase
- Repository: https://github.com/multiformats/js-multibase
- Homepage: https://github.com/multiformats/js-multibase#readme
- Issues: https://github.com/multiformats/js-multibase/issues
- npm.io page: https://npm.io/package/multibase

## Dependencies (1)

- [@multiformats/base-x](https://npm.io/package/@multiformats/base-x.md) ^4.0.1

## Alternatives

- [flatbuffers](https://npm.io/package/flatbuffers.md) — 6.0M weekly downloads
- [jwt-simple](https://npm.io/package/jwt-simple.md) — 259.5K weekly downloads
- [@exodus/patch-broken-hermes-typed-arrays](https://npm.io/package/@exodus/patch-broken-hermes-typed-arrays.md) — 28.5K weekly downloads
- [@native-to-anchor/buffer-layout](https://npm.io/package/@native-to-anchor/buffer-layout.md) — 12.2K weekly downloads
- [binary-parser-encoder](https://npm.io/package/binary-parser-encoder.md) — 5.3K weekly downloads

## Recent versions

- 4.0.6 (latest) — 2021-08-24
- 3.0.2-rc.0 (next) — 2020-11-18
- 4.0.5 — 2021-08-12
- 4.0.4 — 2021-04-07
- 4.0.3 — 2021-04-06
- 4.0.2 — 2021-03-03
- 4.0.1 — 2021-02-26
- 3.1.2 — 2021-02-26
- 3.1.1 — 2021-01-13
- 3.1.0 — 2020-11-20
- 3.0.1 — 2020-09-18
- 3.0.0 — 2020-07-31
- 2.0.0 — 2020-07-24
- 1.0.1 — 2020-06-18
- 1.0.0 — 2020-06-09
- … 11 more at https://npm.io/package/multibase/versions

## README

⛔️ DEPRECATED: This module has been superseded by the [multiformats](https://github.com/multiformats/js-multiformats) module <!-- omit in toc -->

js-multibase <!-- omit in toc -->
============

[![pl](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](https://protocol.ai)
[![project](https://img.shields.io/badge/project-multiformats-blue.svg?style=flat-square)](https://github.com/multiformats/multiformats)
[![irc](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](https://webchat.freenode.net/?channels=%23ipfs)
[![codecov](https://img.shields.io/codecov/c/github/multiformats/js-multibase.svg?style=flat-square)](https://codecov.io/gh/multiformats/js-multibase)
[![GitHub Workflow Status](https://img.shields.io/github/workflow/status/multiformats/js-multibase/ci?label=ci&style=flat-square)](https://github.com/multiformats/js-multibase/actions?query=branch%3Amaster+workflow%3Aci+)

> JavaScript implementation of the [multibase](https://github.com/multiformats/multibase) specification

## Lead Maintainer <!-- omit in toc -->

[Hugo Dias](https://github.com/hugomrdias)

## Table of Contents <!-- omit in toc -->

- [Install](#install)
  - [NPM](#npm)
  - [Browser through `<script>` tag](#browser-through-script-tag)
- [Usage](#usage)
  - [Example](#example)
- [API](#api)
- [Contribute](#contribute)
- [License](#license)

## Install

### NPM

```sh
$ 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.

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

## Usage

### Example

```JavaScript
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](https://github.com/multiformats/js-multibase/issues).

Check out our [contributing document](https://github.com/multiformats/multiformats/blob/master/contributing.md) 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](https://github.com/ipfs/community/blob/master/code-of-conduct.md).

Small note: If editing the README, please conform to the [standard-readme](https://github.com/RichardLitt/standard-readme) specification.

## License

[MIT](LICENSE) © Protocol Labs Inc.

---
_Source: https://npm.io/package/multibase · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
