mirror of
https://github.com/zhigang1992/DefinitelyTyped.git
synced 2026-04-20 12:46:36 +08:00
62 lines
1.4 KiB
TypeScript
62 lines
1.4 KiB
TypeScript
// 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
|
|
// TypeScript Version: 2.3
|
|
|
|
import env = require("dotenv")
|
|
|
|
export interface MissingEnvVarsError extends Error {
|
|
/**
|
|
* Path to example environment file.
|
|
*/
|
|
sample: string
|
|
|
|
/**
|
|
* Variables which existing in the sample file, but not in the loaded file.
|
|
*/
|
|
missing: string[]
|
|
}
|
|
|
|
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.
|
|
* @default ".env.example"
|
|
*/
|
|
sample?: string,
|
|
/**
|
|
* Path to environment file.
|
|
* @default ".env"
|
|
*/
|
|
silent?: boolean,
|
|
/**
|
|
* Encoding of your file containing environment variables.
|
|
* @default "utf8"
|
|
*/
|
|
encoding?: string,
|
|
/**
|
|
* Enabling this option will not throw an error after loading.
|
|
* @default false
|
|
*/
|
|
allowEmptyValues?: boolean,
|
|
}
|
|
|
|
/**
|
|
* 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
|