@fluidframework/devtools Package

Primary entry-point to the Fluid Devtools.

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 @fluidframework/devtools-core#DevtoolsLogger and provide it during Devtools initialization.

Interfaces

Interface	Alerts	Description
ContainerDevtoolsProps	Beta	Properties for configuring Devtools for an individual IFluidContainer.
DevtoolsProps	Beta	Properties for configuring IDevtools.
IDevtools	Beta	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).

Functions

Function	Alerts	Return Type	Description
initializeDevtools(props)	Beta	IDevtools	Initializes the Devtools singleton and returns a handle to it.

Function Details

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