IDevtools Interface

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).

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.

Sealed

This type is "sealed," meaning that code outside of the library defining it should not implement or extend it. Future versions of this type may add members or make typing of readonly members more specific.

Signature

/** @sealed */
export interface IDevtools extends IDisposable

Extends: IDisposable

Remarks

Supports registering IFluidContainers for Container-level stats (via registerContainerDevtools(props)).

The lifetime of the associated singleton is bound by that of the Window (globalThis), and it will be automatically disposed of on Window unload. If you wish to dispose of it earlier, you may call its dispose(error) method.

Methods

Method	Alerts	Return Type	Description
closeContainerDevtools(id)	Beta	void	Closes registered Container-level Devtools associated with the provided ID.
registerContainerDevtools(props)	Beta	void	Initializes a IDevtools from the provided properties and stores it for future reference.

Method Details

closeContainerDevtools

Closes registered Container-level Devtools associated with the provided ID.

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

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

Signature

closeContainerDevtools(id: string): void;

Parameters

Parameter	Type	Description
id	string

registerContainerDevtools

Initializes a IDevtools from the provided properties and stores it for future reference.

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

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

Signature

registerContainerDevtools(props: ContainerDevtoolsProps): void;

Parameters

Parameter	Type	Description
props	ContainerDevtoolsProps

Error Handling

Will throw if devtools have already been registered for the specified containerKey.