@darksheep/logger 1.0.6 → 1.0.8

package/types/replacers/error.d.ts

@@ -1,8 +1,8 @@
 /**
  * @typedef {Object} BaseError
- * @property {string} type The error type or name
- * @property {string} message The error message
- * @property {import('../utilities/stacktrace.js').Callsite[]} stack The stacktrace of the error
+ * @property {string} type - The error type or name.
+ * @property {string} message - The error message.
+ * @property {import('../utilities/stacktrace.js').Callsite[]} stack - The stacktrace of the error.
  */
 /**
  * @typedef {BaseError & { [k: string]: unknown }} NormalisedError
@@ -11,15 +11,15 @@
 export const ErrorReplacer: import("../replacer.js").Replacer<Error, NormalisedError>;
 export type BaseError = {
     /**
-     * The error type or name
+     * - The error type or name.
      */
     type: string;
     /**
-     * The error message
+     * - The error message.
      */
     message: string;
     /**
-     * The stacktrace of the error
+     * - The stacktrace of the error.
      */
     stack: import("../utilities/stacktrace.js").Callsite[];
 };

package/types/stdout-write.d.ts

@@ -1,5 +1,5 @@
 /**
- * @param {string} output What should be written to stdout
+ * @param {string} output - What should be written to stdout.
  * @returns {void}
  */
 export function stdoutWrite(output: string): void;

package/types/utilities/colour.d.ts

@@ -1,12 +1,12 @@
 /**
- * Should colours be used in the output
+ * Should colours be used in the output.
  * @returns {boolean}
  */
 export function shouldColour(): boolean;
 /**
- * Colour a string
- * @param {string} string The string to colour
- * @param {ColourOptions} options The options to use to colour the string
+ * Colour a string.
+ * @param {string} string - The string to colour.
+ * @param {ColourOptions} options - The options to use to colour the string.
  * @returns {string}
  */
 export function colourString(string: string, options: ColourOptions): string;
