alepha/src/core/primitives/$env.ts

Easy-to-use modern TypeScript framework for building many kind of applications.

import { AlephaError } from "../errors/AlephaError.ts";
import type { Static, TObject } from "../providers/TypeProvider.ts";
import { z } from "../providers/TypeProvider.ts";
import { $context } from "./$context.ts";

/**
 * Get typed values from environment variables.
 *
 * @example
 * ```ts
 * const alepha = Alepha.create({
 *   env: {
 *     // Alepha.create() will also use process.env when running on Node.js
 *     HELLO: "world",
 *   }
 * });
 *
 * class App {
 *   log = $logger();
 *
 *   // program expect a var env "HELLO" as string to works
 *   env = $env(z.object({
 *     HELLO: z.text()
 *   }));
 *
 *   sayHello = () => this.log.info("Hello ${this.env.HELLO}")
 * }
 *
 * run(alepha.with(App));
 * ```
 */
export const $env = <T extends TObject>(type: T): Static<T> => {
  const { alepha } = $context();

  // allow to inject TypeBox schemas
  if (!z.schema.isObject(type)) {
    throw new AlephaError("Type must be an TObject");
  }

  return alepha.parseEnv(type) as Static<T>;
};