Skip to content
This repository was archived by the owner on Apr 13, 2025. It is now read-only.

Conversation

ExtremTechniker
Copy link
Contributor

because in nodecg project the js-doc is not consistent but used down in a function and typescript complains about it

because in nodecg project the js-doc is not consistent but used down in a function and typescript complains about it
@ExtremTechniker
Copy link
Contributor Author

/**
 * A factory that configures and returns a Logger constructor.
 * @param [initialOpts] {Object} - Configuration for the logger.
 *
 * @param [initialOpts.console] {Object} - Configuration for the console logging.
 * @param [initialOpts.console.enabled=false] {Boolean} - Whether to enable console logging.
 * @param [initialOpts.console.timestamps=false] {Boolean} - Whether to add timestamps to the console logging.
 * @param [initialOpts.console.level="info"] {ENUM_LEVELS} - The level of logging to output to the console.
 *
 * @param [initialOpts.file] {Object} - Configuration for file logging.
 * @param initialOpts.file.path {String} - Where the log file should be saved.
 * @param [initialOpts.file.enabled=false] {Boolean} - Whether to enable file logging.
 * @param [initialOpts.file.timestamps=true] {Boolean} - Whether to add timestamps to the file logging.
 * @param [initialOpts.file.level="info"] {ENUM_LEVELS} - The level of logging to output to file.
 *
 * @param [initialOpts.replicants=false] {Boolean} - Whether to enable logging specifically for the Replicants system.
 *
 * @param [Raven] {Object} - A pre-configured server-side Raven npm package instance, for reporting errors to Sentry.io
 *
 * @returns {function} - A constructor used to create discrete logger instances.
 */

Here is the js-doc out of nodecg v.1.8.1 in the row with initialOpts.file.path, there the squared brackets was forgotten so it need to be fixed in the typescript definition as well

@hlxid hlxid self-requested a review October 28, 2021 12:43
Copy link
Member

@hlxid hlxid left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks. You should propably also fix this upstream in the official NodeCG repository

@hlxid hlxid merged commit 9e35302 into codeoverflow-org:main Oct 28, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants