feat: add TypeScript typings

Author: sjinks

index.d.ts

@@ -0,0 +1,6 @@
+declare function _exports(reload?: boolean): import("config").IConfig;
+declare namespace _exports {
+    export { reloadConfigs };
+}
+export = _exports;
+declare function reloadConfigs(): import("config").IConfig;

index.js

@@ -1,5 +1,8 @@
 'use strict';
 
+/**
+ * @return {import("config").IConfig}
+ */
 function reloadConfigs () {
   const config = require('config');
   const sources = config.util.getConfigSources();
@@ -15,6 +18,10 @@ function reloadConfigs () {
   return require('config');
 }
 
+/**
+ * @param {boolean} [reload=false] Whether to reload the configuration
+ * @return {import("config").IConfig}
+ */
 module.exports = function (reload) {
   return reload ? reloadConfigs() : require('config');
 };

package-lock.json

@@ -3,6 +3,7 @@
   "version": "1.0.10",
   "description": "Reloadable version of config",
   "main": "index.js",
+  "types": "index.d.ts",
   "scripts": {
     "test": "nyc --reporter=clover --reporter=text mocha test/"
   },
@@ -25,13 +26,18 @@
   },
   "homepage": "https://github.com/sjinks/node-config-reloadable#readme",
   "devDependencies": {
+    "@types/config": "^3.3.3",
     "config": "^3.3.9",
     "mocha": "^10.2.0",
     "nyc": "^15.1.0"
   },
   "peerDependencies": {
     "config": "*"
   },
+  "files": [
+    "index.js",
+    "index.d.ts"
+  ],
   "publishConfig": {
     "provenance": true
   }