Skip to content

📝 Add docstrings to dev #17

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
warengonzaga merged 1 commit into from
Jun 27, 2025
Merged

📝 Add docstrings to dev #17

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 12 additions & 1 deletion src/logger/advanced-outputs.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -266,7 +266,18 @@ export class HttpOutputHandler {
}

/**
* Factory function to create built-in output handlers
* Returns a logging handler function based on the specified type and configuration.
*
* Supported types are:
* - `'console'`: Logs to the console using the appropriate method for the log level.
* - `'silent'`: Returns a no-op handler that discards all logs.
* - `'file'`: Writes logs to a file with optional rotation; requires `filePath` in config.
* - `'http'`: Sends logs to a remote HTTP endpoint; requires `url` in config.
*
* If required configuration is missing or initialization fails, logs an error and returns either a fallback handler or `null`.
*
* @param type - The type of output handler to create (`'console'`, `'silent'`, `'file'`, or `'http'`)
* @returns A log handler function or `null` if the handler cannot be created
*/
export function createBuiltInHandler(type: string, config?: any): ((level: string, message: string, data?: unknown) => void) | null {
switch (type) {
Expand Down