Skip to content

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

License

Unknown and 2 other licenses found

Licenses found

Unknown
LICENSE
Unknown
LICENSE-APACHE
MIT
LICENSE-MIT
Notifications You must be signed in to change notification settings

multiformats/js-multiaddr-to-uri

Folders and files

NameName
Last commit message
Last commit date

Latest commit

f71993a · Nov 8, 2024

History

85 Commits
Mar 21, 2024
Nov 8, 2024
Nov 8, 2024
Mar 17, 2023
Nov 8, 2024
Sep 21, 2022
Jan 6, 2022
Sep 21, 2022
Feb 5, 2024
Nov 8, 2024
Jan 6, 2022
Feb 5, 2024

Repository files navigation

@multiformats/multiaddr-to-uri

multiformats.io codecov CI

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: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

Install

$ npm i @multiformats/multiaddr-to-uri

Browser <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

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.