Devtools
Defined in: packages/devtools/src/types.ts:69
Framework-independent collector and capture interface.
Properties
Section titled “Properties”capture
Section titled “capture”
readonlycapture:DiagnosticCapture
Defined in: packages/devtools/src/types.ts:73
Explicit bounded content capture.
options
Section titled “options”
readonlyoptions:DevtoolsOptions
Defined in: packages/devtools/src/types.ts:71
Configuration used by the shared panel.
Methods
Section titled “Methods”attach()
Section titled “attach()”attach(
orchestrator): () =>void
Defined in: packages/devtools/src/types.ts:83
Attaches before connect; cleanup retains bounded history after detachment.
Parameters
Section titled “Parameters”orchestrator
Section titled “orchestrator”Orchestrator
Returns
Section titled “Returns”() => void
clear()
Section titled “clear()”clear():
void
Defined in: packages/devtools/src/types.ts:79
Clears capture, imported evidence, activity, and detached lifetimes. Active clients remain attached.
Returns
Section titled “Returns”void
closeImport()
Section titled “closeImport()”closeImport():
void
Defined in: packages/devtools/src/types.ts:93
Removes imported evidence from the panel.
Returns
Section titled “Returns”void
dispose()
Section titled “dispose()”dispose():
void
Defined in: packages/devtools/src/types.ts:99
Releases subscriptions and evidence.
Returns
Section titled “Returns”void
exportCapture()
Section titled “exportCapture()”exportCapture():
string
Defined in: packages/devtools/src/types.ts:89
Exports a versioned JSON capture without executing any work.
Returns
Section titled “Returns”string
getSnapshot()
Section titled “getSnapshot()”getSnapshot():
DevtoolsSnapshot
Defined in: packages/devtools/src/types.ts:75
Returns a stable snapshot until the store changes.
Returns
Section titled “Returns”importCapture()
Section titled “importCapture()”importCapture(
json):void
Defined in: packages/devtools/src/types.ts:91
Validates and opens a bounded capture for read-only inspection. Throws on invalid files.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”void
inspect()
Section titled “inspect()”inspect(
clientId):unknown
Defined in: packages/devtools/src/types.ts:77
Reads full live definitions only on explicit inspection; retained clients expose structural evidence.
Parameters
Section titled “Parameters”clientId
Section titled “clientId”string
Returns
Section titled “Returns”unknown
setHighlightedInstance()?
Section titled “setHighlightedInstance()?”
optionalsetHighlightedInstance(clientId?,instanceId?):void
Defined in: packages/devtools/src/types.ts:97
Highlights a rendered Instance on its owning active client without changing layout. Omit either identity to clear selection.
Parameters
Section titled “Parameters”clientId?
Section titled “clientId?”string
instanceId?
Section titled “instanceId?”string
Returns
Section titled “Returns”void
setOverlays()
Section titled “setOverlays()”setOverlays(
enabled):void
Defined in: packages/devtools/src/types.ts:95
Enables visual Chart outlines without changing its layout.
Parameters
Section titled “Parameters”enabled
Section titled “enabled”boolean
Returns
Section titled “Returns”void
startCapture()
Section titled “startCapture()”startCapture(
clientId?):void
Defined in: packages/devtools/src/types.ts:85
Starts content capture for all Providers, or one active lifetime. A stale lifetime throws without clearing evidence.
Parameters
Section titled “Parameters”clientId?
Section titled “clientId?”string
Returns
Section titled “Returns”void
stopCapture()
Section titled “stopCapture()”stopCapture():
void
Defined in: packages/devtools/src/types.ts:87
Stops content capture and unsubscribes server content forwarding.
Returns
Section titled “Returns”void
subscribe()
Section titled “subscribe()”subscribe(
listener): () =>void
Defined in: packages/devtools/src/types.ts:81
Observes state until unsubscribed.
Parameters
Section titled “Parameters”listener
Section titled “listener”() => void
Returns
Section titled “Returns”() => void