@@ -15,29 +15,29 @@ export type ColourMode = "bright" | "dim";
 export type ColourEffects = keyof typeof effects;
 export type ColourOptions = {
     /**
-     * The foreground colour name
+     * - The foreground colour name.
      */
-    foreground?: "black" | "red" | "green" | "yellow" | "blue" | "magenta" | "cyan" | "white" | undefined;
+    foreground?: ColourNames;
     /**
-     * The foreground colour mode
+     * - The foreground colour mode.
      */
-    foregroundMode?: ColourMode | undefined;
+    foregroundMode?: ColourMode;
     /**
-     * The background colour name
+     * - The background colour name.
      */
-    background?: "black" | "red" | "green" | "yellow" | "blue" | "magenta" | "cyan" | "white" | undefined;
+    background?: ColourNames;
     /**
-     * The background colour mode
+     * - The background colour mode.
      */
-    backgroundMode?: ColourMode | undefined;
+    backgroundMode?: ColourMode;
     /**
-     * The string effents
+     * - The string effents.
      */
-    effects?: ("bold" | "faint" | "italic" | "underline")[] | undefined;
+    effects?: ColourEffects[];
     /**
-     * How to handle the string termination
+     * - How to handle the string termination.
      */
-    reset?: boolean | Omit<ColourOptions, "reset"> | undefined;
+    reset?: boolean | Omit<ColourOptions, "reset">;
 };
 declare const colours: Readonly<{
     black: "0";

package/types/utilities/json-path.d.ts

@@ -1,5 +1,5 @@
 /**
- * @param {string[]} nodes The nodes to the element
+ * @param {string[]} nodes - The nodes to the element.
  * @returns {string}
  */
 export function nodesToPath(nodes: string[]): string;

package/types/utilities/last-callsite.d.ts

@@ -1,5 +1,5 @@
 /**
- * Get the callsite that we think is outside the package
+ * Get the callsite that we think is outside the package.
  * @returns {{ file: string, line: number, column: number } | void}
  */
 export function getLastCallsite(): {

package/types/utilities/log-filters.d.ts

@@ -1,12 +1,12 @@
 /**
- * Check to see if {loggerLevel} should get logged
- * @param {import('./log-types.js').LogLevel} level The log level to check
+ * Check to see if {loggerLevel} should get logged.
+ * @param {import('./log-types.js').LogLevel} level - The log level to check.
  * @returns {boolean}
  */
 export function checkLogLevel(level: import("./log-types.js").LogLevel): boolean;
 /**
- * Check to see if a message with {channel} should get logged
- * @param {string} [channel] The channel to check
+ * Check to see if a message with {channel} should get logged.
+ * @param {string} [channel] - The channel to check.
  * @returns {boolean}
  */
 export function checkLogFilters(channel?: string | undefined): boolean;

package/types/utilities/log-types.d.ts

@@ -1,42 +1,42 @@
 export type LogLevels = {
     /**
-     * A crucial part of the application is not working
+     * - A crucial part of the application is not working.
      */
     critical: 0;
     /**
-     * A non critical operation fails
+     * - A non critical operation fails.
      */
     error: 1;
     /**
-     * An operation might fail in the future
+     * - An operation might fail in the future.
      */
     warning: 2;
     /**
-     * Information about events that may be unusual
+     * - Information about events that may be unusual.
      */
     notice: 3;
     /**
-     * Information about successful operations
+     * - Information about successful operations.
      */
     info: 4;
     /**
-     * Information that is unlikely to help in production
+     * - Information that is unlikely to help in production.
      */
     debug: 5;
     /**
-     * Information to help resolve complex logic issues
+     * - Information to help resolve complex logic issues.
      */
     silly: 6;
 };
 /**
  * @typedef {Object} LogLevels
- * @property {0} critical A crucial part of the application is not working
- * @property {1} error A non critical operation fails
- * @property {2} warning An operation might fail in the future
- * @property {3} notice Information about events that may be unusual
- * @property {4} info Information about successful operations
- * @property {5} debug Information that is unlikely to help in production
- * @property {6} silly Information to help resolve complex logic issues
+ * @property {0} critical - A crucial part of the application is not working.
+ * @property {1} error - A non critical operation fails.
+ * @property {2} warning - An operation might fail in the future.
+ * @property {3} notice - Information about events that may be unusual.
+ * @property {4} info - Information about successful operations.
+ * @property {5} debug - Information that is unlikely to help in production.
+ * @property {6} silly - Information to help resolve complex logic issues.
  */
 /** @type {LogLevels} */
 export const LogLevels: LogLevels;
@@ -49,33 +49,33 @@ export type Callsite = import("./stacktrace.js").Callsite;
 export type NormalisedError = import("../replacers/error.js").NormalisedError;
 export type LogInternal = {
     /**
-     * A timestamp for the log message
+     * - A timestamp for the log message.
      */
-    timestamp?: Date | undefined;
+    timestamp?: Date;
     /**
-     * A channel to bind to the log
+     * - A channel to bind to the log.
      */
-    channel?: string | undefined;
+    channel?: string;
     /**
-     * The log level
+     * - The log level.
      */
-    level?: LogLevel | undefined;
+    level?: LogLevel;
     /**
-     * A message to use
+     * - A message to use.
      */
-    message?: string | undefined;
+    message?: string;
     /**
-     * The stack trace bound to the log
+     * - The stack trace bound to the log.
      */
-    stack?: string | import("./stacktrace.js").Callsite[] | undefined;
+    stack?: string | Callsite[];
     /**
-     * A child error for the core error
+     * - A child error for the core error.
      */
-    cause?: Error | import("../replacers/error.js").NormalisedError | undefined;
+    cause?: NormalisedError | Error;
     /**
-     * The trail id bound to the callsite
+     * - The trail id bound to the callsite.
      */
-    trail?: string | undefined;
+    trail?: string;
 };
 export type LogContext = LogInternal & Record<string, unknown>;
 export type LogEntry = {

package/types/utilities/parse-filters.d.ts

@@ -1,6 +1,6 @@
 /**
- * @param {string} [filter] The filter string
- * @param {RegExp[]} [fallback] Fallback to the following allowed regexp
+ * @param {string} [filter] - The filter string.
+ * @param {RegExp[]} [fallback] - Fallback to the following allowed regexp.
  * @returns {{ allowed: RegExp[], blocked: RegExp[] }}
  */
 export function parseFilters(filter?: string | undefined, fallback?: RegExp[] | undefined): {

package/types/utilities/parse-log-level.d.ts

@@ -1,7 +1,7 @@
 /**
- * Convert a given string to a LogLevel
- * @param {string} [input] The string to convert
- * @param {string} [node] The current NODE_ENV
+ * Convert a given string to a LogLevel.
+ * @param {string} [input] - The string to convert.
+ * @param {string} [node] - The current NODE_ENV.
  * @returns {import('./log-types.js').LogLevel}
  */
 export function parseLogLevel(input?: string | undefined, node?: string | undefined): import("./log-types.js").LogLevel;

package/types/utilities/stacktrace.d.ts

@@ -1,41 +1,41 @@
 /**
  * @typedef {Object} Callsite
- * @property {string} file The file name for the callsite
- * @property {string} [relativePath] The relative path for the callsite.file
- * @property {string} [absolutePath] The absolute path for the callsite.file
- * @property {string} methodName The methodName from the callsite
- * @property {number} line The line number in the file
- * @property {number} column The column number in the file
+ * @property {string} file - The file name for the callsite.
+ * @property {string} [relativePath] - The relative path for the callsite.file.
+ * @property {string} [absolutePath] - The absolute path for the callsite.file.
+ * @property {string} methodName - The methodName from the callsite.
+ * @property {number} line - The line number in the file.
+ * @property {number} column - The column number in the file.
  */
 /**
- * Get the callsite that we think is outside the package
- * @param {string} [stack] The stacktrace to parse
+ * Get the callsite that we think is outside the package.
+ * @param {string} [stack] - The stacktrace to parse.
  * @returns {Callsite[]}
  */
 export function parseStack(stack?: string | undefined): Callsite[];
 export type Callsite = {
     /**
-     * The file name for the callsite
+     * - The file name for the callsite.
      */
     file: string;
     /**
-     * The relative path for the callsite.file
+     * - The relative path for the callsite.file.
      */
-    relativePath?: string | undefined;
+    relativePath?: string;
     /**
-     * The absolute path for the callsite.file
+     * - The absolute path for the callsite.file.
      */
-    absolutePath?: string | undefined;
+    absolutePath?: string;
     /**
-     * The methodName from the callsite
+     * - The methodName from the callsite.
      */
     methodName: string;
     /**
-     * The line number in the file
+     * - The line number in the file.
      */
     line: number;
     /**
-     * The column number in the file
+     * - The column number in the file.
      */
     column: number;
 };

package/types/logger.test.d.ts

@@ -1 +0,0 @@
-export {};

package/types/replacer.test.d.ts

@@ -1 +0,0 @@
-export {};

package/types/replacers/buffers.test.d.ts

@@ -1 +0,0 @@
-export {};

package/types/replacers/error.test.d.ts

@@ -1 +0,0 @@
-export {};

package/types/replacers/http-client-request.test.d.ts

@@ -1 +0,0 @@
-export {};