Skip to main content

ContainerRuntimeProps Interface

Properties for registering a container runtime 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 ContainerRuntimeProps

Properties

Property Alerts Modifiers Type Description
label Beta optional, readonly string Optional label for the container runtime replacing the guid generated by @fluidframework/container-runtime#IContainerRuntime.generateDocumentUniqueId.
runtime Beta readonly IContainerRuntime The container runtime to register with the Devtools.

Property Details

label

Optional label for the container runtime replacing the guid generated by @fluidframework/container-runtime#IContainerRuntime.generateDocumentUniqueId.

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 label?: string;

Type: string

runtime

The container runtime 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 runtime: IContainerRuntime;

Type: IContainerRuntime