tableflip/js-mafmt

Name: js-mafmt

Owner: TABLEFLIP

Description: javascript multiaddr validation

Created: 2018-04-06 16:09:52.0

Updated: 2018-04-06 16:09:54.0

Pushed: 2018-04-06 16:10:32.0

Homepage: null

Size: 51

Language: JavaScript

GitHub Committers

UserMost Recent Commit# Commits

Other Committers

UserEmailMost Recent Commit# Commits

README

js-mafmt

Coverage Status Travis CI Circle CI Dependency Status js-standard-style

Javascript implementation of multiaddr validation

Install
install mafmt
Usage
t mafmt = require('msfmt')

t.DNS.matches('/dns4/ipfs.io') // true
API
mafmt.<FORMAT>.matches(multiaddr)

Where <FORMAT> may be:

| <FORMAT> | Description | Example(s) | | — | — | — | | DNS | a “dns4” or “dns6” format multiaddr | /dnsaddr/ipfs.io | DNS4 | a “dns4” format multiaddr | /dns4/ipfs.io | | DNS6 | a “dns6” format multiaddr | /dns6/protocol.ai/tcp/80 | | IP | an “ip4” or “ip6” format multiaddr | /ip4/127.0.0.1
/ip6/fc00:: | | TCP | a “tcp” over IP format multiaddr | /ip4/0.0.7.6/tcp/1234 | | UDP | a “udp” over IP format multiaddr | /ip4/0.0.7.6/udp/1234 | | UTP | a “utp” over UDP format multiaddr | /ip4/1.2.3.4/udp/3456/utp | | Websockets | a “ws” over TCP or “ws” over DNS format multiaddr | /ip4/1.2.3.4/tcp/3456/ws
/dnsaddr/ipfs.io/ws | | WebSocketsSecure | a “wss” over TCP or “wss” over DNS format multiaddr | /ip6/::/tcp/0/wss
/dnsaddr/ipfs.io/wss | | HTTP | a “http” over TCP or DNS or “http” over DNS format multiaddr | /ip4/127.0.0.1/tcp/90/http/baz.jpg
/dnsaddr/ipfs.io/http/baz.jpg | | WebRTCStar | an “ipfs” over “p2p-webrtc-star” over Websockets or “ipfs” over “p2p-webrtc-star” over WebSocketsSecure format multiaddr | /dnsaddr/ipfs.io/wss/p2p-webrtc-star/ipfs/QmcgpsyWgH8Y8ajJz1Cu72KnS5uo2Aa2LpzU7kinSoooo4 | | WebSocketStar | an “ipfs” over “p2p-websocket-star” over Websockets or “ipfs” over “p2p-websocket-star” over WebSocketsSecure or “p2p-websocket-star” over Websockets or “p2p-websocket-star” over WebSocketsSecure format multiaddr | /ip4/1.2.3.4/tcp/3456/ws/p2p-websocket-star
/dnsaddr/localhost/ws/p2p-websocket-star/ipfs/QmcgpsyWgH8Y8ajJz1Cu72KnS5uo2Aa2LpzU7kinSoooo4 | | WebRTCDirect | a “p2p-webrtc-direct” over HTTP format multiaddr | /ip4/1.2.3.4/tcp/3456/http/p2p-webrtc-direct | | Reliable | a WebSockets or WebSocketsSecure or HTTP or WebRTCStar or WebRTCDirect or TCP or UTP format multiaddr | /dnsaddr/ipfs.io/wss | | Circuit | | /ipfs/QmcgpsyWgH8Y8ajJz1Cu72KnS5uo2Aa2LpzU7kinSoooo4/p2p-circuit/ipfs/QmUjNmr8TgJCn1Ao7DvMy4cjoZU15b9bwSCBLE3vwXiwgj | | IPFS | “ipfs” over Reliable or WebRTCStar or “ipfs” format multiaddr | /ipfs/QmcgpsyWgH8Y8ajJz1Cu72KnS5uo2Aa2LpzU7kinSoooo4
/ip4/127.0.0.1/tcp/20008/ws/ipfs/QmUjNmr8TgJCn1Ao7DvMy4cjoZU15b9bwSCBLE3vwXiwgj | | | | |

Where multiaddr may be:

Returns true/false


This work is supported by the National Institutes of Health's National Center for Advancing Translational Sciences, Grant Number U24TR002306. This work is solely the responsibility of the creators and does not necessarily represent the official views of the National Institutes of Health.