Skip to content

Commit 47e1425

Browse files
committed
add type information for quiet arg
1 parent 057bdb8 commit 47e1425

File tree

1 file changed

+12
-3
lines changed

1 file changed

+12
-3
lines changed

lib/main.d.ts

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,15 @@ export interface DotenvConfigOptions {
3939
*/
4040
encoding?: string;
4141

42+
/**
43+
* Default: `false`
44+
*
45+
* Suppress all output (except errors).
46+
*
47+
* example: `require('dotenv').config({ quiet: true })`
48+
*/
49+
quiet?: boolean;
50+
4251
/**
4352
* Default: `false`
4453
*
@@ -110,7 +119,7 @@ export interface DotenvPopulateInput {
110119
*
111120
* See https://dotenvx.com/docs
112121
*
113-
* @param options - additional options. example: `{ path: './custom/path', encoding: 'latin1', debug: true, override: false }`
122+
* @param options - additional options. example: `{ path: './custom/path', encoding: 'latin1', quiet: false, debug: true, override: false }`
114123
* @returns an object with a `parsed` key if successful or `error` key if an error occurred. example: { parsed: { KEY: 'value' } }
115124
*
116125
*/
@@ -121,7 +130,7 @@ export function config(options?: DotenvConfigOptions): DotenvConfigOutput;
121130
*
122131
* See https://dotenvx.com/docs
123132
*
124-
* @param options - additional options. example: `{ path: './custom/path', encoding: 'latin1', debug: true, override: false }`
133+
* @param options - additional options. example: `{ path: './custom/path', encoding: 'latin1', quiet: false, debug: true, override: false }`
125134
* @returns an object with a `parsed` key if successful or `error` key if an error occurred. example: { parsed: { KEY: 'value' } }
126135
*
127136
*/
@@ -134,7 +143,7 @@ export function configDotenv(options?: DotenvConfigOptions): DotenvConfigOutput;
134143
*
135144
* @param processEnv - the target JSON object. in most cases use process.env but you can also pass your own JSON object
136145
* @param parsed - the source JSON object
137-
* @param options - additional options. example: `{ debug: true, override: false }`
146+
* @param options - additional options. example: `{ quiet: false, debug: true, override: false }`
138147
* @returns {void}
139148
*
140149
*/

0 commit comments

Comments
 (0)