mirror of
https://github.com/fluencelabs/js-multiaddr-to-uri
synced 2024-12-05 03:40:35 +00:00
f54eb2c629
License: MIT Signed-off-by: Alan Shaw <alan.shaw@protocol.ai>
1.4 KiB
1.4 KiB
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
/tcp
is 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