Readme tweaks, and move isIP* static methods (#128)

* Update README.md

* move isIP static methods

Author: LuKks

README.md

@@ -70,11 +70,25 @@ stream2.on('close', function () {
 
 ## API
 
-### `const udx = new UDX()`
+#### `const udx = new UDX()`
 
 Creates a new UDX instance.
 
-### `const socket = udx.createSocket()`
+#### `const bool = UDX.isIPv4(host)`
+
+Returns `true` if host is an IPv4 address.
+
+#### `const bool = UDX.isIPv6(host)`
+
+Returns `true` if host is an IPv6 address.
+
+#### `const family = UDX.isIP(host)`
+
+Returns the address family (`4` or `6`). Returns `0` if invalid.
+
+## Sockets
+
+#### `const socket = udx.createSocket()`
 
 Creates a new socket instance.
 
@@ -158,7 +172,9 @@ Emitted if the socket becomes busy (at least one active stream).
 
 Emitted after a succesfull `bind()` call.
 
-### `const stream = udx.createStream(id, [options])`
+## Streams
+
+#### `const stream = udx.createStream(id, [options])`
 
 Creates a new stream instance that is a Duplex stream.
 
@@ -274,7 +290,9 @@ Emitted if the stream receives a message.
 
 Emitted only once if you write data that exceeds the MTU.
 
-### `const interfaces = udx.networkInterfaces()`
+## Network interfaces
+
+#### `const interfaces = udx.networkInterfaces()`
 
 Returns an array of network interfaces, for example:
 ```js
@@ -286,7 +304,7 @@ Returns an array of network interfaces, for example:
 ]
 ```
 
-### `const watcher = udx.watchNetworkInterfaces([onchange])`
+#### `const watcher = udx.watchNetworkInterfaces([onchange])`
 
 Listens to changes in the network interfaces. The `watcher` object is iterable.
 
@@ -314,7 +332,9 @@ Emitted after a network interface change.
 
 Emitted after the watcher is closed.
 
-### `const address = udx.lookup(host, [options])`
+## DNS
+
+#### `const address = await udx.lookup(host, [options])`
 
 It does a DNS lookup for the IP address. Returns `{ host, family }`.
 

lib/socket.js

@@ -24,18 +24,6 @@ module.exports = class UDXSocket extends events.EventEmitter {
     this.userData = null
   }
 
-  static isIPv4 (host) {
-    return ip.isIPv4(host)
-  }
-
-  static isIPv6 (host) {
-    return ip.isIPv6(host)
-  }
-
-  static isIP (host) {
-    return ip.isIP(host)
-  }
-
   get bound () {
     return this._port !== 0
   }

lib/udx.js

@@ -1,5 +1,6 @@
 const b4a = require('b4a')
 const binding = require('./binding')
+const ip = require('./ip')
 const Socket = require('./socket')
 const Stream = require('./stream')
 const NetworkInterfaces = require('./network-interfaces')
@@ -18,6 +19,18 @@ module.exports = class UDX {
     binding.udx_napi_init(this._handle, this._buffer)
   }
 
+  static isIPv4 (host) {
+    return ip.isIPv4(host)
+  }
+
+  static isIPv6 (host) {
+    return ip.isIPv6(host)
+  }
+
+  static isIP (host) {
+    return ip.isIP(host)
+  }
+
   _consumeMessage (len) {
     const next = this._buffer.subarray(0, len)
     this._buffer = this._buffer.subarray(len)

test/socket.js

@@ -1,7 +1,6 @@
 const test = require('brittle')
 const b4a = require('b4a')
 const UDX = require('../')
-const UDXSocket = require('../lib/socket')
 
 test('can bind and close', async function (t) {
   const u = new UDX()
@@ -648,21 +647,3 @@ test('set send buffer size', async function (t) {
 
   await a.close()
 })
-
-test('UDXSocket - isIPv4', function (t) {
-  t.is(UDXSocket.isIPv4('127.0.0.1'), true)
-  t.is(UDXSocket.isIPv4('::1'), false)
-  t.is(UDXSocket.isIPv4('0.-1.0.0'), false)
-})
-
-test('UDXSocket - isIPv6', function (t) {
-  t.is(UDXSocket.isIPv6('127.0.0.1'), false)
-  t.is(UDXSocket.isIPv6('::1'), true)
-  t.is(UDXSocket.isIPv6('0.-1.0.0'), false)
-})
-
-test('UDXSocket - isIP', function (t) {
-  t.is(UDXSocket.isIP('127.0.0.1'), 4)
-  t.is(UDXSocket.isIP('::1'), 6)
-  t.is(UDXSocket.isIP('0.-1.0.0'), 0)
-})

test/udx.js

@@ -65,3 +65,21 @@ test('network interfaces - watch, unwatch and destroy twice', async function (t)
     t.pass()
   })
 })
+
+test('UDX - isIPv4', function (t) {
+  t.is(UDX.isIPv4('127.0.0.1'), true)
+  t.is(UDX.isIPv4('::1'), false)
+  t.is(UDX.isIPv4('0.-1.0.0'), false)
+})
+
+test('UDX - isIPv6', function (t) {
+  t.is(UDX.isIPv6('127.0.0.1'), false)
+  t.is(UDX.isIPv6('::1'), true)
+  t.is(UDX.isIPv6('0.-1.0.0'), false)
+})
+
+test('UDX - isIP', function (t) {
+  t.is(UDX.isIP('127.0.0.1'), 4)
+  t.is(UDX.isIP('::1'), 6)
+  t.is(UDX.isIP('0.-1.0.0'), 0)
+})