Class DumpDieException

modules/dumper/errors.ts:32–141

* DumpDie exception raised by the "dd" (dump and die) function. * This special exception terminates execution while dumping the provided * value as HTML (during HTTP requests) or ANSI (in console/CLI). * * @example * ```ts * // This will dump the user object and terminate * dumper.dd(user) *

 * ```
 */
class DumpDieException extends Exception {
  static status: number = 500
  static code: string = 'E_DUMP_DIE_EXCEPTION'

  declare fileName: string
  declare lineNumber: number

  #dumper: Dumper
  #traceSourceIndex: number = 1
  value: unknown

  constructor(value: unknown, dumper: Dumper) {
    super('Dump and Die exception')
    this.#dumper = dumper
    this.value = value
  }

  /**
   * Returns the source file and line number location for the error
   */
  #getErrorSource(): { location: string; line: number } | undefined {
    if (this.fileName && this.lineNumber) {
      return {
        location: this.fileName,
        line: this.lineNumber,
      }
    }

    const source = parse(this)[this.#traceSourceIndex]
    if (!source.fileName || !source.lineNumber) {
      return
    }

    return {
      location: source.fileName,
      line: source.lineNumber,
    }
  }

  /**
   * Set the stack trace index for determining the source location.
   * This is useful when building nested helpers on top of dump/die functionality.
   *
   * @param index - Stack trace index (0 = current function, 1 = caller, etc.)
   */
  setTraceSourceIndex(index: number) {
    this.#traceSourceIndex = index
    return this
  }

  /**
   * Preventing itself from getting reported by the
   * AdonisJS exception reporter
   */
  report() {}

  /**
   * HTTP exception handler that renders the dump as HTML output.