@fluidframework/container-runtime Package

Interfaces

Interface	Alerts	Description
ContainerRuntimeOptions	Legacy	Full set of options for container runtime as "required".
IAckedSummary	Legacy	A single summary which has already been acked by the server.
IAckSummaryResult	Legacy
IBaseSummarizeResult	Legacy	Base results for all submitSummary attempts.
IBroadcastSummaryResult	Legacy
IClientSummaryWatcher	Legacy	Watches summaries created by a specific client.
ICompressionRuntimeOptions	Legacy	Options for op compression.
IEnqueueSummarizeOptions	Legacy	Options to use when enqueueing a summarize attempt.
IFluidDataStoreAttributes0	Deprecated, Legacy
IFluidDataStoreAttributes1	Deprecated, Legacy
IFluidDataStoreAttributes2	Deprecated, Legacy
IGCRuntimeOptions	Legacy
IGeneratedSummaryStats	Legacy	In addition to the normal summary tree + stats, this contains additional stats only relevant at the root of the tree.
IGenerateSummaryTreeResult	Legacy	Results of submitSummary after generating the summary tree.
INackSummaryResult	Legacy
IOnDemandSummarizeOptions	Legacy
IRetriableFailureError	Legacy	Type for summarization failures that are retriable.
ISubmitSummaryOpResult	Legacy	Results of submitSummary after submitting the summarize op.
ISummarizeOptions	Legacy	Options affecting summarize behavior.
ISummarizer	Legacy
ISummarizeResults	Legacy
ISummary	Legacy	A single summary which can be tracked as it goes through its life cycle. The life cycle is: Local to Broadcast to Acked/Nacked.
ISummaryAckMessage	Legacy	Interface for summary ack messages with typed contents.
ISummaryBaseConfiguration	Legacy
ISummaryCollectionOpEvents	Legacy
ISummaryConfigurationDisableHeuristics	Legacy
ISummaryConfigurationDisableSummarizer	Legacy
ISummaryConfigurationHeuristics	Legacy
ISummaryNackMessage	Legacy	Interface for summary nack messages with typed contents.
ISummaryOpMessage	Legacy	Interface for summary op messages with typed contents.
ISummaryRuntimeOptions	Legacy
IUploadSummaryResult	Legacy	Results of submitSummary after uploading the tree to storage.
LoadContainerRuntimeParams	Legacy	This object holds the parameters necessary for the loadContainerRuntime(params) function.
SubmitSummaryFailureData	Legacy	The data in summarizer result when submit summary stage fails.

Classes

Class	Alerts	Description
SummaryCollection	Legacy	Data structure that looks at the op stream to track summaries as they are broadcast, acked and nacked. It provides functionality for watching specific summaries.

Enumerations

Enum	Alerts	Description
CompressionAlgorithms	Legacy	Available compression algorithms for op compression.
ContainerMessageType	Legacy

Types

TypeAlias	Alerts	Description
EnqueueSummarizeResult	Legacy
IContainerRuntimeOptions	Legacy	Options for container runtime.
IdCompressorMode	Legacy	ID Compressor mode. "on" - compressor is On. It's loaded as part of container load. This mode is sticky - once on, compressor is On for all sessions for a given document. This results in IContainerRuntime.idCompressor to be always available. "delayed" - ID compressor bundle is loaded only on establishing of first delta connection, i.e. it does not impact boot of cotnainer. In such mode IContainerRuntime.idCompressor is not made available (unless previous sessions of same document had it "On"). The only thing that is available is IContainerRuntime.generateDocumentUniqueId() that provides opportunistically short IDs. undefined - ID compressor is not loaded. While IContainerRuntime.generateDocumentUniqueId() is available, it will produce long IDs that are do not compress well.
ISummaryConfiguration	Legacy
OmitAttributesVersions	Deprecated, Legacy
OpActionEventListener	Legacy
OpActionEventName	Legacy
ReadFluidDataStoreAttributes	Deprecated, Legacy	Added IFluidDataStoreAttributes similar to IChannelAttributes which will tell the attributes of a store like the package, snapshotFormatVersion to take different decisions based on a particular snapshotFormatVersion.
SubmitSummaryResult	Legacy	Strict type representing result of a submitSummary attempt. The result consists of 4 possible stages, each with its own data. The data is cumulative, so each stage will contain the data from the previous stages. If the final "submitted" stage is not reached, the result may contain the error object. Stages: 1. "base" - stopped before the summary tree was even generated, and the result only contains the base data 2. "generate" - the summary tree was generated, and the result will contain that tree + stats 3. "upload" - the summary was uploaded to storage, and the result contains the server-provided handle 4. "submit" - the summarize op was submitted, and the result contains the op client sequence number.
SummarizeResultPart	Legacy
SummaryStage	Legacy	The stages of Summarize, used to describe how far progress succeeded in case of a failure at a later stage.

