brick.ts

@brickkit/cli/dev-reporter

Report a worker process's requests to a running dev dashboard.

llms.txt

@brickkit/cli/dev-reporter exports 2 names: 1 function, 1 interface.

import { installDevReporter } from "@brickkit/cli/dev-reporter";

Functions

FunctionDescription
installDevReporterReport this process's spans to a running dashboard.

installDevReporter

function installDevReporter(options: DevReporterOptions): boolean

Report this process's spans to a running dashboard. Dev servers that evaluate the app in a worker (Vite with Nitro or TanStack Start) cannot share memory with the dashboard, so the worker posts its spans over loopback HTTP. Call before the app is constructed. Reporting is best effort: a dashboard that is not running never affects the app.

Parameters

NameTypeDescription
optionsDevReporterOptions

Returns boolean

Source: packages/cli/src/dev-reporter.ts:15

Interfaces

DevReporterOptions

interface DevReporterOptions

Properties

NameTypeDescription
urlstringThe dashboard's ingest endpoint, for example http://127.0.0.1:9400/api/ingest.

Source: packages/cli/src/dev-reporter.ts:3

On this page

Generated from the JSDoc above each export. Edit the comment there.