docs: Add comprehensive JSDoc documentation to Logger class #8
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Changes
This PR adds comprehensive JSDoc documentation to the Logger class and all related functions in
src/helpers/logger.ts.What was added:
formatMessage: Documents message formatting logicshouldLog: Documents log level checking logicdebug: With usage exampleinfo: With usage examplewarn: With usage exampleerror: With usage example and Error parameter documentationsetLevel: With usage examplegetLevel: With return type documentationcreateLogger: Factory function with usage exampleparseLogLevel: String parser with examplesformatError: Error formatter with try/catch exampleAll documentation includes:
This agent session was co-authored by bekah-hawrot-weigel and Continue.