js-utils-kit 0.0.0 → 0.2.0

package/dist/env/index.cjs

@@ -0,0 +1 @@
+"use strict";var e;function n(){switch(process.env.NODE_ENV){case exports.Environment.PROD:return exports.Environment.PROD;case exports.Environment.DEV:return exports.Environment.DEV;case exports.Environment.TEST:return exports.Environment.TEST;default:return exports.Environment.UNKNOWN}}function r(){return process.env.NODE_ENV===exports.Environment.PROD}function o(){return process.env.NODE_ENV===exports.Environment.DEV}function t(){return process.env.NODE_ENV===exports.Environment.TEST}function s(){return"undefined"!=typeof process&&null!==process.versions&&null!==process.versions.node}function i(){return"undefined"!=typeof window&&void 0!==window.document}Object.defineProperty(exports,"__esModule",{value:!0}),exports.Environment=void 0,(e=exports.Environment||(exports.Environment={})).PROD="production",e.DEV="development",e.TEST="test",e.UNKNOWN="unknown";var p={getRunTimeEnvironment:n,isProd:r,isDev:o,isTest:t,isNode:s,isBrowser:i};exports.default=p,exports.getRunTimeEnvironment=n,exports.isBrowser=i,exports.isDev=o,exports.isNode=s,exports.isProd=r,exports.isTest=t;

package/dist/env/index.d.ts

@@ -0,0 +1,128 @@
+/**
+ * Represents the standard runtime environments used in application development.
+ *
+ * This enum is typically used with `process.env.NODE_ENV` to determine
+ * whether the app is running in development, production, or test mode.
+ *
+ * @example
+ * ```ts
+ * if (process.env.NODE_ENV === Environment.DEV) {
+ *   console.log('Running in development mode');
+ * }
+ * ```
+ */
+declare enum Environment {
+    /** Production environment (`"production"`) */
+    PROD = "production",
+    /** Development environment (`"development"`) */
+    DEV = "development",
+    /** Testing environment (`"test"`) */
+    TEST = "test",
+    /** Unknown or undefined environment */
+    UNKNOWN = "unknown"
+}
+/**
+ * Returns the current runtime environment as one of the defined `Environment` enum values.
+ *
+ * @returns The current environment.
+ *
+ * @example
+ * ```ts
+ * const env = getRunTimeEnvironment();
+ * if (env === "development") {
+ *   console.log('Dev mode enabled');
+ * }
+ * ```
+ */
+declare function getRunTimeEnvironment(): Environment;
+/**
+ * Checks if the current environment is production.
+ *
+ * This is determined by comparing `process.env.NODE_ENV` with `'production'`.
+ *
+ * @returns `true` if `NODE_ENV` is set to production.
+ *
+ * @example
+ * ```ts
+ * if (isProd()) {
+ *   enableAnalytics();
+ * }
+ * ```
+ */
+declare function isProd(): boolean;
+/**
+ * Checks if the current environment is development.
+ *
+ * This is determined by comparing `process.env.NODE_ENV` with `'development'`.
+ *
+ * @returns `true` if `NODE_ENV` is set to development.
+ *
+ * @example
+ * ```ts
+ * if (isDev()) {
+ *   console.log('Dev mode enabled');
+ * }
+ * ```
+ */
+declare function isDev(): boolean;
+/**
+ * Checks if the current environment is testing.
+ *
+ * This is determined by comparing `process.env.NODE_ENV` with `'test'`.
+ *
+ * @returns `true` if `NODE_ENV` is set to test.
+ *
+ * @example
+ * ```ts
+ * if (isTest()) {
+ *   mockDatabase();
+ * }
+ * ```
+ */
+declare function isTest(): boolean;
+/**
+ * Checks if the current runtime environment is Node.js.
+ *
+ * This function is useful to conditionally execute server-side logic.
+ * It detects the Node.js environment by verifying the presence of the
+ * global `process` object and its `versions.node` property.
+ *
+ * @returns `true` if running in Node.js, otherwise `false`.
+ *
+ * @example
+ * ```ts
+ * if (isNode()) {
+ *   console.log('Running in Node.js environment');
+ * }
+ * ```
+ *
+ * @see {@link https://nodejs.org/api/process.html | Node.js process documentation}
+ */
+declare function isNode(): boolean;
+/**
+ * Checks if the current runtime environment is a browser.
+ *
+ * This function helps detect whether code is executing in a web browser
+ * by confirming the existence of the global `window` and `document` objects.
+ *
+ * @returns `true` if running in a browser, otherwise `false`.
+ *
+ * @example
+ * ```ts
+ * if (isBrowser()) {
+ *   console.log('Running in a browser environment');
+ * }
+ * ```
+ */
+declare function isBrowser(): boolean;
+
+declare const _default: {
+    getRunTimeEnvironment: typeof getRunTimeEnvironment;
+    isProd: typeof isProd;
+    isDev: typeof isDev;
+    isTest: typeof isTest;
+    isNode: typeof isNode;
+    isBrowser: typeof isBrowser;
+};
+
+export { Environment, _default as default, getRunTimeEnvironment, isBrowser, isDev, isNode, isProd, isTest };

package/dist/env/index.js

@@ -0,0 +1 @@
+var n;function e(){switch(process.env.NODE_ENV){case n.PROD:return n.PROD;case n.DEV:return n.DEV;case n.TEST:return n.TEST;default:return n.UNKNOWN}}function r(){return process.env.NODE_ENV===n.PROD}function o(){return process.env.NODE_ENV===n.DEV}function s(){return process.env.NODE_ENV===n.TEST}function t(){return"undefined"!=typeof process&&null!==process.versions&&null!==process.versions.node}function u(){return"undefined"!=typeof window&&void 0!==window.document}!function(n){n.PROD="production",n.DEV="development",n.TEST="test",n.UNKNOWN="unknown"}(n||(n={}));var i={getRunTimeEnvironment:e,isProd:r,isDev:o,isTest:s,isNode:t,isBrowser:u};export{n as Environment,i as default,e as getRunTimeEnvironment,u as isBrowser,o as isDev,t as isNode,r as isProd,s as isTest};