Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: optimized env shim & support object.keys #119

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
.idea
node_modules
*.log*
dist
Expand Down
103 changes: 72 additions & 31 deletions src/env.ts
Original file line number Diff line number Diff line change
@@ -1,41 +1,82 @@
const _envShim = Object.create(null);

export type EnvObject = Record<string, string | undefined>;

const _getEnv = (useShim?: boolean) =>
const _getEnv = (): Record<string, any> | undefined =>
globalThis.process?.env ||
import.meta.env ||
globalThis.Deno?.env.toObject() ||
globalThis.__env__ ||
(useShim ? _envShim : globalThis);
globalThis.__env__;

export const env = new Proxy<EnvObject>(_envShim, {
get(_, prop) {
const env = _getEnv();
return env[prop as any] ?? _envShim[prop];
},
has(_, prop) {
const env = _getEnv();
return prop in env || prop in _envShim;
},
set(_, prop, value) {
const env = _getEnv(true);
env[prop as any] = value;
return true;
},
deleteProperty(_, prop) {
if (!prop) {
return false;
}
const env = _getEnv(true);
delete env[prop as any];
return true;
},
ownKeys() {
const env = _getEnv(true);
return Object.keys(env);
export const env = new Proxy<EnvObject>(
{},
{
get(target, prop) {
const env = _getEnv();
if (env && Reflect.has(env, prop)) {
return env[prop as any];
}

return target[prop as any];
},
has(target, prop) {
const env = _getEnv();
if (env && Reflect.has(env, prop)) {
return Reflect.has(env, prop);
}

return Reflect.has(target, prop);
},
set(target, prop, value) {
const env = _getEnv();
if (env) {
env[prop as any] = value;
} else {
target[prop as any] = value;
}

return true;
},
deleteProperty(target, prop) {
if (!prop) {
return false;
}

const env = _getEnv();
if (env && Reflect.has(env, prop)) {
delete env[prop as any];
}

delete target[prop as any];
return true;
},
ownKeys(target) {
const env = _getEnv();
return [
...new Set([
...Reflect.ownKeys(target),
...(env ? Reflect.ownKeys(env) : []),
]),
];
},
getOwnPropertyDescriptor(
target: EnvObject,
p: string | symbol,
): PropertyDescriptor | undefined {
if (Reflect.has(target, p)) {
return Reflect.getOwnPropertyDescriptor(target, p);
}

const env = _getEnv();
if (env && Reflect.has(env, p)) {
return {
...Reflect.getOwnPropertyDescriptor(env, p),
enumerable: true,
};
}

return undefined;
},
},
});
);

export const nodeENV =
(typeof process !== "undefined" && process.env && process.env.NODE_ENV) || "";
21 changes: 21 additions & 0 deletions test/env.spec.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
import { it, describe, expect } from "vitest";
import { env } from "../src";

const set = (key: string, value: string | undefined) => {
if (value === undefined) {
delete env[key];
return;
}

env[key] = value;
};

describe("std-env", () => {
it("should read many env vars", () => {
set("foo", "bar");

expect(Object.keys(env).length).toBeGreaterThanOrEqual(1);

set("foo", undefined);
});
});