README.md

@multiformats/uri-to-multiaddr

Convert a URI to a Multiaddr

About

import { uriToMultiaddr } from '@multiformats/uri-to-multiaddr'

console.log(uriToMultiaddr('https://protocol.ai'))
// -> /dns4/protocol.ai/tcp/443/https

Domain names can represent one of

• /dns4 - domain resolves to an ipv4 address (default)
• /dns6 - domain resolves to an ipv6 address
• /dnsaddr - domain has a DNSLink TXT record pointing to an IPFS CID

This library assumes /dns4 when it finds a domain name in the input string. It makes no attempt query DNS. To override the default assumption, you can pass in an options object as the second parameter to override it:

import { uriToMultiaddr } from '@multiformats/uri-to-multiaddr'

console.log(uriToMultiaddr('https://protocol.ai'), { defaultDnsType: 'dns6' })
// -> /dns6/protocol.ai/tcp/443/https

See test.js for the currently supported conversions.

Note: uri-to-multiaddr will throw if the passed URI:

• is not a valid, according the WHATWG URL spec implementation used.
• is not supported yet

Related

• @multiformats/multiaddr-to-uri - convert it back again

Install

$ npm i @multiformats/uri-to-multiaddr

Browser <script> tag

Loading this module through a script tag will make it's exports available as MultiformatsUriToMultiaddr in the global namespace.

<script src="https://unpkg.com/@multiformats/uri-to-multiaddr/dist/index.min.js"></script>

API Docs

• https://multiformats.github.io/js-uri-to-multiaddr

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.