From ec8b72f24fc47947136dafbff73f5793ceba2a3a Mon Sep 17 00:00:00 2001 From: Andrew Bradley Date: Sun, 16 Dec 2018 15:11:52 -0500 Subject: [PATCH] Clarify `argv` and `parse` arguments --- types/rc/index.d.ts | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/types/rc/index.d.ts b/types/rc/index.d.ts index 9a2c6783f6..24b763b663 100644 --- a/types/rc/index.d.ts +++ b/types/rc/index.d.ts @@ -6,8 +6,16 @@ declare function rc( name: string, defaults?: any, + /** + * Parsed argv object. For example, if args were '--foo bar' then this value might be {foo: 'bar'} + * If null then rc's default argv parser will parse process.argv + */ argv?: {} | null, + /** + * Custom config file parser. + * Will be passed the string contents of each discovered config file and should return a parsed object dictionary. + */ parse?: ((content: string) => any) | null ): any; -export = rc; \ No newline at end of file +export = rc;