@nitra/check-env 3.0.0 → 3.1.0

package/package.json

@@ -1,9 +1,10 @@
 {
   "name": "@nitra/check-env",
-  "version": "3.0.0",
+  "version": "3.1.0",
   "description": "Check that the critical environment variables are set",
   "type": "module",
   "main": "./src/index.js",
+  "types": "./types/index.d.ts",
   "exports": {
     ".": "./src/index.js"
   },
@@ -36,6 +37,7 @@
   ],
   "prettier": "@nitra/prettier-config",
   "files": [
-    "src"
+    "src",
+    "types"
   ]
 }

package/src/index.js

@@ -6,6 +6,12 @@ const displayMissing = name => {
   console.error(`❌  Missing required environment variable ${name}`)
 }
 
+/**
+ * MissingEnvironmentVariableError
+ *
+ * @class
+ * @extends Error
+ */
 export class MissingEnvironmentVariableError extends Error {
   constructor(envs) {
     const joined = envs.join(', ')
@@ -14,6 +20,13 @@ export class MissingEnvironmentVariableError extends Error {
 }
 
 const checked = new Set()
+
+/**
+ * Перевірка наявності змінних середовища
+ *
+ * @function
+ * @param {Array.<String>} required
+ */
 export const checkEnv = required => {
   const missingReq = []
 
@@ -32,7 +45,11 @@ export const checkEnv = required => {
   }
 }
 
-// Для сумісності з попередніми версіями
+/**
+ * Для сумісності з попередніми версіями
+ *
+ * @param {Array.<String>} required to capture
+ */
 export default checkEnv
 
 const envProxyHandler = {

package/types/index.d.ts

@@ -0,0 +1,17 @@
+/**
+ * MissingEnvironmentVariableError
+ *
+ * @class
+ * @extends Error
+ */
+export class MissingEnvironmentVariableError extends Error {
+    constructor(envs: any);
+}
+export function checkEnv(required: Array<string>): void;
+export default checkEnv;
+/**
+ * @type {Object.<string, string>}
+ */
+export const env: {
+    [x: string]: string;
+};