pkg: add type lints using tsc.

.github/workflows/node.js.yml

@@ -17,14 +17,17 @@ jobs:
         node-version: 20.x
 
     - name: Install tools
-      run: npm install --location=global bslint
+      run: npm install --location=global bslint typescript
 
     - name: Install dependencies
       run: npm install
 
     - name: Lint
       run: npm run lint
 
+    - name: Lint types
+      run: npm run lint-types
+
   cover:
     name: Coverage test
     runs-on: ubuntu-latest

lib/ip.js

@@ -29,6 +29,10 @@ const inet = require('./inet');
 const onion = require('./onion');
 const binet = exports;
 
+/** @typedef {import('bufio').BufferWriter} BufferWriter */
+/** @typedef {import('bufio').StaticWriter} StaticWriter */
+/** @typedef {import('bufio').BufferReader} BufferReader */
+
 /*
  * Constants
  */
@@ -225,19 +229,21 @@ binet.write = function write(dst, str, off, size) {
 
 /**
  * Write an IP string to a buffer writer.
- * @param {BufferWriter} bw
+ * @param {BufferWriter|StaticWriter} bw
  * @param {String} str
  * @param {Number} [size=16]
- * @returns {BufferWriter}
+ * @returns {BufferWriter|StaticWriter}
  */
 
 binet.writeBW = function writeBW(bw, str, size) {
   assert(bw && typeof bw === 'object');
 
   // StaticWriter
+  // @ts-ignore
   if (bw.data) {
-    bw.offset = binet.write(bw.data, str, bw.offset, size);
-    return bw;
+    const sw = /** @type {StaticWriter} */(bw);
+    sw.offset = binet.write(sw.data, str, sw.offset, size);
+    return sw;
   }
 
   const buf = Buffer.alloc(size);
@@ -696,7 +702,7 @@ binet.isEqualString = function isEqualString(a, b) {
  * Apply a network mask to IP.
  * @param {String} str
  * @param {String} mask
- * @returns {Buffer}
+ * @returns {String}
  */
 
 binet.maskString = function maskString(str, mask) {
@@ -715,7 +721,7 @@ binet.maskString = function maskString(str, mask) {
  * to IP from CIDR bits.
  * @param {String} str
  * @param {Number} bits
- * @returns {Buffer}
+ * @returns {String}
  */
 
 binet.cidrString = function cidrString(str, bits) {
@@ -1382,7 +1388,7 @@ binet.getReachability = function getReachability(src, dest) {
  * @private
  * @param {Number} filter
  * @param {Number} af
- * @returns {String}
+ * @returns {String[]}
  */
 
 binet._interfaces = function _interfaces(filter, af) {
@@ -1472,7 +1478,7 @@ binet._interfaces = function _interfaces(filter, af) {
 /**
  * Get local IP from network interfaces.
  * @param {String?} family - IP family name.
- * @returns {String}
+ * @returns {String[]}
  */
 
 binet.getInterfaces = function getInterfaces(family) {
@@ -1482,7 +1488,7 @@ binet.getInterfaces = function getInterfaces(family) {
 /**
  * Get local IP from network interfaces.
  * @param {String?} family - IP family name.
- * @returns {String}
+ * @returns {String[]}
  */
 
 binet.getLocal = function getLocal(family) {
@@ -1492,7 +1498,7 @@ binet.getLocal = function getLocal(family) {
 /**
  * Get non-local IP from network interfaces.
  * @param {String?} family - IP family name.
- * @returns {String}
+ * @returns {String[]}
  */
 
 binet.getNonlocal = function getNonlocal(family) {
@@ -1502,7 +1508,7 @@ binet.getNonlocal = function getNonlocal(family) {
 /**
  * Get private IP from network interfaces.
  * @param {String?} family - IP family name.
- * @returns {String}
+ * @returns {String[]}
  */
 
 binet.getPrivate = function getPrivate(family) {
@@ -1512,7 +1518,7 @@ binet.getPrivate = function getPrivate(family) {
 /**
  * Get public IP from network interfaces.
  * @param {String?} family - IP family name.
- * @returns {String}
+ * @returns {String[]}
  */
 
 binet.getPublic = function getPublic(family) {
@@ -1588,9 +1594,13 @@ binet.equal = binet.isEqualString;
  * Compat (deprecated)
  */
 
+// @ts-ignore
 types.NAME = 0;
+// @ts-ignore
 types.DNS = 0;
+// @ts-ignore
 types.IPV4 = 4;
+// @ts-ignore
 types.IPV6 = 6;
 
 binet.toString = binet.encode;

lib/onion.js

@@ -39,7 +39,7 @@ onion.is = function is(raw) {
 
 /**
  * Encode onion address.
- * @param {Buffer} key
+ * @param {Buffer} raw
  * @param {Function} sha3
  * @returns {String}
  */
@@ -116,7 +116,7 @@ onion.isLegacy = function isLegacy(raw) {
 
 /**
  * Encode onion address.
- * @param {Buffer} key
+ * @param {Buffer} raw
  * @returns {String}
  */
 

package.json

@@ -18,16 +18,18 @@
   "main": "./lib/binet.js",
   "scripts": {
     "lint": "eslint lib/ test/",
+    "lint-types": "tsc -p .",
     "test": "bmocha --reporter spec test/*-test.js",
     "test-ci": "nyc --reporter lcov bmocha -- --reporter spec test/*.js"
   },
   "dependencies": {
     "bs32": "~0.1.5",
-    "bsert": "~0.0.10"
+    "bsert": "~0.0.12"
   },
   "devDependencies": {
-    "bmocha": "^2.1.0",
-    "bufio": "^1.0.7"
+    "bmocha": "^2.1.8",
+    "bts-type-deps": "^0.0.3",
+    "bufio": "^1.2.0"
   },
   "engines": {
     "node": ">=8.0.0"

tsconfig.json

@@ -0,0 +1,31 @@
+{
+  "include": [
+    "lib/**/*.js"
+  ],
+  "compilerOptions": {
+    "rootDir": ".",
+    "target": "ES2016",
+    "lib": [
+      "ES2016"
+    ],
+
+    "noEmit": true,
+
+    "allowJs": true,
+    "checkJs": true,
+    "maxNodeModuleJsDepth": 2,
+
+    "module": "commonjs",
+    "moduleResolution": "node",
+    "resolveJsonModule": true,
+
+    "stripInternal": true,
+    "noImplicitThis": true,
+    "noUnusedLocals": true,
+    "noUnusedParameters": false,
+
+    "typeRoots": [
+      "node_modules/bts-type-deps/types"
+    ]
+  }
+}