I would like to know more about how to set up the configuration of a designed package. I browsed through some of the provided documentation in the flight-manual and API description.
What I have found…
Looking at LINK1:
Config settings each have a type specified by way of a schema. For example we might an integer setting that only allows integers greater than 0:
My observation -> The link under
schema does not link anywhere.
Later LINK1 mentions:
Defining settings for your package
Define a schema under a config key in your package main.
module.exports = # Your config schema config: someInt: type: 'integer' default: 23 minimum: 1 activate: (state) -> # ... # ...
See package docs for more info.
My observation -> The link to
package docs does not seem to add more information.
My follow-up questions:
Is LINK1 the only information there is when it comes to making a package user configurable?
The example above of “under a
configkey”, is this an entry in the file mentioned under the “entry point of your package” per
Can the description for
configkey refer to an external file or does it have to be in the main JS / COFFEE script file? There is mention of a
json schemain LINK1
Your attention is appreciated.