@arkyn/server 3.0.1-beta.34 → 3.0.1-beta.35

package/dist/services/httpDebug.d.ts

@@ -1,5 +1,40 @@
+/**
+ * Service for managing HTTP debug configuration and behavior.
+ *
+ * This service provides functionality to configure how the `getCaller` function
+ * identifies the actual caller in the stack trace by allowing specific files
+ * to be ignored during stack trace analysis.
+ *
+ * @example
+ * ```typescript
+ * // Configure to ignore httpAdapter.ts in stack traces
+ * HttpDebugService.setIgnoreFile("httpAdapter.ts");
+ *
+ * // Now when httpDebug is called from within httpAdapter.ts,
+ * // it will show the actual caller (e.g., cart.ts) instead
+ * ```
+ */
 declare class HttpDebugService {
+    /**
+     * The name of the file to ignore when analyzing the stack trace.
+     * When set, the `getCaller` function will skip stack frames containing this file name.
+     */
     static ignoreFile?: string;
+    /**
+     * Sets the file name to be ignored during stack trace analysis.
+     *
+     * This method configures the debug service to skip specific files when
+     * determining the actual caller of a function. This is useful when you have
+     * adapter or wrapper functions that you want to be transparent in the debug output.
+     *
+     * @param file - The name of the file to ignore in stack traces (e.g., "httpAdapter.ts")
+     *
+     * @example
+     * ```typescript
+     * // Ignore the HTTP adapter file so debug shows the actual business logic caller
+     * HttpDebugService.setIgnoreFile("httpAdapter.ts");
+     * ```
+     */
     static setIgnoreFile(file: string): void;
 }
 /**

package/dist/services/httpDebug.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"httpDebug.d.ts","sourceRoot":"","sources":["../../src/services/httpDebug.ts"],"names":[],"mappings":"AAEA,cAAM,gBAAgB;IACpB,MAAM,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;IAE3B,MAAM,CAAC,aAAa,CAAC,IAAI,EAAE,MAAM;CAGlC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AAEH,iBAAS,SAAS,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,EAAE,KAAK,CAAC,EAAE,GAAG,QAuBtD;AAED,OAAO,EAAE,SAAS,EAAE,gBAAgB,EAAE,CAAC"}
+{"version":3,"file":"httpDebug.d.ts","sourceRoot":"","sources":["../../src/services/httpDebug.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;;;;;GAeG;AACH,cAAM,gBAAgB;IACpB;;;OAGG;IACH,MAAM,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;IAE3B;;;;;;;;;;;;;;OAcG;IACH,MAAM,CAAC,aAAa,CAAC,IAAI,EAAE,MAAM;CAGlC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AAEH,iBAAS,SAAS,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,EAAE,KAAK,CAAC,EAAE,GAAG,QAuBtD;AAED,OAAO,EAAE,SAAS,EAAE,gBAAgB,EAAE,CAAC"}

package/dist/services/httpDebug.js

@@ -1,6 +1,41 @@
 import { getCaller } from "../services/getCaller";
+/**
+ * Service for managing HTTP debug configuration and behavior.
+ *
+ * This service provides functionality to configure how the `getCaller` function
+ * identifies the actual caller in the stack trace by allowing specific files
+ * to be ignored during stack trace analysis.
+ *
+ * @example
+ * ```typescript
+ * // Configure to ignore httpAdapter.ts in stack traces
+ * HttpDebugService.setIgnoreFile("httpAdapter.ts");
+ *
+ * // Now when httpDebug is called from within httpAdapter.ts,
+ * // it will show the actual caller (e.g., cart.ts) instead
+ * ```
+ */
 class HttpDebugService {
+    /**
+     * The name of the file to ignore when analyzing the stack trace.
+     * When set, the `getCaller` function will skip stack frames containing this file name.
+     */
     static ignoreFile;
+    /**
+     * Sets the file name to be ignored during stack trace analysis.
+     *
+     * This method configures the debug service to skip specific files when
+     * determining the actual caller of a function. This is useful when you have
+     * adapter or wrapper functions that you want to be transparent in the debug output.
+     *
+     * @param file - The name of the file to ignore in stack traces (e.g., "httpAdapter.ts")
+     *
+     * @example
+     * ```typescript
+     * // Ignore the HTTP adapter file so debug shows the actual business logic caller
+     * HttpDebugService.setIgnoreFile("httpAdapter.ts");
+     * ```
+     */
     static setIgnoreFile(file) {
         this.ignoreFile = file;
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arkyn/server",
-  "version": "3.0.1-beta.34",
+  "version": "3.0.1-beta.35",
   "author": "Arkyn | Lucas Gonçalves",
   "main": "./dist/index.js",
   "module": "./src/index.ts",

package/src/services/httpDebug.ts

@@ -1,8 +1,43 @@
 import { getCaller } from "../services/getCaller";
 
+/**
+ * Service for managing HTTP debug configuration and behavior.
+ *
+ * This service provides functionality to configure how the `getCaller` function
+ * identifies the actual caller in the stack trace by allowing specific files
+ * to be ignored during stack trace analysis.
+ *
+ * @example
+ * ```typescript
+ * // Configure to ignore httpAdapter.ts in stack traces
+ * HttpDebugService.setIgnoreFile("httpAdapter.ts");
+ *
+ * // Now when httpDebug is called from within httpAdapter.ts,
+ * // it will show the actual caller (e.g., cart.ts) instead
+ * ```
+ */
 class HttpDebugService {
+  /**
+   * The name of the file to ignore when analyzing the stack trace.
+   * When set, the `getCaller` function will skip stack frames containing this file name.
+   */
   static ignoreFile?: string;
 
+  /**
+   * Sets the file name to be ignored during stack trace analysis.
+   *
+   * This method configures the debug service to skip specific files when
+   * determining the actual caller of a function. This is useful when you have
+   * adapter or wrapper functions that you want to be transparent in the debug output.
+   *
+   * @param file - The name of the file to ignore in stack traces (e.g., "httpAdapter.ts")
+   *
+   * @example
+   * ```typescript
+   * // Ignore the HTTP adapter file so debug shows the actual business logic caller
+   * HttpDebugService.setIgnoreFile("httpAdapter.ts");
+   * ```
+   */
   static setIgnoreFile(file: string) {
     this.ignoreFile = file;
   }