addDebugReporter @vuqs/core

Attaches a consumer to the global debug stream or one adapter channel.

Usage

import { addDebugReporter } from '@vuqs/core'

const stop = addDebugReporter(event => console.log(event.code))
stop()

Type

function addDebugReporter(reporter: Reporter, options?: AddReporterOptions): () => void

Parameters

reporter: Reporter and optional AddReporterOptions. channel restricts observation to one adapter; replay: true delivers retained history before live events.

Return value

A disposer that detaches this reporter. Live events contain read-only raw references; replayed history is normalized and deeply frozen. Reporter failures are isolated.

Reporter

type Reporter = (event: DebugEvent) => void

ChannelReporterOptions

interface ChannelReporterOptions {
  replay?: boolean
}

AddReporterOptions

interface AddReporterOptions extends ChannelReporterOptions {
  channel?: DebugChannelHandle
}

Related guide

Debugging.

ChannelReporterOptions and ChannelHistoryOptions are supporting channel option interfaces, not exports from @vuqs/core.