Skip to content

Documentation clarification requests #288

Description

@ronkorving

Hi there,

I really love convict, and find myself a little confused about a few matters when I read the documentation. I've written down my questions, and I'm not seeking answers here in this GitHub issue (although of course that would not be a problem). Rather, I'm hoping that documentation can be clarified permanently.

  1. When using config.set(), do validation rules get applied?
  2. Can multiple values be set by a single CLI argument, if they share the same arg-name or do arg-names have to be unique?
  3. Can multiple values be set by a single env-var if they share the same env-name or do env-names have to be unique?
  4. Do arg, environment variables and defaults all get passed through the format function?
  5. Do arg, environment variables and defaults all get passed through the coerce function?
  6. The doc on config.getArgs() and config.getEnv() mention an options-argument to the convict function, but this is not reflected in the var config = convict(schema)-part of the readme.

Thank you!

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Fields

    Priority

    None yet

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions