@hugoalh/env

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

https://github.com/hugoalh/env-es

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

✓
CITATION.cff file
Found CITATION.cff file
✓
codemeta.json file
Found codemeta.json file
✓
.zenodo.json file
Found .zenodo.json file
○
DOI references
○
Academic publication links
○
Committers with academic emails
○
Institutional organization owner
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (7.9%) to scientific vocabulary

Keywords

ecmascript ecmascript-module env environment-variables es es-module esm esmodule javascript js ts typescript

Keywords from Contributors

mesh sequences interactive hacking network-simulation

Last synced: 4 months ago · JSON representation ·

Repository

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

Basic Info

Host: GitHub
Owner: hugoalh
License: other
Language: TypeScript
Default Branch: main
Homepage:
Size: 123 KB

Statistics

Stars: 1
Watchers: 1
Forks: 0
Open Issues: 2
Releases: 3

Topics

ecmascript ecmascript-module env environment-variables es es-module esm esmodule javascript js ts typescript

Created about 1 year ago · Last pushed 5 months ago

Metadata Files

Readme Contributing License Citation Codeowners Security

README.md

Env (ES)

⚖️ MIT

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

ts const env: Env;
ts interface Env extends EnvGeneral { delimitation: EnvDelimitation; path: EnvPath; pathext: EnvPathExt; }
ts 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; }
ts 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; }
ts 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[]; }
ts 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] - For the full or prettier documentation, can visit via: - Deno CLI deno doc - JSR

✍️ Examples

ts env.set("SOME_VAR", "Value"); env.has("SOME_VAR"); //=> true env.get("SOME_VAR"); //=> "Value"

Owner

Name: hugoalh
Login: hugoalh
Kind: user
Location: Everywhere
Company: @hugoalh-studio

Twitter: hugoalhofficial
Repositories: 12
Profile: https://github.com/hugoalh

Lead of @hugoalh-studio; Full time software developer; Part time freelancer

Citation (CITATION.cff)

# yaml-language-server: $schema=https://citation-file-format.github.io/1.2.0/schema.json
cff-version: "1.2.0"
title: "Env (ES)"
message: "If you use this software, please cite it using the metadata from this file."
type: "software"
authors:
  - name: "hugoalh"
repository-code: "https://github.com/hugoalh/env-es"
keywords:
  - "ecmascript"
  - "ecmascript-module"
  - "env"
  - "environment-variables"
  - "es"
  - "es-module"
  - "esm"
  - "esmodule"
  - "javascript"
  - "js"
  - "ts"
  - "typescript"
license: "MIT"

GitHub Events

Total

Release event: 2
Delete event: 6
Push event: 31
Pull request event: 9
Pull request review event: 5
Create event: 6

Last Year

Release event: 2
Delete event: 6
Push event: 31
Pull request event: 9
Pull request review event: 5
Create event: 6

Committers

Last synced: 9 months ago

All Time

Total Commits: 36
Total Committers: 2
Avg Commits per committer: 18.0
Development Distribution Score (DDS): 0.167

Past Year

Commits: 36
Committers: 2
Avg Commits per committer: 18.0
Development Distribution Score (DDS): 0.167

Top Committers

Name	Email	Commits
hugoalh	h**h@g**m	30
dependabot[bot]	4****]	6

Issues and Pull Requests

Last synced: 5 months ago

All Time

Total issues: 0
Total pull requests: 11
Average time to close issues: N/A
Average time to close pull requests: about 16 hours
Total issue authors: 0
Total pull request authors: 1
Average comments per issue: 0
Average comments per pull request: 0.45
Merged pull requests: 6
Bot issues: 0
Bot pull requests: 11

Past Year

Issues: 0
Pull requests: 11
Average time to close issues: N/A
Average time to close pull requests: about 16 hours
Issue authors: 0
Pull request authors: 1
Average comments per issue: 0
Average comments per pull request: 0.45
Merged pull requests: 6
Bot issues: 0
Bot pull requests: 11

View more stats

Top Authors

Issue Authors

Pull Request Authors

dependabot[bot] (16)

Top Labels

Issue Labels

Pull Request Labels

Type/Dependency 📦 (16) Platform/GitHubActions (16) Priority/Low 🟢 (10) Status/Pending 🔵 (5)

Packages

Total packages: 1
Total downloads:
- npm 92 last-month

Total dependent packages: 0
Total dependent repositories: 0
Total versions: 4
Total maintainers: 1

npmjs.org: @hugoalh/env

A module for enhanced environment variables operation.

Homepage: https://github.com/hugoalh/env-es#readme
License: MIT
Latest release: 0.3.0
published 5 months ago

Versions: 4
Dependent Packages: 0
Dependent Repositories: 0
Downloads: 92 Last month

Rankings

Dependent repos count: 25.7%

Average: 31.5%

Dependent packages count: 37.2%

Maintainers (1)

hugoalh

Last synced: 5 months ago