Skip to main content
Home
Browse packagesDocsSign in

@hugoalh/env@0.3.0
Built and signed on GitHub Actions

latest
hugoalh/env-es

A module for enhanced environment variables operation.

This package works with DenoIt is unknown whether this package works with Node.js, Bun
It is unknown whether this package works with Node.js
This package works with Deno
It is unknown whether this package works with Bun
JSR Score
70%
Published
3 months ago (0.3.0)

Env (ES)

⚖️ MIT

GitHub: hugoalh/env-es JSR: @hugoalh/env NPM: @hugoalh/env

An ECMAScript (JavaScript & TypeScript) module for enhanced environment variables operation.

🔰 Begin

🎯 Targets

Targets Remote JSR NPM
Bun >= v1.1.0 ❌ ❓ ✔️
Deno >= v2.1.0 ✔️ ✔️ ✔️
NodeJS >= v20.9.0 ❌ ❓ ✔️
Note

  • It is possible to use this module in other methods/ways which not listed in here, however those methods/ways are not officially supported, and should beware maybe cause security issues.

#️⃣ Resources Identifier

  • Remote - GitHub Raw: 
    https://raw.githubusercontent.com/hugoalh/env-es/{Tag}/mod.ts
  • JSR: 
    [jsr:]@hugoalh/env[@{Tag}]
  • NPM: 
    [npm:]@hugoalh/env[@{Tag}]
Note

  • For usage of remote resources, it is recommended to import the entire module with the main path mod.ts, however it is also able to import part of the module with sub path if available, but do not import if:

    • it's 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.: _bar, _foo).

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

  • For usage of JSR or NPM resources, it is recommended to import the entire module with the main entrypoint, however it is also able to import part of the module with sub entrypoint if available, please visit the file jsr.jsonc property exports for available sub entrypoints.

  • It is recommended to use this module with tag for immutability.

🛡️ Runtime Permissions

  • Environment Variable (Deno: env):
    • PATH (Optional)
    • PATHEXT (Optional, Windows Platforms)
    • Resources
  • File System - Read (Deno: read; NodeJS: fs-read):
    • Resources (Optional)
  • System Info (Deno: sys):
    • gid (Optional, POSIX/UNIX Platforms)
    • uid (Optional, POSIX/UNIX Platforms)

🧩 APIs

  • const env: Env;

  • interface Env extends EnvGeneral {
  delimitation: EnvDelimitation;
  path: EnvPath;
  pathext: EnvPathExt;
}

  • interface EnvGeneral {
  delete(...keys: readonly (string | RegExp)[]): void;
  get(key: string): string | undefined;
  getAll(): Record<string, string>;
  has(key: string | RegExp): boolean;
  set(key: string, value: string): void;
}

  • interface EnvDelimitation {
  add(key: string, ...values: readonly string[]): void;
  addAtEnd(key: string, ...values: readonly string[]): void;
  addAtIndex(key: string, index: number, ...values: readonly string[]): void;
  addAtStart(key: string, ...values: readonly string[]): void;
  deDuplicate(key: string): void;
  delete(key: string, ...values: readonly string[]): void;
  get(key: string): string[];
  set(key: string, values: readonly string[]): void;
}

  • interface EnvPath {
  add(...values: readonly string[]): void;
  addAtEnd(...values: readonly string[]): void;
  addAtIndex(index: number, ...values: readonly string[]): void;
  addAtStart(...values: readonly string[]): void;
  deDuplicate(): void;
  delete(...values: readonly string[]): void;
  get(): string[];
}

  • interface EnvPathExt {
  add(...values: readonly string[]): void;
  addAtEnd(...values: readonly string[]): void;
  addAtIndex(index: number, ...values: readonly string[]): void;
  addAtStart(...values: readonly string[]): void;
  deDuplicate(): void;
  delete(...values: readonly string[]): void;
  get(): string[] | null;
  reset(): void;
}
Note

✍️ Examples

  • env.set("SOME_VAR", "Value");
env.has("SOME_VAR");
//=> true
env.get("SOME_VAR");
//=> "Value"
Built and signed on
GitHub Actions
View transparency log

New Ticket: Report package

Please provide a reason for reporting this package. We will review your report and take appropriate action.

Please review the JSR usage policy before submitting a report.

Add Package

deno add jsr:@hugoalh/env

Import symbol

import * as env from "@hugoalh/env";
or

Import directly with a jsr specifier

import * as env from "jsr:@hugoalh/env";

Add Package

pnpm i jsr:@hugoalh/env
or (using pnpm 10.8 or older)
pnpm dlx jsr add @hugoalh/env

Import symbol

import * as env from "@hugoalh/env";

Add Package

yarn add jsr:@hugoalh/env
or (using Yarn 4.8 or older)
yarn dlx jsr add @hugoalh/env

Import symbol

import * as env from "@hugoalh/env";

Add Package

vlt install jsr:@hugoalh/env

Import symbol

import * as env from "@hugoalh/env";

Add Package

npx jsr add @hugoalh/env

Import symbol

import * as env from "@hugoalh/env";

Add Package

bunx jsr add @hugoalh/env

Import symbol

import * as env from "@hugoalh/env";