A multiaddr validator
<script>
tag$ npm i @multiformats/mafmt
+Install
$ npm i @multiformats/mafmt
Browser <script>
tag
Loading this module through a script tag will make it's exports available as MultiformatsMafmt
in the global namespace.
-<script src="https://unpkg.com/@multiformats/mafmt/dist/index.min.js"></script>
+<script src="https://unpkg.com/@multiformats/mafmt/dist/index.min.js"></script>
-Usage
import * as mafmt from '@multiformats/mafmt'
mafmt.DNS.matches('/dns4/ipfs.io') // true
+Usage
import * as mafmt from '@multiformats/mafmt'
mafmt.DNS.matches('/dns4/ipfs.io') // true
API
mafmt.<FORMAT>.matches(multiaddr)
Where <FORMAT>
may be:
@@ -158,73 +144,4 @@ @multiformats/mafmt - v12.1.6
- 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.
-
-
-
\ No newline at end of file
+
\ No newline at end of file
diff --git a/interfaces/Mafmt.html b/interfaces/Mafmt.html
index 1709a27..72e1156 100644
--- a/interfaces/Mafmt.html
+++ b/interfaces/Mafmt.html
@@ -1,120 +1,5 @@
-Mafmt | @multiformats/mafmt - v12.1.6
-
-
-
-
-
\ No newline at end of file
+Mafmt | @multiformats/mafmt - v12.1.6 Interface Mafmt
interface Mafmt {
    input?: (Mafmt | (() => Mafmt))[];
    matches: MatchesFunction;
    partialMatch: PartialMatchesFunction;
    toString: (() => string);
} Index
Properties
Properties
Optional
input
matches
partial Match
to String
to String: (() => string)Type declaration
- (): string
Returns string
\ No newline at end of file
diff --git a/interfaces/MatchesFunction.html b/interfaces/MatchesFunction.html
index bc8aa51..24fc1e7 100644
--- a/interfaces/MatchesFunction.html
+++ b/interfaces/MatchesFunction.html
@@ -1,80 +1 @@
-MatchesFunction | @multiformats/mafmt - v12.1.6
-
-
-
-
-Interface MatchesFunction
-
-
-Hierarchy
-
-- MatchesFunction
-
-
-- Matches
Function(a): boolean
--
-
-
Parameters
-
--
-
a: string | Uint8Array | Multiaddr
-Returns boolean
-
-
\ No newline at end of file
+MatchesFunction | @multiformats/mafmt - v12.1.6 Interface MatchesFunction
interface MatchesFunction ((a) => boolean)- Matches
Function(a): boolean Parameters
- a: string | Uint8Array | Multiaddr
Returns boolean
\ No newline at end of file
diff --git a/interfaces/PartialMatchesFunction.html b/interfaces/PartialMatchesFunction.html
index 5ead60d..725d700 100644
--- a/interfaces/PartialMatchesFunction.html
+++ b/interfaces/PartialMatchesFunction.html
@@ -1,80 +1 @@
-PartialMatchesFunction | @multiformats/mafmt - v12.1.6
-
-
-
-
-
\ No newline at end of file
+PartialMatchesFunction | @multiformats/mafmt - v12.1.6
\ No newline at end of file
diff --git a/modules.html b/modules.html
index b990e6e..0b418d1 100644
--- a/modules.html
+++ b/modules.html
@@ -1,98 +1,29 @@
-@multiformats/mafmt - v12.1.6
-
-
-
-
-@multiformats/mafmt - v12.1.6
-
-
-Index
-
-Interfaces
-
-
-Variables
-Circuit
-DNS
-DNS4
-DNS6
-DNSADDR
-HTTP
-HTTPS
-IP
-IPFS
-P2P
-P2PWebRTCDirect
-P2PWebRTCStar
-QUIC
-QUICV1
-Reliable
-Stardust
-TCP
-UDP
-UTP
-WebRTC
-WebRTCDirect
-Web Socket Star
-Web Sockets
-Web Sockets Secure
-Web Transport
-
-
-
\ No newline at end of file
+@multiformats/mafmt - v12.1.6 @multiformats/mafmt - v12.1.6
Index
Interfaces
Variables
Circuit
+DNS
+DNS4
+DNS6
+DNSADDR
+HTTP
+HTTPS
+IP
+IPFS
+P2P
+P2PWebRTCDirect
+P2PWebRTCStar
+QUIC
+QUICV1
+Reliable
+Stardust
+TCP
+UDP
+UTP
+WebRTC
+WebRTCDirect
+Web Socket Star
+Web Sockets
+Web Sockets Secure
+Web Transport
+
\ No newline at end of file
diff --git a/variables/Circuit.html b/variables/Circuit.html
index 1402b9d..302b22b 100644
--- a/variables/Circuit.html
+++ b/variables/Circuit.html
@@ -1,67 +1 @@
-Circuit | @multiformats/mafmt - v12.1.6
-
-
-
-
-Variable CircuitConst
-
-
-
-
\ No newline at end of file
+Circuit | @multiformats/mafmt - v12.1.6 Variable CircuitConst
\ No newline at end of file
diff --git a/variables/DNS.html b/variables/DNS.html
index 0489322..0abbe7f 100644
--- a/variables/DNS.html
+++ b/variables/DNS.html
@@ -1,67 +1 @@
-DNS | @multiformats/mafmt - v12.1.6
-
-
-
-
-Variable DNSConst
-
-
-
-
\ No newline at end of file
+DNS | @multiformats/mafmt - v12.1.6 Variable DNSConst
\ No newline at end of file
diff --git a/variables/DNS4.html b/variables/DNS4.html
index cfe916c..b8059ea 100644
--- a/variables/DNS4.html
+++ b/variables/DNS4.html
@@ -1,67 +1 @@
-DNS4 | @multiformats/mafmt - v12.1.6
-
-
-
-
-Variable DNS4Const
-
-
-
-
\ No newline at end of file
+DNS4 | @multiformats/mafmt - v12.1.6 Variable DNS4Const
\ No newline at end of file
diff --git a/variables/DNS6.html b/variables/DNS6.html
index 3be6e61..fa822b0 100644
--- a/variables/DNS6.html
+++ b/variables/DNS6.html
@@ -1,67 +1 @@
-DNS6 | @multiformats/mafmt - v12.1.6
-
-
-
-
-Variable DNS6Const
-
-
-
-
\ No newline at end of file
+DNS6 | @multiformats/mafmt - v12.1.6 Variable DNS6Const
\ No newline at end of file
diff --git a/variables/DNSADDR.html b/variables/DNSADDR.html
index 727752a..d9f6c87 100644
--- a/variables/DNSADDR.html
+++ b/variables/DNSADDR.html
@@ -1,67 +1 @@
-DNSADDR | @multiformats/mafmt - v12.1.6
-
-
-
-
-Variable DNSADDRConst
-
-
-
-
\ No newline at end of file
+DNSADDR | @multiformats/mafmt - v12.1.6 Variable DNSADDRConst
\ No newline at end of file
diff --git a/variables/HTTP.html b/variables/HTTP.html
index 2f5f518..059cb88 100644
--- a/variables/HTTP.html
+++ b/variables/HTTP.html
@@ -1,67 +1 @@
-HTTP | @multiformats/mafmt - v12.1.6
-
-
-
-
-Variable HTTPConst
-
-
-
-
\ No newline at end of file
+HTTP | @multiformats/mafmt - v12.1.6 Variable HTTPConst
\ No newline at end of file
diff --git a/variables/HTTPS.html b/variables/HTTPS.html
index f560022..df0ffa6 100644
--- a/variables/HTTPS.html
+++ b/variables/HTTPS.html
@@ -1,67 +1 @@
-HTTPS | @multiformats/mafmt - v12.1.6
-
-
-
-
-Variable HTTPSConst
-
-
-
-
\ No newline at end of file
+HTTPS | @multiformats/mafmt - v12.1.6 Variable HTTPSConst
\ No newline at end of file
diff --git a/variables/IP.html b/variables/IP.html
index 2cec78d..8cf6c37 100644
--- a/variables/IP.html
+++ b/variables/IP.html
@@ -1,67 +1 @@
-IP | @multiformats/mafmt - v12.1.6
-
-
-
-
-Variable IPConst
-
-
-
-
\ No newline at end of file
+IP | @multiformats/mafmt - v12.1.6 Variable IPConst
\ No newline at end of file
diff --git a/variables/IPFS.html b/variables/IPFS.html
index 8296d9d..671fc8b 100644
--- a/variables/IPFS.html
+++ b/variables/IPFS.html
@@ -1,67 +1 @@
-IPFS | @multiformats/mafmt - v12.1.6
-
-
-
-
-Variable IPFSConst
-
-
-
-
\ No newline at end of file
+IPFS | @multiformats/mafmt - v12.1.6 Variable IPFSConst
\ No newline at end of file
diff --git a/variables/P2P.html b/variables/P2P.html
index f90bb3d..a7a24c0 100644
--- a/variables/P2P.html
+++ b/variables/P2P.html
@@ -1,67 +1 @@
-P2P | @multiformats/mafmt - v12.1.6
-
-
-
-
-Variable P2PConst
-
-
-
-
\ No newline at end of file
+P2P | @multiformats/mafmt - v12.1.6 Variable P2PConst
\ No newline at end of file
diff --git a/variables/P2PWebRTCDirect.html b/variables/P2PWebRTCDirect.html
index d56ce4e..d498031 100644
--- a/variables/P2PWebRTCDirect.html
+++ b/variables/P2PWebRTCDirect.html
@@ -1,69 +1 @@
-P2PWebRTCDirect | @multiformats/mafmt - v12.1.6
-
-
-
-
-Variable P2PWebRTCDirectConst
-
-
-
-
-
\ No newline at end of file
+P2PWebRTCDirect | @multiformats/mafmt - v12.1.6
\ No newline at end of file
diff --git a/variables/P2PWebRTCStar.html b/variables/P2PWebRTCStar.html
index e4ca180..9460742 100644
--- a/variables/P2PWebRTCStar.html
+++ b/variables/P2PWebRTCStar.html
@@ -1,69 +1 @@
-P2PWebRTCStar | @multiformats/mafmt - v12.1.6
-
-
-
-
-
\ No newline at end of file
+P2PWebRTCStar | @multiformats/mafmt - v12.1.6
\ No newline at end of file
diff --git a/variables/QUIC.html b/variables/QUIC.html
index 34b73d0..4210aa7 100644
--- a/variables/QUIC.html
+++ b/variables/QUIC.html
@@ -1,67 +1 @@
-QUIC | @multiformats/mafmt - v12.1.6
-
-
-
-
-Variable QUICConst
-
-
-
-
\ No newline at end of file
+QUIC | @multiformats/mafmt - v12.1.6 Variable QUICConst
\ No newline at end of file
diff --git a/variables/QUICV1.html b/variables/QUICV1.html
index cf19a58..343d8d4 100644
--- a/variables/QUICV1.html
+++ b/variables/QUICV1.html
@@ -1,67 +1 @@
-QUICV1 | @multiformats/mafmt - v12.1.6
-
-
-
-
-Variable QUICV1Const
-
-
-
-
\ No newline at end of file
+QUICV1 | @multiformats/mafmt - v12.1.6 Variable QUICV1Const
\ No newline at end of file
diff --git a/variables/Reliable.html b/variables/Reliable.html
index 74e14da..f09ca38 100644
--- a/variables/Reliable.html
+++ b/variables/Reliable.html
@@ -1,67 +1 @@
-Reliable | @multiformats/mafmt - v12.1.6
-
-
-
-
-Variable ReliableConst
-
-
-
-
\ No newline at end of file
+Reliable | @multiformats/mafmt - v12.1.6 Variable ReliableConst
\ No newline at end of file
diff --git a/variables/Stardust.html b/variables/Stardust.html
index 4f68fcc..151e0eb 100644
--- a/variables/Stardust.html
+++ b/variables/Stardust.html
@@ -1,67 +1 @@
-Stardust | @multiformats/mafmt - v12.1.6
-
-
-
-
-Variable StardustConst
-
-
-
-
\ No newline at end of file
+Stardust | @multiformats/mafmt - v12.1.6 Variable StardustConst
\ No newline at end of file
diff --git a/variables/TCP.html b/variables/TCP.html
index 7f7155a..32e7c73 100644
--- a/variables/TCP.html
+++ b/variables/TCP.html
@@ -1,67 +1 @@
-TCP | @multiformats/mafmt - v12.1.6
-
-
-
-
-Variable TCPConst
-
-
-
-
\ No newline at end of file
+TCP | @multiformats/mafmt - v12.1.6 Variable TCPConst
\ No newline at end of file
diff --git a/variables/UDP.html b/variables/UDP.html
index c4acdc0..1d7ab81 100644
--- a/variables/UDP.html
+++ b/variables/UDP.html
@@ -1,67 +1 @@
-UDP | @multiformats/mafmt - v12.1.6
-
-
-
-
-Variable UDPConst
-
-
-
-
\ No newline at end of file
+UDP | @multiformats/mafmt - v12.1.6 Variable UDPConst
\ No newline at end of file
diff --git a/variables/UTP.html b/variables/UTP.html
index 52e766b..1df7be1 100644
--- a/variables/UTP.html
+++ b/variables/UTP.html
@@ -1,67 +1 @@
-UTP | @multiformats/mafmt - v12.1.6
-
-
-
-
-Variable UTPConst
-
-
-
-
\ No newline at end of file
+UTP | @multiformats/mafmt - v12.1.6 Variable UTPConst
\ No newline at end of file
diff --git a/variables/WebRTC.html b/variables/WebRTC.html
index 801c4da..451f1b8 100644
--- a/variables/WebRTC.html
+++ b/variables/WebRTC.html
@@ -1,67 +1 @@
-WebRTC | @multiformats/mafmt - v12.1.6
-
-
-
-
-Variable WebRTCConst
-
-
-
-
\ No newline at end of file
+WebRTC | @multiformats/mafmt - v12.1.6 Variable WebRTCConst
\ No newline at end of file
diff --git a/variables/WebRTCDirect.html b/variables/WebRTCDirect.html
index 0e53c90..2022bde 100644
--- a/variables/WebRTCDirect.html
+++ b/variables/WebRTCDirect.html
@@ -1,67 +1 @@
-WebRTCDirect | @multiformats/mafmt - v12.1.6
-
-
-
-
-Variable WebRTCDirectConst
-
-
-
-
\ No newline at end of file
+WebRTCDirect | @multiformats/mafmt - v12.1.6 Variable WebRTCDirectConst
\ No newline at end of file
diff --git a/variables/WebSocketStar.html b/variables/WebSocketStar.html
index f22c336..be6a409 100644
--- a/variables/WebSocketStar.html
+++ b/variables/WebSocketStar.html
@@ -1,67 +1 @@
-WebSocketStar | @multiformats/mafmt - v12.1.6
-
-
-
-
-Variable WebSocketStarConst
-
-
-
-
\ No newline at end of file
+WebSocketStar | @multiformats/mafmt - v12.1.6 Variable WebSocketStarConst
\ No newline at end of file
diff --git a/variables/WebSockets.html b/variables/WebSockets.html
index 775f0df..1103f39 100644
--- a/variables/WebSockets.html
+++ b/variables/WebSockets.html
@@ -1,67 +1 @@
-WebSockets | @multiformats/mafmt - v12.1.6
-
-
-
-
-Variable WebSocketsConst
-
-
-
-
\ No newline at end of file
+WebSockets | @multiformats/mafmt - v12.1.6 Variable WebSocketsConst
\ No newline at end of file
diff --git a/variables/WebSocketsSecure.html b/variables/WebSocketsSecure.html
index c507f25..184579d 100644
--- a/variables/WebSocketsSecure.html
+++ b/variables/WebSocketsSecure.html
@@ -1,67 +1 @@
-WebSocketsSecure | @multiformats/mafmt - v12.1.6
-
-
-
-
-Variable WebSocketsSecureConst
-
-
-
-
\ No newline at end of file
+WebSocketsSecure | @multiformats/mafmt - v12.1.6 Variable WebSocketsSecureConst
\ No newline at end of file
diff --git a/variables/WebTransport.html b/variables/WebTransport.html
index 92f5fb0..333d828 100644
--- a/variables/WebTransport.html
+++ b/variables/WebTransport.html
@@ -1,67 +1 @@
-WebTransport | @multiformats/mafmt - v12.1.6
-
-
-
-
-Variable WebTransportConst
-
-
-
-
\ No newline at end of file
+WebTransport | @multiformats/mafmt - v12.1.6 Variable WebTransportConst
\ No newline at end of file
Deprecated