@fluidframework/devtools Package

Used in conjunction with the Fluid Framework Developer Tools browser extension to allow visualization of and interaction with Fluid data.

To initialize the Devtools alongside your application's IFluidContainer, call initializeDevtools(props).

The Devtools will automatically dispose of themselves upon Window unload, but if you would like to close them earlier, call IDevtools.dispose.

To enable visualization of Telemetry data, you may create a DevtoolsLogger and provide it during Devtools initialization.

For more details and examples, see the package README.

Interfaces

Interface	Alerts	Modifiers	Description
ContainerDevtoolsProps	Beta	sealed	Properties for configuring Devtools for an individual IFluidContainer.
DevtoolsProps	Beta	sealed	Properties for configuring IDevtools.
HasContainerKey	System	sealed	Common interface for data associated with a particular Container registered with the Devtools.
IDevtools	Beta	sealed	Fluid Devtools. A single, global instance is used to generate and communicate stats associated with the general Fluid runtime (i.e., it is not associated with any single Framework entity).
IDevtoolsLogger	Beta	sealed	Logger implementation that posts all telemetry events to the window (globalThis object). This logger is intended to integrate with the Fluid DevTools browser extension.

Types

TypeAlias	Alerts	Description
ContainerKey	Beta	A key used to identify and differentiate Containers registered with the IFluidDevtools.

Functions

Function	Alerts	Return Type	Description
createDevtoolsLogger(baseLogger)	Beta	IDevtoolsLogger	Creates a new IDevtoolsLogger by wrapping the provided (optional) base logger.
initializeDevtools(props)	Beta	IDevtools	Initializes the Devtools singleton and returns a handle to it.

Function Details

createDevtoolsLogger

Creates a new IDevtoolsLogger by wrapping the provided (optional) base logger.

This API is provided as a beta preview and may change without notice.

To use, import via @fluidframework/devtools/beta.

For more information about our API support guarantees, see here.

Signature

export declare function createDevtoolsLogger(baseLogger?: ITelemetryBaseLogger): IDevtoolsLogger;

Parameters

Parameter	Modifiers	Type	Description
baseLogger	optional	ITelemetryBaseLogger

Returns

Return type: IDevtoolsLogger

initializeDevtools

Initializes the Devtools singleton and returns a handle to it.

This API is provided as a beta preview and may change without notice.

To use, import via @fluidframework/devtools/beta.

For more information about our API support guarantees, see here.

Signature

export declare function initializeDevtools(props: DevtoolsProps): IDevtools;

Parameters

Parameter	Type	Description
props	DevtoolsProps

Returns

Return type: IDevtools

See Also

@fluidframework/devtools-core#initializeDevtoolsBase