readStoredConsoleDebugConfig @vuqs/core/debug/console

Reads and validates the versioned browser console configuration.

Usage

import { readStoredConsoleDebugConfig } from '@vuqs/core/debug/console'

const resolution = readStoredConsoleDebugConfig()
resolution.status

Type

function readStoredConsoleDebugConfig(): StoredConsoleDebugResolution

Return value

A StoredConsoleDebugResolution. Missing configuration is absent; malformed or unsupported configuration fails closed. This read does not attach a reporter.

StoredConsoleDebugResolution

type StoredConsoleDebugResolution
  = { readonly status: 'absent' | 'unavailable' | 'disabled' }
    | { readonly status: 'enabled', readonly options: StoredConsoleReporterOptions }
    | { readonly status: 'invalid', readonly message: string }

StoredConsoleDebugConfig

interface StoredConsoleDebugConfig extends StoredConsoleReporterOptions {
  enabled: boolean
}

StoredDebugConfigV1

interface StoredDebugConfigV1 {
  version: typeof VUQS_DEBUG_CONFIG_VERSION
  console?: StoredConsoleDebugConfig
}

StoredConsoleReporterOptions

interface StoredConsoleReporterOptions {
  preset?: ConsoleDebugPreset
  payload?: StoredDebugPayloadMode
  filter?: StoredDebugEventFilter
}

StoredDebugEventFilter

interface StoredDebugEventFilter {
  include?: StoredDebugEventSelector
  exclude?: StoredDebugEventSelector
}

StoredDebugEventSelector

interface StoredDebugEventSelector {
  levels?: readonly DebugLevel[]
  scopes?: readonly DebugScope[]
  codes?: readonly DebugEventCode[]
}

StoredDebugPayloadMode

type StoredDebugPayloadMode = 'preview' | 'hidden'

Related guide

Debugging.