modulopt
v2.2.5
Published
Engrafts options support (default values + validity) to objects.
Downloads
17
Maintainers
Readme
Modul °/o pt
Purpose
Any good product delivered on a large scale should provide good quality for the service it gives or the problem it is in charge to solve. To ensure a maximum quality level, services should also cover as many as possible use-cases by providing options in the input.
The downside of designing powerful option management is quite time-consuming. Moreover, there is no clear formalism defined or convention about any option design other than: "An option has to be optional and if not specified in the input, that option has to keep the default value".
The philosophy of this module is to ease the pain of designing option management. In response to "how can I design that?" it answers by saying: "You don't have to, I got you covered".
Go on the Heroku page to be getting started and have all the documentation you need.
Links: GIT REPO | NPM | DOCUMENTATION | MIT LICENSE
Features
- adds an
options
property with your ready to use options. - handle mismatching options (defaults etc.).
- set options on the go easily.
- adds a
modulopt
property withconfig
: generated using modulopt generation.defaults
: with the default values.logs
: for modulopt silent debugging.- ...
- reset modulopt logs
- flexibility
Noticeable changes
- 2.1.0
- modulopt constants
- 4Miss Interactions: whenever an option mismatches a defined name or a proposition is misspelled or even a free option containing a structured object has a mysterious application.
- 2.0.0
- The service is provided by Modulopt Object
- Modulopt config for a generation: mismatch handling, option order while generated.
modulopt
special definition - Logging
- Chimerical cases
- Set Options via multiple inputs (string and object)
- 1.0.0
- Default management
- Use of
.options
to get access to options modulopt
property on the desired object- Masks usage.