@fluidframework/container-definitions Package

Packages > @fluidframework/container-definitions

Enumerations

List of enums contained in this package or namespace
Enumeration Description
AttachState
BindState
ContainerErrorType Different error types the Container may report out to the Host
LoaderHeader Accepted header keys for requests coming to the Loader

Interfaces

List of interfaces contained in this package or namespace
Interface Description
IAudience Audience represents all clients connected to the op stream, both read-only and read/write.
ICodeAllowList Code AllowListing Interface
ICodeLoader Code loading interface
IConnectionDetails Contract representing the result of a newly established connection to the server for syncing deltas
IContainer The Host's view of the Container and its connection to storage
IContainerContext The ContainerContext is a proxy standing between the Container and the Container's IRuntime. This allows the Container to terminate the connection to the IRuntime.Specifically, there is an event on Container, onContextChanged, which mean a new code proposal has been loaded, so the old IRuntime is no longer valid, as its ContainerContext has been revoked, and the Container has created a new ContainerContext.
IContainerEvents Events emitted by the Container "upwards" to the Loader and Host
IDeltaHandlerStrategy Interface used to define a strategy for handling incoming delta messages
IDeltaManager Manages the transmission of ops between the runtime and storage.
IDeltaManagerEvents Events emitted by the Delta Manager
IDeltaQueue Queue of ops to be sent to or processed from storage
IDeltaQueueEvents Events emitted by a Delta Queue
IDeltaSender Contract supporting delivery of outbound messages to the server
IErrorBase Base interface for all errors and warnings at container level
IFluidBrowserPackage A Fluid package for specification for browser environments
IFluidBrowserPackageEnvironment A specific Fluid package environment for browsers
IFluidCodeResolver Fluid code resolvers take a Fluid code details, and resolve the full Fluid package including absolute urls for the browser file entries. The Fluid code resolver is coupled to a specific cdn and knows how to resolve the code detail for loading from that cdn. This include resolving to the most recent version of package that supports the provided code details.
IFluidModule
IFluidTokenProvider
IGenericError Generic wrapper for an unrecognized/uncategorized error object
ILoader The Host's view of the Loader, used for loading Containers
ILoaderHeader Set of Request Headers that the Loader understands and may inspect or modify
IProvideDeltaSender
IProvideFluidTokenProvider
IProvideRuntimeFactory
IProxyLoaderFactory Abstraction layer to support different Loaders in different Node execution contexts
IResolvedFluidCodeDetails The interface returned from a IFluidCodeResolver which represents IFluidCodeDetails that have been resolved and are ready to load
IRuntime The IRuntime represents an instantiation of a code package within a Container. Primarily held by the ContainerContext to be able to interact with the running instance of the Container.
IRuntimeFactory Exported module definitionProvides the entry point for the ContainerContext to load the proper IRuntime to start up the running instance of the Container.
IRuntimeState Represents the data that will be preserved from the previous IRuntime during a context reload.
IThrottlingWarning Warning emitted when requests to storage are being throttled

Variables

List of variables contained in this package or namespace
Variable Description
IDeltaSender
IFluidTokenProvider
IRuntimeFactory
isFluidBrowserPackage Determines if any object is an IFluidBrowserPackage

Type Aliases

List of type aliases contained in this package or namespace
Type Alias Description
ContainerWarning Represents warnings raised on container.
ICriticalContainerError Represents errors raised on container.
ILoaderOptions

Enumerations

AttachState enum

Signature:

export declare enum AttachState

Enumeration Members

List of members in use in this enum
Member Value Description
Attached "Attached"
Attaching "Attaching"
Detached "Detached"

BindState enum

Signature:

export declare enum BindState

Enumeration Members

List of members in use in this enum
Member Value Description
Binding "Binding"
Bound "Bound"
NotBound "NotBound"

ContainerErrorType enum

Different error types the Container may report out to the Host

Signature:

export declare enum ContainerErrorType

Enumeration Members

List of members in use in this enum
Member Value Description
dataCorruptionError "dataCorruptionError" Data loss error detected by Container / DeltaManager. Likely points to storage issue.
genericError "genericError" Some error, most likely an exception caught by runtime and propagated to container as critical error
throttlingError "throttlingError" Throttling error from server. Server is busy and is asking not to reconnect for some time

LoaderHeader enum

Accepted header keys for requests coming to the Loader

Signature:

export declare enum LoaderHeader

Enumeration Members

List of members in use in this enum
Member Value Description
cache "fluid-cache" Use cache for this container. If true, we will load a container from cache if one with the same id/version exists or create a new container and cache it if it does not. If false, always load a new container and don't cache it. Currently only used to opt-out of caching, as it will default to true but will be false (even if specified as true) if the reconnect header is false or the pause header is true, since these containers should not be cached.
clientDetails "fluid-client-details"
executionContext "execution-context"
pause "pause" Start the container in a paused, unconnected state. Defaults to false
reconnect "fluid-reconnect"
sequenceNumber "fluid-sequence-number"
version "version" One of the following: null or "null": use ops, no snapshots undefined: fetch latest snapshot otherwise, version sha to load snapshot

Variables

IDeltaSender

Signature:

IDeltaSender: keyof IProvideDeltaSender

IFluidTokenProvider

Signature:

IFluidTokenProvider: keyof IProvideFluidTokenProvider

IRuntimeFactory

Signature:

IRuntimeFactory: keyof IProvideRuntimeFactory

isFluidBrowserPackage

Determines if any object is an IFluidBrowserPackage

Signature:

isFluidBrowserPackage: (maybePkg: any) => maybePkg is Readonly<IFluidBrowserPackage>

Type Aliases

ContainerWarning

Represents warnings raised on container.

Signature:

export declare type ContainerWarning = IErrorBase;

ICriticalContainerError

Represents errors raised on container.

Signature:

export declare type ICriticalContainerError = IErrorBase;

ILoaderOptions

Signature:

export declare type ILoaderOptions = {
    [key in string | number]: any;
} & {
    hotSwapContext?: boolean;
};