@fluidframework/container-loader Package
Interfaces
| Interface | Alerts | Description |
|---|---|---|
| ICodeDetailsLoader | Deprecated |
|
| IContainerConfig | ||
| IContainerLoadOptions | ||
| IFluidModuleWithDetails | Deprecated |
|
| ILoaderOptions | ||
| ILoaderProps | Services and properties necessary for creating a loader | |
| ILoaderServices | Services and properties used by and exposed by the loader | |
| IPendingContainerState | State saved by a container at close time, to be used to load a new instance of the container to the same state |
Classes
| Class | Description |
|---|---|
| Container | |
| Loader | Manages Fluid resource loading |
| RelativeLoader |
Enumerations
| Enum | Description |
|---|---|
| ConnectionState |
Types
| TypeAlias | Description |
|---|---|
| IDetachedBlobStorage | Subset of IDocumentStorageService which only supports createBlob() and readBlob(). This is used to support blobs in detached containers. |
Functions
| Function | Return Type | Description |
|---|---|---|
| waitContainerToCatchUp(container) | Promise<boolean> | Waits until container connects to delta storage and gets up-to-date Useful when resolving URIs and hitting 404, due to container being loaded from (stale) snapshot and not being up to date. Host may chose to wait in such case and retry resolving URI. Warning: Will wait infinitely for connection to establish if there is no connection. May result in deadlock if Container.disconnect() is called and never followed by a call to Container.connect(). |
Function Details
waitContainerToCatchUp
Waits until container connects to delta storage and gets up-to-date Useful when resolving URIs and hitting 404, due to container being loaded from (stale) snapshot and not being up to date. Host may chose to wait in such case and retry resolving URI. Warning: Will wait infinitely for connection to establish if there is no connection. May result in deadlock if Container.disconnect() is called and never followed by a call to Container.connect().
Signature
export declare function waitContainerToCatchUp(container: IContainer): Promise<boolean>;
Parameters
| Parameter | Type | Description |
|---|---|---|
| container | IContainer |
Returns
true: container is up to date, it processed all the ops that were know at the time of first connection false: storage does not provide indication of how far the client is. Container processed all the ops known to it, but it maybe still behind.
Return type: Promise<boolean>
Error Handling
an error beginning with "Container closed" if the container is closed before it catches up.