Skip to main content

ContainerDevtoolsProps Interface

Properties for registering a IContainer with the Devtools.

This API is provided as an alpha preview and may change without notice.

To use, import via @fluidframework/devtools-core/alpha.

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

Signature

export interface ContainerDevtoolsProps extends HasContainerKey

Extends: HasContainerKey

Properties

Property Alerts Modifiers Type Description
container Alpha IContainer The Container to register with the Devtools.
containerData Alpha optional Record<string, IFluidLoadable> (optional) Distributed Data Structures (DDSs) associated with the Container.

Property Details

container

The Container to register with the Devtools.

This API is provided as an alpha preview and may change without notice.

To use, import via @fluidframework/devtools-core/alpha.

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

Signature

container: IContainer;

Type: IContainer

containerData

(optional) Distributed Data Structures (DDSs) associated with the Container.

This API is provided as an alpha preview and may change without notice.

To use, import via @fluidframework/devtools-core/alpha.

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

Signature

containerData?: Record<string, IFluidLoadable>;

Type: Record<string, IFluidLoadable>

Remarks

Providing this data will enable associated tooling to visualize the Fluid data reachable from the provided objects.

Fluid DevTools will not mutate this data.