Skip to main content

ContainerDevtoolsProps Interface

Properties for registering a IContainer with the Devtools.

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

To use, import via @fluidframework/devtools-core/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.

Input

This type is "input," meaning that code outside of the library defining it should not read from it. Future versions of this type may add optional members or make typing of members more general.

Signature

/** @sealed */
export interface ContainerDevtoolsProps extends HasContainerKey

Extends: HasContainerKey

Properties

Property Alerts Modifiers Type Description
container Beta readonly IContainer The Container to register with the Devtools.
containerData Beta optional, readonly 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 a beta preview and may change without notice.

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

Signature
readonly container: IContainer;

Type: IContainer

containerData

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

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

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

Signature
readonly 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.