Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs for custom argv and config file parsers are lacking #112

Open
cspotcode opened this issue Dec 16, 2018 · 0 comments
Open

Docs for custom argv and config file parsers are lacking #112

cspotcode opened this issue Dec 16, 2018 · 0 comments

Comments

@cspotcode
Copy link

From the readme, it's unclear the role and interface for the third and fourth arguments to rc.

https://github.com/dominictarr/rc#pass-in-your-own-argv

These declarations made it a bit clearer: https://github.com/DefinitelyTyped/DefinitelyTyped/blob/master/types/rc/index.d.ts#L6-L11

Is the third argument expected to be a object dictionary or a function that parses the argv array? The readme suggests it's the latter, so if that's not supported then I think customArgvParser could be renamed.

Is the fourth argument a function that accepts the string contents of a config file and returns an object dictionary?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant