Skip to content

[@types/dotenv-safe] Add a config method #25124

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.

Sign up for GitHub

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

Merged
RyanCavanaugh merged 1 commit into from
Apr 19, 2018
Merged

[@types/dotenv-safe] Add a config method #25124

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 6 additions & 0 deletions types/dotenv-safe/dotenv-safe-tests.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,9 @@ env.load({
path: "/foo/bar/baz.env",
sample: "/foo/bar/qux.env"
})

env.config({
allowEmptyValues: true,
path: "/foo/bar/baz.env",
sample: "/foo/bar/qux.env"
})
29 changes: 21 additions & 8 deletions types/dotenv-safe/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Type definitions for dotenv-safe 4.0
// Type definitions for dotenv-safe 5.0
// Project: https://github.com/rolodato/dotenv-safe
// Definitions by: Stan Goldmann <https://github.com/krenor>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
Expand All @@ -18,12 +18,11 @@ export interface MissingEnvVarsError extends Error {
missing: string[]
}

/**
* Loads environment variables file into 'process.env'.
*
* @throws MissingEnvVarsError
*/
export function load(options?: {
export interface DotenvSafeOptions {
/**
* You can specify a custom path if your file containing environment variables is named or located differently.
* @default '.env'
*/
path?: string,
/**
* Path to example environment file.
Expand All @@ -45,4 +44,18 @@ export function load(options?: {
* @default false
*/
allowEmptyValues?: boolean,
}): env.DotenvResult
}

/**
* Loads environment variables file into 'process.env'.
*
* @throws MissingEnvVarsError
*/
export function load(options?: DotenvSafeOptions): env.DotenvResult

/**
* Loads environment variables file into 'process.env'.
*
* @throws MissingEnvVarsError
*/
export function config(options?: DotenvSafeOptions): env.DotenvResult