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

.github/workflows/build.yml

@@ -16,14 +16,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
+
   test:
     name: Test
     runs-on: ${{ matrix.os }}

lib/brq.js

@@ -6,4 +6,6 @@
 
 'use strict';
 
-module.exports = require('./request');
+const {request} = require('./request');
+
+module.exports = request;

lib/request-browser.js

@@ -313,7 +313,6 @@ class Response {
   /**
    * Response
    * @constructor
-   * @ignore
    */
 
   constructor() {
@@ -430,6 +429,7 @@ request.stream = function stream(options) {
   const s = new EventEmitter();
   const body = [];
 
+  // @ts-ignore
   s.write = (data, enc) => {
     if (!Buffer.isBuffer(data)) {
       assert(typeof data === 'string');
@@ -439,6 +439,7 @@ request.stream = function stream(options) {
     return true;
   };
 
+  // @ts-ignore
   s.end = () => {
     options.extra = Buffer.concat(body);
     _request(options, false).then((res) => {
@@ -461,4 +462,4 @@ request.stream = function stream(options) {
  * Expose
  */
 
-module.exports = request;
+exports.request = request;

lib/request.js

@@ -341,7 +341,6 @@ class Request extends Stream {
   /**
    * Request
    * @constructor
-   * @private
    * @param {Object} options
    */
 
@@ -641,4 +640,4 @@ function ensureRequires(ssl) {
  * Expose
  */
 
-module.exports = request;
+exports.request = request;

package.json

@@ -16,13 +16,15 @@
   "main": "./lib/brq.js",
   "scripts": {
     "lint": "eslint lib/ test/",
+    "lint-types": "tsc -p .",
     "test": "bmocha --reporter spec test/*-test.js"
   },
   "dependencies": {
     "bsert": "~0.0.12"
   },
   "devDependencies": {
-    "bmocha": "^2.1.8"
+    "bmocha": "^2.1.8",
+    "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"
+    ]
+  }
+}