fluencelabs/js-multiaddr-to-uri
1
0
Fork 0
mirror of https://github.com/fluencelabs/js-multiaddr-to-uri synced 2024-12-04 20:40:20 +00:00
Code Issues Projects Releases Wiki Activity
34 Commits 6 Branches 8 Tags 415 KiB
JavaScript 100%
2fcb460df9
Go to file
dependabot-preview[bot] 2fcb460df9
chore(deps): [security] bump y18n from 4.0.0 to 4.0.3 
Bumps [y18n](https://github.com/yargs/y18n) from 4.0.0 to 4.0.3. **This update includes a security fix.**
- [Release notes](https://github.com/yargs/y18n/releases)
- [Changelog](https://github.com/yargs/y18n/blob/y18n-v4.0.3/CHANGELOG.md)
- [Commits](https://github.com/yargs/y18n/compare/v4.0.0...y18n-v4.0.3)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>
2021-04-08 11:32:34 +00:00
.gitignore initial commit 2018-03-20 14:39:26 +00:00
.travis.yml chore: update deps (#45) 2020-08-11 09:04:05 +01:00
index.js feat: retain aliased protocols (#11) 2020-01-01 22:29:49 +00:00
LICENSE initial commit 2018-03-20 14:39:26 +00:00
package-lock.json chore(deps): [security] bump y18n from 4.0.0 to 4.0.3 2021-04-08 11:32:34 +00:00
package.json 6.0.0 2020-08-11 09:29:28 +01:00
README.md chore: update repo URL 2019-08-21 11:13:53 +01:00
test.js feat: retain aliased protocols (#11) 2020-01-01 22:29:49 +00:00

README.md

multiaddr-to-uri

Build Status dependencies Status JavaScript Style Guide

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 (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 or submit PRs.

License

MIT © Alan Shaw