IFluidDevtools 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).
To use, import via @fluidframework/devtools-core/alpha.
For more information about our API support guarantees, see here.
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 IFluidDevtools extends IDisposable
Extends: IDisposable
Remarks
Supports registering IContainers 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(containerKey) | Alpha |
void | Removes the Container with the specified ContainerKey from the Devtools. |
| registerContainerDevtools(props) | Alpha |
void | Registers the provided IContainer with the Devtools to begin generating stats for it. |
| registerContainerRuntime(props) | Alpha |
Promise<void> | Registers a container runtime with the devtools. |
Method Details
closeContainerDevtools
Removes the Container with the specified ContainerKey from the Devtools.
For more information about our API support guarantees, see here.
Signature
closeContainerDevtools(containerKey: ContainerKey): void;
Remarks
Will no-op if no such Container is registered.
Parameters
| Parameter | Type | Description |
|---|---|---|
| containerKey | ContainerKey |
registerContainerDevtools
Registers the provided IContainer with the Devtools to begin generating stats for it.
For more information about our API support guarantees, see here.
Signature
registerContainerDevtools(props: ContainerDevtoolsProps): void;
Remarks
To remove the Container from the Devtools, call closeContainerDevtools(containerKey).
Parameters
| Parameter | Type | Description |
|---|---|---|
| props | ContainerDevtoolsProps |
Error Handling
Will throw if devtools have already been registered for the specified ContainerKey.
registerContainerRuntime
Registers a container runtime with the devtools.
For more information about our API support guarantees, see here.
Signature
registerContainerRuntime(props: ContainerRuntimeProps): Promise<void>;
Remarks
To remove the Container Runtime from the Devtools, call closeContainerDevtools(containerKey).
Parameters
| Parameter | Type | Description |
|---|---|---|
| props | ContainerRuntimeProps |
Returns
Return type: Promise<void>
Error Handling
Will throw if devtools have already been registered for the specified ContainerKey.