Skip to main content

Built and signed on GitHub Actions

A module for cross runtime environment variables interface.

This package works with Bun, Node.js, Deno
JSR Score
100%
Published
3 months ago (1.1.0)

Cross Env (TypeScript)

⚖ī¸ MIT

🗂ī¸ GitHub: hugoalh-studio/cross-env-ts JSR: @hugoalh/cross-env

🆙 Latest Release Version (Latest Release Date)

A TypeScript module for cross runtime environment variables interface.

đŸŽ¯ Target

  • Bun ^ v1.0.0
  • Deno >= v1.34.0 / >= v1.41.1 (Via JSR)

    🛡ī¸ Require Permission

    • Environment Variable (allow-env)
  • NodeJS >= v16.13.0

🔰 Usage

Via HTTPS

đŸŽ¯ Supported Target

  • Deno
  1. Import at the script (<ScriptName>.ts):
    • Via DenoPKG
      import ... from "https://denopkg.com/hugoalh-studio/cross-env-ts[@<Tag>]/mod.ts";
      
    • Via GitHub Raw (Require Tag)
      import ... from "https://raw.githubusercontent.com/hugoalh-studio/cross-env-ts/<Tag>/mod.ts";
      
    • Via Pax
      import ... from "https://pax.deno.dev/hugoalh-studio/cross-env-ts[@<Tag>]/mod.ts";
      

    ℹī¸ Note

    Although it is recommended to import the entire module with the main path mod.ts, it is also able to import part of the module with sub path if available, but do not import if:

    • it's file path has an underscore prefix (e.g.: _foo.ts, _util/bar.ts), or
    • it is a benchmark or test file (e.g.: foo.bench.ts, foo.test.ts), or
    • it's symbol has an underscore prefix (e.g.: export function _baz() {}).

    These elements are not considered part of the public API, thus no stability is guaranteed for them.

Via JSR With Native Support

đŸŽ¯ Supported Target

  • Deno
  1. Import at the script (<ScriptName>.ts):
    import ... from "jsr:@hugoalh/cross-env[@<Tag>]";
    

    ℹī¸ Note

    Although it is recommended to import the entire module, it is also able to import part of the module with sub path if available, please visit file jsr.jsonc property exports for available sub paths.

Via JSR With NPM Compatibility Layer Support

đŸŽ¯ Supported Target

  • Bun
  • NodeJS
  1. Install via console/shell/terminal:
    • Via Bun
      bunx jsr add @hugoalh/cross-env[@<Tag>]
      
    • Via NPM
      npx jsr add @hugoalh/cross-env[@<Tag>]
      
    • Via PNPM
      pnpm dlx jsr add @hugoalh/cross-env[@<Tag>]
      
    • Via Yarn
      yarn dlx jsr add @hugoalh/cross-env[@<Tag>]
      
  2. Import at the script (<ScriptName>.ts):
    import ... from "@hugoalh/cross-env";
    

    ℹī¸ Note

    Although it is recommended to import the entire module, it is also able to import part of the module with sub path if available, please visit file jsr.jsonc property exports for available sub paths.

🧩 API

  • const env: CrossEnv;
    
  • const envPath: CrossEnvPath;
    
  • const envPathExt: CrossEnvPathExt;
    
  • function isEnvironmentCI(): boolean;
    
  • function isEnvironmentDocker(): Promise<boolean>;
    
  • function isEnvironmentHeroku(): boolean;
    
  • function isEnvironmentHyper(): boolean;
    
  • function isEnvironmentPodman(): Promise<boolean>;
    
  • function isEnvironmentRoot(): boolean;
    
  • function isEnvironmentSSH(): boolean;
    
  • function isEnvironmentTravis(): boolean;
    
  • function isEnvironmentWSL(): Promise<boolean>;
    
  • interface CrossEnv {
      delete(key: string): void;
      get(key: string): string | undefined;
      getAll(): { [key: string]: string; };
      has(key: string): boolean;
      set(key: string, value: string): void;
    }
    
  • interface CrossEnvPath {
      add(...values: string[]): void;
      delete(...values: string[]): void;
      get(): string[];
    }
    
  • interface CrossEnvPathExt {
      add(...values: string[]): void;
      delete(...values: string[]): void;
      get(): string[] | null;
    }
    

ℹī¸ Note

For the prettier documentation, can visit via:

✍ī¸ Example

  • env.delete("SOME_VAR");
    
  • env.get("HOME");
    //=> "/home/alice"
    
  • env.get("SOME_VAR");
    //=> undefined
    
Built and signed on
GitHub Actions
View transparency log

Add Package

deno add @hugoalh/cross-env

Import symbol

import * as mod from "@hugoalh/cross-env";

Add Package

npx jsr add @hugoalh/cross-env

Import symbol

import * as mod from "@hugoalh/cross-env";

Add Package

yarn dlx jsr add @hugoalh/cross-env

Import symbol

import * as mod from "@hugoalh/cross-env";

Add Package

pnpm dlx jsr add @hugoalh/cross-env

Import symbol

import * as mod from "@hugoalh/cross-env";

Add Package

bunx jsr add @hugoalh/cross-env

Import symbol

import * as mod from "@hugoalh/cross-env";