Clarify argv and parse arguments

This commit is contained in:
Andrew Bradley
2018-12-16 15:11:52 -05:00
committed by GitHub
parent 6a5e2cc314
commit ec8b72f24f
+9 -1
View File
@@ -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;
export = rc;