Neighbor's Preppy Maltese

    multiaddr-to-uri

    8.0.0 • Public • Published

    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

    Install

    npm i multiaddr-to-uri

    DownloadsWeekly Downloads

    60,965

    Version

    8.0.0

    License

    MIT

    Unpacked Size

    11.2 kB

    Total Files

    6

    Last publish

    Collaborators

    • achingbrain
    • alanshaw
    • olizilla
    • lidel