Merge PR #2 from 'nodech/ts-lint'

.github/workflows/build.yml

@@ -15,12 +15,18 @@ jobs:
       with:
         node-version: 18.x
 
+    - name: Install tools
+      run: npm install --location=global bslint typescript
+
     - name: Install dependencies
-      run: npm install --location=global bslint
+      run: npm install
 
     - name: Lint
       run: npm run lint
 
+    - name: Lint types
+      run: npm run lint-types
+
   test:
     name: Test
     runs-on: ubuntu-latest

.npmignore

@@ -15,3 +15,4 @@ package-lock.json
 test/
 webpack.*.js
 yarn.lock
+coverage/

lib/bheep.js

@@ -1,3 +1,5 @@
 'use strict';
 
-module.exports = require('./heap');
+const {Heap} = require('./heap');
+
+module.exports = Heap;

lib/heap.js

@@ -8,16 +8,31 @@
 
 const assert = require('bsert');
 
+/**
+ * @template T
+ * @callback HeapComparator
+ * @param {T} a
+ * @param {T} b
+ * @returns {Number}
+ */
+
 /**
  * Binary Heap
  * @alias module:utils.Heap
+ * @template T
  */
 
 class Heap {
+  /** @type {HeapComparator<T>} */
+  compare;
+
+  /** @type {T[]} */
+  items;
+
   /**
    * Create a binary heap.
    * @constructor
-   * @param {Function?} compare
+   * @param {HeapComparator<T>} [compare]
    */
 
   constructor(compare) {
@@ -53,7 +68,7 @@ class Heap {
 
   /**
    * Set comparator.
-   * @param {Function} compare
+   * @param {HeapComparator<T>} compare
    */
 
   set(compare) {
@@ -64,8 +79,8 @@ class Heap {
 
   /**
    * Push item onto heap.
-   * @param {Object} item
-   * @returns {Number}
+   * @param {T} item
+   * @returns {Number} Heap size.
    */
 
   insert(item) {
@@ -76,8 +91,7 @@ class Heap {
 
   /**
    * Pop next item off of heap.
-   * @param {Object} item
-   * @returns {Object}
+   * @returns {T}
    */
 
   shift() {
@@ -95,7 +109,7 @@ class Heap {
   /**
    * Remove item from heap.
    * @param {Number} i
-   * @returns {Object}
+   * @returns {T}
    */
 
   remove(i) {
@@ -197,14 +211,13 @@ class Heap {
 
   /**
    * Convert heap to sorted array.
-   * @returns {Object[]}
+   * @returns {T[]}
    */
 
   toArray() {
-    const heap = new Heap();
+    const heap = new Heap(this.compare);
     const result = [];
 
-    heap.compare = this.compare;
     heap.items = this.items.slice();
 
     while (heap.size() > 0)
@@ -215,13 +228,14 @@ class Heap {
 
   /**
    * Instantiate heap from array and comparator.
-   * @param {Function} compare
-   * @param {Object[]} items
-   * @returns {Heap}
+   * @template T
+   * @param {HeapComparator<T>} compare
+   * @param {T[]} items
+   * @returns {Heap<T>}
    */
 
   static fromArray(compare, items) {
-    const heap = new Heap();
+    const heap = new Heap(compare);
     heap.set(compare);
     heap.items = items;
     heap.init();
@@ -233,6 +247,12 @@ class Heap {
  * Helpers
  */
 
+/**
+ * @param {*} a
+ * @param {*} b
+ * @returns {Number}
+ */
+
 function comparator(a, b) {
   throw new Error('No heap comparator set.');
 }
@@ -241,4 +261,4 @@ function comparator(a, b) {
  * Expose
  */
 
-module.exports = Heap;
+exports.Heap = Heap;

package.json

@@ -16,13 +16,15 @@
   "main": "./lib/bheep.js",
   "scripts": {
     "lint": "eslint lib/ test/",
-    "test": "bmocha --reporter spec test/*-test.js"
+    "test": "bmocha --reporter spec test/*-test.js",
+    "lint-types": "tsc -p ."
   },
   "dependencies": {
-    "bsert": "~0.0.10"
+    "bsert": "~0.0.12"
   },
   "devDependencies": {
-    "bmocha": "^2.1.0"
+    "bmocha": "^2.1.0",
+    "bts-type-deps": "^0.0.3"
   },
   "engines": {
     "node": ">=8.0.0"

tsconfig.json

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