Skip to main content

DevtoolsProps Interface

Properties for configuring IDevtools.

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.

Signature​

/** @sealed */
export interface DevtoolsProps

Properties​

Property Alerts Modifiers Type Description
initialContainers Beta optional, readonly ContainerDevtoolsProps[] (optional) List of Containers to initialize the devtools with.
logger Beta optional, readonly 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 a beta preview and may change without notice.

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

Signature​

readonly 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 a beta preview and may change without notice.

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

Signature​

readonly logger?: IDevtoolsLogger;

Type: IDevtoolsLogger

Remarks​

Note: the Devtools do 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.