You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
60 lines
1.6 KiB
TypeScript
60 lines
1.6 KiB
TypeScript
// TypeScript Version: 3.0
|
|
/// <reference types="node" />
|
|
|
|
export interface DotenvParseOptions {
|
|
/**
|
|
* You may turn on logging to help debug why certain keys or values are not being set as you expect.
|
|
*/
|
|
debug?: boolean;
|
|
}
|
|
|
|
export interface DotenvParseOutput {
|
|
[name: string]: string;
|
|
}
|
|
|
|
/**
|
|
* Parses a string or buffer in the .env file format into an object.
|
|
*
|
|
* @param src - contents to be parsed
|
|
* @param options - additional options
|
|
* @returns an object with keys and values based on `src`
|
|
*/
|
|
export function parse(
|
|
src: string | Buffer,
|
|
options?: DotenvParseOptions
|
|
): DotenvParseOutput;
|
|
|
|
export interface DotenvConfigOptions {
|
|
/**
|
|
* You may specify a custom path if your file containing environment variables is located elsewhere.
|
|
*/
|
|
path?: string;
|
|
|
|
/**
|
|
* You may specify the encoding of your file containing environment variables.
|
|
*/
|
|
encoding?: string;
|
|
|
|
/**
|
|
* You may turn on logging to help debug why certain keys or values are not being set as you expect.
|
|
*/
|
|
debug?: boolean;
|
|
}
|
|
|
|
export interface DotenvConfigOutput {
|
|
error?: Error;
|
|
parsed?: DotenvParseOutput;
|
|
}
|
|
|
|
/**
|
|
* Loads `.env` file contents into {@link https://nodejs.org/api/process.html#process_process_env | `process.env`}.
|
|
* Example: 'KEY=value' becomes { parsed: { KEY: 'value' } }
|
|
*
|
|
* @param options - controls behavior
|
|
* @returns an object with a `parsed` key if successful or `error` key if an error occurred
|
|
*
|
|
*/
|
|
export function config(options?: DotenvConfigOptions): DotenvConfigOutput;
|
|
/** @deprecated since v7.0.0 Use config instead. */
|
|
export const load: typeof config;
|