feat: support typescript.

.gitignore

@@ -11,6 +11,7 @@ package-lock.json
 .cache
 .DS_Store
 .rdoc-dist
+*.tsbuildinfo
 
 *.bak
 *.tem

index.d.ts

@@ -0,0 +1,21 @@
+export = whereis;
+/**
+ * @typedef {Object} Options
+ * @property {'buffer' | null} encoding `encoding` means stdout/stderr are definitely `Buffer`.
+ *
+ * @typedef {import("child_process").ExecOptions} ExecOptions
+ * @param {string} command
+ * @param {ExecOptions & Options} options
+ * @returns {Promise<string>}
+ */
+declare function whereis(command: string, options: ExecOptions & Options): Promise<string>;
+declare namespace whereis {
+    export { Options, ExecOptions };
+}
+type ExecOptions = import("child_process").ExecOptions;
+type Options = {
+    /**
+     * `encoding` means stdout/stderr are definitely `Buffer`.
+     */
+    encoding: 'buffer' | null;
+};

index.js

@@ -1,6 +1,15 @@
 const { exec } = require('child_process');
 
-module.exports = function whereis(command, options) {
+/**
+ * @typedef {Object} Options
+ * @property {'buffer' | null} encoding `encoding` means stdout/stderr are definitely `Buffer`.
+ * 
+ * @typedef {import("child_process").ExecOptions} ExecOptions
+ * @param {string} command 
+ * @param {ExecOptions & Options} options 
+ * @returns {Promise<string>}
+ */
+function whereis(command, options) {
   return new Promise((resolve, reject) => {
     if (!command) {
       return reject('No command name is passed!');
@@ -11,11 +20,13 @@ module.exports = function whereis(command, options) {
         reject(`Could not find ${command} on your system; ${error.message ? error.message : ''}`);
         return;
       }
-      stdout = stdout.split('\n')[0];
-      if (stdout === '' || stdout.charAt(0) !== '/') {
+      const str = stdout.toString().split('\n')[0];
+      if (str === '' || str.charAt(0) !== '/') {
         reject(new Error(`Could not find ${command} on your system;`));
       }
-      resolve(stdout, stderr);
+      resolve(str);
     });
   });
-}
+}
+
+module.exports = whereis;

package.json

@@ -15,6 +15,7 @@
   ],
   "main": "index.js",
   "scripts": {
+    "tsc": "tsc --build",
     "start": "idoc --watch",
     "build": "idoc",
     "test": "jest",
@@ -23,8 +24,9 @@
   "author": "kenny wong <wowohoo@qq.com>",
   "license": "MIT",
   "devDependencies": {
-    "idoc": "^1.21.4",
-    "jest": "^28.1.2"
+    "idoc": "^1.26.6",
+    "jest": "^29.6.3",
+    "typescript": "^5.1.6"
   },
   "jest": {
     "coverageReporters": [

tsconfig.json

@@ -0,0 +1,11 @@
+{
+  "include": ["*.js"],
+  "compilerOptions": {
+    "target": "ES6",
+    "module": "CommonJS",
+    "strict": true,
+    "declaration": true,
+    "checkJs": true,
+    "emitDeclarationOnly": true
+  }
+}