mirror of
https://github.com/fluencelabs/js-multiaddr-to-uri
synced 2025-03-15 07:21:06 +00:00
599019b3e9
Bumps [nyc](https://github.com/istanbuljs/nyc) from 15.0.0 to 15.1.0. - [Release notes](https://github.com/istanbuljs/nyc/releases) - [Changelog](https://github.com/istanbuljs/nyc/blob/master/CHANGELOG.md) - [Commits](https://github.com/istanbuljs/nyc/compare/v15.0.0...v15.1.0) Signed-off-by: dependabot-preview[bot] <support@dependabot.com> Co-authored-by: dependabot-preview[bot] <27856297+dependabot-preview[bot]@users.noreply.github.com>
multiaddr-to-uri
Convert a Multiaddr to a URI /dnsaddr/ipfs.io/http -> http://ipfs.io
Install
npm install multiaddr-to-uri
Usage
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
/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
Contribute
Feel free to dive in! Open an issue or submit PRs.
License
MIT © Alan Shaw