IHostLoader Interface
Packages > @fluidframework/container-definitions > IHostLoader
The Host’s view of the Loader, used for loading Containers
This API is provided for existing users, but is not recommended for new users.
To use, import via @fluidframework/container-definitions/legacy.
For more information about our API support guarantees, see here .
Signature
export interface IHostLoader extends ILoader
Extends: ILoader
Methods
| Method | Alerts | Return Type | Description |
|---|---|---|---|
| createDetachedContainer(codeDetails, createDetachedProps) |
Alpha
|
Promise<IContainer> | Creates a new container using the specified chaincode but in an unattached state. While unattached all updates will only be local until the user explicitly attaches the container to a service provider. |
| rehydrateDetachedContainerFromSnapshot(snapshot, createDetachedProps) |
Alpha
|
Promise<IContainer> | Creates a new container using the specified snapshot but in an unattached state. While unattached all updates will only be local until the user explicitly attaches the container to a service provider. |
Method Details
createDetachedContainer
Creates a new container using the specified chaincode but in an unattached state. While unattached all updates will only be local until the user explicitly attaches the container to a service provider.
This API is provided as an alpha preview and may change without notice.
To use, import via @fluidframework/container-definitions/alpha.
For more information about our API support guarantees, see here .
Signature
createDetachedContainer(codeDetails: IFluidCodeDetails, createDetachedProps?: {
canReconnect?: boolean;
clientDetailsOverride?: IClientDetails;
}): Promise<IContainer>;
Parameters
| Parameter | Modifiers | Type | Description |
|---|---|---|---|
| codeDetails | IFluidCodeDetails | ||
| createDetachedProps | optional | { canReconnect?: boolean; clientDetailsOverride?: IClientDetails; } |
Returns
Return type: Promise<IContainer >
rehydrateDetachedContainerFromSnapshot
Creates a new container using the specified snapshot but in an unattached state. While unattached all updates will only be local until the user explicitly attaches the container to a service provider.
This API is provided as an alpha preview and may change without notice.
To use, import via @fluidframework/container-definitions/alpha.
For more information about our API support guarantees, see here .
Signature
rehydrateDetachedContainerFromSnapshot(snapshot: string, createDetachedProps?: {
canReconnect?: boolean;
clientDetailsOverride?: IClientDetails;
}): Promise<IContainer>;
Parameters
| Parameter | Modifiers | Type | Description |
|---|---|---|---|
| snapshot | string | ||
| createDetachedProps | optional | { canReconnect?: boolean; clientDetailsOverride?: IClientDetails; } |
Returns
Return type: Promise<IContainer >