Skip to main content

FluidDevtoolsProps Interface

Properties for configuring 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 FluidDevtoolsProps

Properties​

Property Alerts Modifiers Type Description
initialContainers Alpha optional ContainerDevtoolsProps[] (optional) List of Containers to initialize the devtools with.
logger Alpha optional IDevtoolsLogger (optional) telemetry logger associated with the Fluid runtime.

Property Details​

initialContainers​

(optional) List of Containers to initialize the devtools with.

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​

initialContainers?: ContainerDevtoolsProps[];

Type: ContainerDevtoolsProps[]

Remarks​

Additional Containers can be registered with the Devtools via registerContainerDevtools(props).

logger​

(optional) telemetry logger associated with the Fluid runtime.

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​

logger?: IDevtoolsLogger;

Type: IDevtoolsLogger

Remarks​

Note: IFluidDevtools does not register this logger with the Fluid runtime; that must be done separately.

This is provided to the Devtools instance strictly to enable communicating supported / desired functionality with external listeners.