@epigraph/epigraph-std-lib 2.0.1 → 2.1.0

package/dist/EpigraphLogger/epigraph-logger.d.ts

@@ -17,6 +17,32 @@ export declare enum LogTypes {
     Warn = "warn",
     Error = "error"
 }
+export interface ILoggerInfo {
+    title: string;
+    details?: any;
+    contextOverride?: string | undefined;
+}
+export interface ILoggerWarning {
+    title: string;
+    details?: any;
+    contextOverride?: string | undefined;
+}
+export interface ILoggerError {
+    title: string;
+    details?: any;
+    contextOverride?: string | undefined;
+}
+export interface ILoggerTable {
+    title: string;
+    details?: any;
+    contextOverride?: string | undefined;
+    logType?: LogTypes;
+}
+export interface ILoggerGroup {
+    title: string;
+    contextOverride?: string | undefined;
+    logType?: LogTypes;
+}
 /**
  * Epigraph's Logger class that provides various modes and functionalities to easily
  * manage logging within our solutions in a consistent manner.
@@ -53,7 +79,7 @@ declare class EpigraphLogger {
      * paramater to make it easy to debug. If not provided, the default context would be used
      * that was provided at the time of initialisation of this class.
      */
-    info(title?: string, details?: any, contextOverride?: string | undefined): void;
+    info({ title, details, contextOverride }: ILoggerInfo): void;
     /**
      * A warning log type that let's the user know that some action that could be dangerous was just
      * performed and might need attention.
@@ -65,7 +91,7 @@ declare class EpigraphLogger {
      * paramater to make it easy to debug. If not provided, the default context would be used
      * that was provided at the time of initialisation of this class.
      */
-    warn(title?: string, details?: any, contextOverride?: string | undefined): void;
+    warn({ title, details, contextOverride }: ILoggerWarning): void;
     /**
      * A critical error log type that let's the user know that some action that was unexpected and required immediate attention.
      *
@@ -76,7 +102,7 @@ declare class EpigraphLogger {
      * paramater to make it easy to debug. If not provided, the default context would be used
      * that was provided at the time of initialisation of this class.
      */
-    error(title?: string, details?: any, contextOverride?: string | undefined): void;
+    error({ title, details, contextOverride }: ILoggerError): void;
     /**
      * A table log type that can show an object in an organised manner within the console.
      * This is primarily for the visual purposes and doesn't provide any additional functionality
@@ -90,7 +116,7 @@ declare class EpigraphLogger {
      * that was provided at the time of initialisation of this class.
      * @param {LogTypes} logType A
      */
-    table(title?: string, details?: any, contextOverride?: string | undefined, logType?: LogTypes): void;
+    table({ title, details, contextOverride, logType, }: ILoggerTable): void;
     /**
      * Begins an expanded group with the browser's console window.
      * NOTE: Please remember to close this group once done using EpigraphLogger.groupEnd();
@@ -104,7 +130,7 @@ declare class EpigraphLogger {
      * info but this parameter allows the user to override this.
      * @returns {void}
      */
-    group(title: string, contextOverride?: string | undefined, logType?: LogTypes): void;
+    group({ title, contextOverride, logType, }: ILoggerGroup): void;
     /**
      * Begins a collapsed group with the browser's console window.
      * NOTE: Please remember to close this group once done using EpigraphLogger.groupEnd();
@@ -118,7 +144,7 @@ declare class EpigraphLogger {
      * info but this parameter allows the user to override this.
      * @returns {void}
      */
-    groupCollapsed(title: string, contextOverride?: string | undefined, logType?: LogTypes): void;
+    groupCollapsed({ title, contextOverride, logType, }: ILoggerGroup): void;
     /**
      * Similar to the console.groupEnd(). Useful for ending either a group or
      * groupCollapse that was initialised by this logger.

package/dist/epigraph-std-lib.js

@@ -31629,11 +31629,14 @@ class jR {
         "error"
         /* Error */
       ] },
-      staging: { name: "staging", allows: [
-        "warn",
-        "error"
-        /* Error */
-      ] },
+      staging: {
+        name: "staging",
+        allows: [
+          "warn",
+          "error"
+          /* Error */
+        ]
+      },
       dev: {
         name: "dev",
         allows: [
@@ -31675,7 +31678,7 @@ class jR {
    * paramater to make it easy to debug. If not provided, the default context would be used
    * that was provided at the time of initialisation of this class.
    */
-  info(e = "", t = "", n = void 0) {
+  info({ title: e, details: t = "", contextOverride: n = void 0 }) {
     if (!this._isLogTypeAllowedInCurrentMode(
       "info"
       /* Info */
@@ -31695,7 +31698,7 @@ class jR {
    * paramater to make it easy to debug. If not provided, the default context would be used
    * that was provided at the time of initialisation of this class.
    */
-  warn(e = "", t = "", n = void 0) {
+  warn({ title: e, details: t = "", contextOverride: n = void 0 }) {
     if (!this._isLogTypeAllowedInCurrentMode(
       "warn"
       /* Warn */
@@ -31714,7 +31717,7 @@ class jR {
    * paramater to make it easy to debug. If not provided, the default context would be used
    * that was provided at the time of initialisation of this class.
    */
-  error(e = "", t = "", n = void 0) {
+  error({ title: e, details: t = "", contextOverride: n = void 0 }) {
     if (!this._isLogTypeAllowedInCurrentMode(
       "error"
       /* Error */
@@ -31736,7 +31739,13 @@ class jR {
    * that was provided at the time of initialisation of this class.
    * @param {LogTypes} logType A
    */
-  table(e = "", t = {}, n = void 0, i = "info") {
+  table({
+    title: e,
+    details: t = {},
+    contextOverride: n = void 0,
+    logType: i = "info"
+    /* Info */
+  }) {
     if (!this._isLogTypeAllowedInCurrentMode(i))
       return;
     const s = n || this.context;
@@ -31755,7 +31764,12 @@ class jR {
    * info but this parameter allows the user to override this.
    * @returns {void}
    */
-  group(e, t = void 0, n = "info") {
+  group({
+    title: e,
+    contextOverride: t = void 0,
+    logType: n = "info"
+    /* Info */
+  }) {
     if (!this._isLogTypeAllowedInCurrentMode(n))
       return;
     const i = t || this.context;
@@ -31774,7 +31788,12 @@ class jR {
    * info but this parameter allows the user to override this.
    * @returns {void}
    */
-  groupCollapsed(e, t = void 0, n = "info") {
+  groupCollapsed({
+    title: e,
+    contextOverride: t = void 0,
+    logType: n = "info"
+    /* Info */
+  }) {
     if (!this._isLogTypeAllowedInCurrentMode(n))
       return;
     const i = t || this.context;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@epigraph/epigraph-std-lib",
-    "version": "2.0.1",
+    "version": "2.1.0",
     "type": "module",
     "files": [
         "/dist"