# multiaddr-to-uri

> Convert a Multiaddr to a URI /dnsaddr/ipfs.io/http -> http://ipfs.io

Latest version **8.0.0** (published 2021-07-08) · MIT license · 0 weekly downloads

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

## Install

```sh
npm install multiaddr-to-uri
pnpm add multiaddr-to-uri
yarn add multiaddr-to-uri
bun add multiaddr-to-uri
```

## Health

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

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 8.0.0 |
| Published | 2021-07-08 |
| First published | 2018-03-21 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 10.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Alan Shaw |
| Maintainers | achingbrain, alanshaw, olizilla, lidel |
| Keywords | multiaddr, toString, URL |

## Links

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

## Dependencies (1)

- [multiaddr](https://npm.io/package/multiaddr.md) ^10.0.0

## Alternatives

- [base64url](https://npm.io/package/base64url.md) — 6.1M weekly downloads
- [get-installed-path](https://npm.io/package/get-installed-path.md) — 502.9K weekly downloads
- [@uppy/url](https://npm.io/package/@uppy/url.md) — 185.8K weekly downloads
- [@d3fc/d3fc-shape](https://npm.io/package/@d3fc/d3fc-shape.md) — 16.2K weekly downloads
- [localizer](https://npm.io/package/localizer.md) — 226 weekly downloads

## Recent versions

- 8.0.0 (latest) — 2021-07-08
- 7.0.0 — 2021-04-14
- 6.0.0 — 2020-08-11
- 5.1.0 — 2020-01-01
- 5.0.0 — 2019-08-21
- 4.0.1 — 2019-01-14
- 4.0.0 — 2018-07-24
- 3.0.0 — 2018-04-05
- 2.0.0 — 2018-03-21

## README

# multiaddr-to-uri

[![Build Status](https://travis-ci.org/multiformats/js-multiaddr-to-uri.svg?branch=master)](https://travis-ci.org/multiformats/js-multiaddr-to-uri) [![dependencies Status](https://david-dm.org/multiformats/js-multiaddr-to-uri/status.svg)](https://david-dm.org/multiformats/js-multiaddr-to-uri) [![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)


> Convert a Multiaddr to a URI /dnsaddr/ipfs.io/http -> http://ipfs.io

## Install

```sh
npm install multiaddr-to-uri
```

## Usage

```js
const toUri = require('multiaddr-to-uri')

console.log(toUri('/dnsaddr/protocol.ai/https'))
// -> https://protocol.ai

console.log(toUri('/ip4/127.0.0.1/tcp/8080'))
// -> http://127.0.0.1:8080

console.log(toUri('/ip4/127.0.0.1/tcp/8080', { assumeHttp: false }))
// -> tcp://127.0.0.1:8080
```

Note:

* When `/tcp` is the last (terminating) protocol HTTP is assumed by default (implicit `assumeHttp: true`)
  * this means produced URIs will start with `http://` instead of `tcp://`
  * passing `{ assumeHttp: false }` disables this behavior
* Might be lossy - e.g. a DNSv6 multiaddr
* Can throw if the passed multiaddr:
    * is not a valid multiaddr
    * is not supported as a URI e.g. circuit

## Contribute

Feel free to dive in! [Open an issue](https://github.com/multiformats/js-multiaddr-to-uri/issues/new) or submit PRs.

## License

[MIT](LICENSE) © Alan Shaw

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