DevtoolsProps Interface
Properties for configuring IDevtools.
To use, import via @fluidframework/devtools/beta.
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 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.
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
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.
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
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.