@theholocron/env-utils 1.0.1 → 1.0.2

package/README.md

@@ -0,0 +1,43 @@
+# `@theholocron/env-utils`
+
+Runtime environment detection and typed env-var parsing.
+
+## Installation
+
+```bash
+pnpm add @theholocron/env-utils
+pnpm add -D dotenv  # peer dependency, optional
+```
+
+## Usage
+
+### Environment detection
+
+```typescript
+import { environment, ENVIRONMENTS } from "@theholocron/env-utils";
+
+environment.get(); // "prod" | "qa" | "dev" | "local"
+environment.normalize("production"); // "prod"
+environment.isDeployed(); // true when qa or prod
+
+// reads ENVIRONMENT → ENV → NODE_ENV in priority order
+```
+
+### Env-var parsing
+
+```typescript
+import { createEnvParser } from "@theholocron/env-utils";
+
+const { get, map, deprecate } = createEnvParser({ appName: "my-app" });
+
+deprecate("database_url", "db__primary__url");
+
+export const config = map((get) => ({
+  port: get("port") ?? 3000,
+  db: { url: get("db.primary.url") ?? get("database_url") },
+}));
+```
+
+## Documentation
+
+Check out [The Holocron Archive](https://docs.theholocron.dev/projects/utils/) for more information.

package/dist/index.d.mts

@@ -1,24 +1,4 @@
 import "dotenv/config";
-//#region src/environment.d.ts
-declare const ENVIRONMENTS: readonly ["local", "dev", "qa", "prod"];
-declare const DEFAULT_ENVIRONMENT: Environment;
-declare const DEPLOYED_ENVIRONMENTS: Set<"local" | "dev" | "qa" | "prod">;
-/**
- * Normalize a string into a canonical Environment.
- * Returns undefined if the value is not recognized.
- */
-declare function normalizeEnvironment(value: string): Environment | undefined;
-/**
- * Resolve the current environment from input or process.env.
- */
-declare function getEnvironment(): Environment;
-declare const environment: {
-  get: typeof getEnvironment;
-  normalize: typeof normalizeEnvironment;
-  isDeployed: () => boolean;
-};
-type Environment = (typeof ENVIRONMENTS)[number];
-//#endregion
 //#region src/types.d.ts
 type Primitive = string | number | boolean;
 type EnvObject = {
@@ -129,6 +109,26 @@ interface EnvParser<T extends EnvObject = EnvObject> {
  */
 declare function createEnvParser<T extends EnvObject = EnvObject>(options: EnvParserOptions): EnvParser<T>;
 //#endregion
+//#region src/environment.d.ts
+declare const ENVIRONMENTS: readonly ["local", "dev", "qa", "prod"];
+declare const DEFAULT_ENVIRONMENT: Environment;
+declare const DEPLOYED_ENVIRONMENTS: Set<"local" | "dev" | "qa" | "prod">;
+/**
+ * Normalize a string into a canonical Environment.
+ * Returns undefined if the value is not recognized.
+ */
+declare function normalizeEnvironment(value: string): Environment | undefined;
+/**
+ * Resolve the current environment from input or process.env.
+ */
+declare function getEnvironment(): Environment;
+declare const environment: {
+  get: typeof getEnvironment;
+  normalize: typeof normalizeEnvironment;
+  isDeployed: () => boolean;
+};
+type Environment = (typeof ENVIRONMENTS)[number];
+//#endregion
 //#region src/loader.d.ts
 /**
  * Default loader — calls dotenv/config so the .env file is

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@theholocron/env-utils",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "description": "Runtime environment detection and typed env-var parsing.",
   "homepage": "https://github.com/theholocron/utils/tree/main/packages/env#readme",
   "bugs": "https://github.com/theholocron/utils/issues",