Create index.d.ts
This commit is contained in:
parent
397a127d04
commit
dd2f1d0ced
1 changed files with 59 additions and 0 deletions
59
node_modules/dotenv/types/index.d.ts
generated
vendored
Normal file
59
node_modules/dotenv/types/index.d.ts
generated
vendored
Normal file
|
@ -0,0 +1,59 @@
|
||||||
|
// 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<T extends DotenvParseOutput = DotenvParseOutput>(
|
||||||
|
src: string | Buffer,
|
||||||
|
options?: DotenvParseOptions
|
||||||
|
): T;
|
||||||
|
|
||||||
|
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;
|
Loading…
Reference in a new issue