Functions

Function	Alerts	Return Type	Description
loadContainerRuntime(params)	Legacy	Promise<IContainerRuntime & IRuntime>	This is meant to be used by a @fluidframework/container-definitions#IRuntimeFactory to instantiate a container runtime.

Variables

Variable	Alerts	Modifiers	Type	Description
AllowTombstoneRequestHeaderKey	Legacy	readonly		True if a tombstoned object should be returned without erroring
DefaultSummaryConfiguration	Legacy	readonly	ISummaryConfiguration
disabledCompressionConfig	Legacy	readonly	ICompressionRuntimeOptions
InactiveResponseHeaderKey	Deprecated, Legacy	readonly		Inactive error responses will have this header set to true
TombstoneResponseHeaderKey	Legacy	readonly		Tombstone error responses will have this header set to true

Function Details

loadContainerRuntime

This is meant to be used by a @fluidframework/container-definitions#IRuntimeFactory to instantiate a container runtime.

This API is provided for existing users, but is not recommended for new users.

To use, import via @fluidframework/container-runtime/legacy.

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

Signature

export declare function loadContainerRuntime(params: LoadContainerRuntimeParams): Promise<IContainerRuntime & IRuntime>;

Parameters

Parameter	Type	Description
params	LoadContainerRuntimeParams	An object which specifies all required and optional params necessary to instantiate a runtime.

Returns

A runtime which provides all the functionality necessary to bind with the loader layer via the IRuntime interface and provide a runtime environment via the IContainerRuntime interface.

Return type: Promise<IContainerRuntime & IRuntime>

Variable Details

AllowTombstoneRequestHeaderKey

True if a tombstoned object should be returned without erroring

This API is provided for existing users, but is not recommended for new users.

To use, import via @fluidframework/container-runtime/legacy.

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

Signature

AllowTombstoneRequestHeaderKey = "allowTombstone"

DefaultSummaryConfiguration

This API is provided for existing users, but is not recommended for new users.

To use, import via @fluidframework/container-runtime/legacy.

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

Signature

DefaultSummaryConfiguration: ISummaryConfiguration

Type: ISummaryConfiguration

disabledCompressionConfig

This API is provided for existing users, but is not recommended for new users.

To use, import via @fluidframework/container-runtime/legacy.

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

Signature

disabledCompressionConfig: ICompressionRuntimeOptions

Type: ICompressionRuntimeOptions

InactiveResponseHeaderKey

Inactive error responses will have this header set to true

This API is deprecated and will be removed in a future release.

this header is deprecated and will be removed in the future. The functionality corresponding to this was experimental and is no longer supported.

This API is provided for existing users, but is not recommended for new users.

To use, import via @fluidframework/container-runtime/legacy.

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

Signature

InactiveResponseHeaderKey = "isInactive"

TombstoneResponseHeaderKey

Tombstone error responses will have this header set to true

This API is provided for existing users, but is not recommended for new users.

To use, import via @fluidframework/container-runtime/legacy.

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

Signature

TombstoneResponseHeaderKey = "isTombstoned"