Interface DebugController

Readonlyconfig

Readonlyenabled

Readonlyerrors

ReadonlyeventTrace

ReadonlyframeInspector

ReadonlystateTimeline

disable

• disable(): Promise<void>

  Disable debug tracing.

  Returns Promise<void>

enable

• enable(
      config?: Partial<
          Readonly<
              {
                  captureDrawlistBytes?: boolean;
                  captureRawEvents?: boolean;
                  categoryMask?: number;
                  enabled: boolean;
                  minSeverity?: DebugSeverity;
                  ringCapacity?: number;
              },
          >,
      >,
  ): Promise<void>

  Enable debug tracing.

  Parameters

  • Optionalconfig: Partial<
        Readonly<
            {
                captureDrawlistBytes?: boolean;
                captureRawEvents?: boolean;
                categoryMask?: number;
                enabled: boolean;
                minSeverity?: DebugSeverity;
                ringCapacity?: number;
            },
        >,
    >

    Optional configuration overrides

  Returns Promise<void>

export

• export(): Promise<Uint8Array<ArrayBufferLike>>

  Export all debug records to a buffer for offline analysis.

  Returns Promise<Uint8Array<ArrayBufferLike>>

getPayload

• getPayload<T extends DebugPayload>(recordId: bigint): Promise<T | null>

  Get the payload for a specific record.

  Type Parameters

  • T extends DebugPayload

  Parameters

  • recordId: bigint

    The record ID

  Returns Promise<T | null>

getStats

• getStats(): Promise<
      Readonly<
          {
              currentRingUsage: number;
              errorCount: number;
              ringCapacity: number;
              totalDropped: bigint;
              totalRecords: bigint;
              warnCount: number;
          },
      >,
  >

  Get debug statistics.

  Returns Promise<
      Readonly<
          {
              currentRingUsage: number;
              errorCount: number;
              ringCapacity: number;
              totalDropped: bigint;
              totalRecords: bigint;
              warnCount: number;
          },
      >,
  >

on

• on(event: "record", handler: DebugRecordHandler): () => void

  Subscribe to debug events.

  Parameters

  • event: "record"

    Event type: 'record' or 'error'

  • handler: DebugRecordHandler

    Event handler

  Returns () => void

  Unsubscribe function

• on(event: "error", handler: DebugErrorHandler): () => void

  Parameters

  • event: "error"
  • handler: DebugErrorHandler

  Returns () => void

processRecords

• processRecords(
      headers: Uint8Array,
      payloads: Map<bigint, Uint8Array<ArrayBufferLike>>,
  ): void

  Process a batch of debug record headers and payloads. Called internally by the app runtime.

  Parameters

  • headers: Uint8Array
  • payloads: Map<bigint, Uint8Array<ArrayBufferLike>>

  Returns void

query

• query(
      filter?: Readonly<
          {
              categoryMask?: number;
              maxFrameId?: bigint;
              maxRecordId?: bigint;
              maxRecords?: number;
              minFrameId?: bigint;
              minRecordId?: bigint;
              minSeverity?: DebugSeverity;
          },
      >,
  ): Promise<
      readonly Readonly<
          { header: DebugRecordHeader; payload: DebugPayload
          | null },
      >[],
  >

  Query debug records from the engine.

  Parameters

  • Optionalfilter: Readonly<
        {
            categoryMask?: number;
            maxFrameId?: bigint;
            maxRecordId?: bigint;
            maxRecords?: number;
            minFrameId?: bigint;
            minRecordId?: bigint;
            minSeverity?: DebugSeverity;
        },
    >

    Optional query filter

  Returns Promise<
      readonly Readonly<
          { header: DebugRecordHeader; payload: DebugPayload
          | null },
      >[],
  >

reset

• reset(): Promise<void>

  Reset (clear) all debug records while keeping tracing enabled.

  Returns Promise<void>