multiformats
@multiformats/multiaddr-to-uri
Convert a Multiaddr to a URI
About
This module allows easy conversion of Multiaddrs to string URIs.
Example - Converting multiaddrs to string URIs
import { multiaddrToUri } from '@multiformats/multiaddr-to-uri'
console.log(multiaddrToUri('/dnsaddr/protocol.ai/https'))
// -> https://protocol.ai
console.log(multiaddrToUri('/ip4/127.0.0.1/tcp/8080'))
// -> http://127.0.0.1:8080
console.log(multiaddrToUri('/ip4/127.0.0.1/tcp/8080', { assumeHttp: false }))
// -> tcp://127.0.0.1:8080Note:
- When
/tcpis the last (terminating) protocol HTTP is assumed by default (implicitassumeHttp: true)- this means produced URIs will start with
http://instead oftcp:// - passing
{ assumeHttp: false }disables this behavior
- this means produced URIs will start with
- 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
Install
$ npm i @multiformats/multiaddr-to-uriBrowser <script> tag
Loading this module through a script tag will make it's exports available as MultiformatsMultiaddrToUri in the global namespace.
<script src="https://unpkg.com/@multiformats/multiaddr-to-uri/dist/index.min.js"></script>API Docs
License
Licensed under either of
- Apache 2.0, (LICENSE-APACHE / http://www.apache.org/licenses/LICENSE-2.0)
- MIT (LICENSE-MIT / http://opensource.org/licenses/MIT)
Contribution
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.