@halospv3/hce.shared-config
Version:
Automate commit message quality, changelogs, and CI/CD releases. Exports a semantic-release shareable configuration deserialized from this package's '.releaserc.yml'. Shared resources for .NET projects are also distributed with this package.
24 lines • 1.61 kB
TypeScript
import { type DotenvConfigOptions, type GetOptions } from '@dotenvx/dotenvx';
/**
* A thin wrapper for {@link loadDotenv}. Loads a .env file from {@link process.cwd()} with the given options (or defaults), returns the new value of {@link process.env} with optional overrides.
* @param [dotenvOptions] An optional {@link DotenvConfigOptions} object to pass to {@link loadDotenv}.
* @param [overrides] If provided, this {@link NodeJS.ProcessEnv} object is merged into the return value, overriding existing properties where overlap occurs.
* @returns A {@link NodeJS.ProcessEnv} object whose properties are variables loaded from the
* process environment, the nearest .env file, and {@link overrides} (if provided). Where
* overlap occurs, the later source takes priority.
*/
export declare function getEnv(dotenvOptions?: DotenvConfigOptions, overrides?: NodeJS.ProcessEnv): NodeJS.ProcessEnv;
/**
* Get the value from the given env var in the current process or nearby .env file.
* If found in process environment, its value is returned.
* Else, try to get it from the nearest .env file.
* If NOT found, return `undefined`
* @param envVar The environment variable to lookup.
* @param [options] Options to pass to {@link get}
* @returns The string value of the environment variable or `undefined`.
* `undefined` may be returned when the variable is undefined or its string is
* empty, whitespace, or appears to have been converted from `null` or
* `undefined`.
*/
export declare function getEnvVarValue(envVar: string, options?: GetOptions): string | undefined;
//# sourceMappingURL=env.d.ts.map