@multiformats/multiaddr
    Preparing search index...

    @multiformats/multiaddr

    A standard way to represent addresses that

    • support any standard network protocol
    • have a binary packed format
    • have a nice string representation
    • encapsulate well
    import { multiaddr } from '@multiformats/multiaddr'

    const addr = multiaddr('/ip4/127.0.0.1/udp/1234')
    // Multiaddr(/ip4/127.0.0.1/udp/1234)

    addr.bytes
    // <Uint8Array 04 7f 00 00 01 11 04 d2>

    addr.toString()
    // '/ip4/127.0.0.1/udp/1234'

    addr.getComponents()
    // [
    // { code: 4, name: 'ip4', value: '127.0.0.1' },
    // { code: 273, name: 'udp', value: '1234' }
    // ]

    addr.encapsulate('/sctp/5678')
    // Multiaddr(/ip4/127.0.0.1/udp/1234/sctp/5678)

    To add application-specific or experimental protocols, add a protocol codec to the protocol registry:

    import { registry, V, multiaddr } from '@multiformats/multiaddr'
    import type { ProtocolCodec } from '@multiformats/multiaddr'

    const maWithCustomTuple = '/custom-protocol/hello'

    // throws UnknownProtocolError
    multiaddr(maWithCustomTuple)

    const protocol: ProtocolCodec = {
    code: 2059,
    name: 'custom-protocol',
    size: V
    // V means variable length, can also be 0, a positive integer (e.g. a fixed
    // length or omitted
    }

    registry.addProtocol(protocol)

    // does not throw UnknownProtocolError
    multiaddr(maWithCustomTuple)

    // protocols can also be removed
    registry.removeProtocol(protocol.code)

    Interfaces

    Component
    Multiaddr
    ProtocolCodec
    Registry

    Type Aliases

    MultiaddrInput

    Variables

    CODE_CERTHASH
    CODE_DCCP
    CODE_DNS
    CODE_DNS4
    CODE_DNS6
    CODE_DNSADDR
    CODE_GARLIC32
    CODE_GARLIC64
    CODE_HTTP
    CODE_HTTP_PATH
    CODE_HTTPS
    CODE_IP4
    CODE_IP6
    CODE_IP6ZONE
    CODE_IPCIDR
    CODE_MEMORY
    CODE_NOISE
    CODE_ONION
    CODE_ONION3
    CODE_P2P
    CODE_P2P_CIRCUIT
    CODE_P2P_STARDUST
    CODE_P2P_WEBRTC_DIRECT
    CODE_P2P_WEBRTC_STAR
    CODE_P2P_WEBSOCKET_STAR
    CODE_QUIC
    CODE_QUIC_V1
    CODE_SCTP
    CODE_SNI
    CODE_TCP
    CODE_TLS
    CODE_UDP
    CODE_UDT
    CODE_UNIX
    CODE_UTP
    CODE_WEBRTC
    CODE_WEBRTC_DIRECT
    CODE_WEBTRANSPORT
    CODE_WS
    CODE_WSS
    registry
    V

    Functions

    isMultiaddr
    multiaddr