Reference

@reckona/mreact-devtools

27 public exports.

Function

FunctioncompareDevtoolsResourceSnapshotsfunction compareDevtoolsResourceSnapshots(before: readonly DevtoolsResourceRecord[], after: readonly DevtoolsResourceRecord[]): DevtoolsResourceSnapshotDiffCompares two live-or-disposed snapshots without relying on finalizer timing.FunctioncreateDevtoolsfunction createDevtools(options: CreateDevtoolsOptions): DevtoolsCreates an in-memory devtools event bus.FunctioncreateDevtoolsResourceInspectorfunction createDevtoolsResourceInspector(maxResources: number): DevtoolsResourceInspectorCreates a bounded metadata registry for live resource inspection.FunctionemitMreactDevtoolsEventfunction emitMreactDevtoolsEvent(packageName: string, event: { type: string } & Record<string, unknown>): voidEmits a package-scoped devtools event to the installed global devtools instance.FunctionexportDevtoolsDiagnosticsfunction exportDevtoolsDiagnostics(devtools: Devtools): DevtoolsDiagnosticsV1Exports retained events and resource counts without reading event values or resource records.FunctiongetInstalledDevtoolsfunction getInstalledDevtools(): Devtools | undefinedReturns the devtools instance installed on `globalThis`, if one exists.FunctioninstallDevtoolsfunction installDevtools(devtools: Devtools, options: InstallDevtoolsOptions): DevtoolsInstalls a devtools instance on `globalThis` unless production mode blocks installation.FunctionregisterMreactDevtoolsResourcefunction registerMreactDevtoolsResource(input: DevtoolsResourceRegistration): { function dispose(): void; function update(patch: Partial<DevtoolsResourceRegistration>): void }Registers bounded resource metadata with the installed devtools instance when present.

Interface

InterfaceCreateDevtoolsOptionsinterface CreateDevtoolsOptionsConfigures event retention for `createDevtools()`.InterfaceDevtoolsinterface DevtoolsProvides event emission, subscription, history reads, and disposal for mreact devtools.InterfaceDevtoolsDiagnosticEventinterface DevtoolsDiagnosticEventA safely exportable event with all application values omitted.InterfaceDevtoolsDiagnosticKindCountsinterface DevtoolsDiagnosticKindCountsAggregate resource counts for a built-in kind or the catch-all `other` kind.InterfaceDevtoolsDiagnosticsV1interface DevtoolsDiagnosticsV1The stable, value-free first version of a devtools diagnostic report.InterfaceDevtoolsEventinterface DevtoolsEventDescribes one event emitted to the shared mreact devtools bus.InterfaceDevtoolsResourceCensusinterface DevtoolsResourceCensusInterfaceDevtoolsResourceHandleinterface DevtoolsResourceHandleInterfaceDevtoolsResourceInspectorinterface DevtoolsResourceInspectorInterfaceDevtoolsResourceRecordinterface DevtoolsResourceRecordInterfaceDevtoolsResourceRegistrationinterface DevtoolsResourceRegistrationInterfaceDevtoolsResourceSnapshotDiffinterface DevtoolsResourceSnapshotDiffInterfaceDevtoolsResourceSnapshotOptionsinterface DevtoolsResourceSnapshotOptionsInterfaceInstallDevtoolsOptionsinterface InstallDevtoolsOptionsConfigures installation of a devtools instance on `globalThis`.

Type Alias

Type AliasDevtoolsListenertype DevtoolsListener = (event: DevtoolsEvent): voidReceives devtools events when subscribed to a devtools instance.Type AliasDevtoolsResourceKindtype DevtoolsResourceKind = "computed" | "effect" | "inactive-query" | "other" | "pending-task" | "scope" | "subscription" | string & objectType AliasDevtoolsResourceOwnershiptype DevtoolsResourceOwnership = "owned" | "shared" | "unknown"

Variable

VariabledefaultDevtoolsMaxEventsconst defaultDevtoolsMaxEvents: 1000Sets the default number of events retained by a devtools instance.VariabledefaultDevtoolsMaxResourcesconst defaultDevtoolsMaxResources: 1000