@multiformats/multiaddr-matcher
    Preparing search index...

    Module index

    This module exports various matchers that can be used to infer the type of a passed multiaddr.

    import { multiaddr } from '@multiformats/multiaddr'
    import { DNS } from '@multiformats/multiaddr-matcher'

    const ma = multiaddr('/dnsaddr/example.org')

    DNS.matches(ma) // true - this is a multiaddr with a DNS address at the start

    The default matching behaviour ignores any subsequent tuples in the multiaddr. If you want stricter matching you can use .exactMatch:

    import { multiaddr } from '@multiformats/multiaddr'
    import { DNS, Circuit } from '@multiformats/multiaddr-matcher'

    const ma = multiaddr('/dnsaddr/example.org/p2p/QmFoo/p2p-circuit/p2p/QmBar')

    DNS.exactMatch(ma) // false - this address has extra tuples after the DNS component
    Circuit.matches(ma) // true
    Circuit.exactMatch(ma) // true - the extra tuples are circuit relay related

    Interfaces

    Matcher
    MultiaddrMatcher

    Variables

    Circuit
    DNS
    DNS4
    DNS6
    DNSADDR
    HTTP
    HTTPS
    IP
    IP_OR_DOMAIN
    IP4
    IP6
    Memory
    P2P
    PEER_ID
    QUIC
    QUIC_V1
    TCP
    UDP
    Unix
    WebRTC
    WebRTCDirect
    WebSockets
    WebSocketsSecure
    WebTransport