Skip to main content
Version: v1

Loader Class

Manages Fluid resource loading

Signature​

export declare class Loader implements IHostLoader

Implements: IHostLoader

Constructors​

Constructor Description
(constructor)(loaderProps) Constructs a new instance of the Loader class

Properties​

Property Type Description
IFluidRouter IFluidRouter
services ILoaderServices

Methods​

Method Return Type Description
createDetachedContainer(codeDetails) Promise<IContainer>
rehydrateDetachedContainerFromSnapshot(snapshot) Promise<IContainer>
request(request) Promise<IResponse>
resolve(request, pendingLocalState) Promise<IContainer>

Constructor Details​

(constructor)​

Constructs a new instance of the Loader class

Signature​
constructor(loaderProps: ILoaderProps);

Parameters​

Parameter Type Description
loaderProps ILoaderProps

Property Details​

IFluidRouter​

Signature​
get IFluidRouter(): IFluidRouter;

Type: IFluidRouter

services​

Signature​
readonly services: ILoaderServices;

Type: ILoaderServices

Method Details​

createDetachedContainer​

Signature​
createDetachedContainer(codeDetails: IFluidCodeDetails): Promise<IContainer>;

Parameters​

Parameter Type Description
codeDetails IFluidCodeDetails

Returns​

Return type: Promise<IContainer>

rehydrateDetachedContainerFromSnapshot​

Signature​
rehydrateDetachedContainerFromSnapshot(snapshot: string): Promise<IContainer>;

Parameters​

Parameter Type Description
snapshot string

Returns​

Return type: Promise<IContainer>

request​

Signature​
request(request: IRequest): Promise<IResponse>;

Parameters​

Parameter Type Description
request IRequest

Returns​

Return type: Promise<IResponse>

resolve​

Signature​
resolve(request: IRequest, pendingLocalState?: string): Promise<IContainer>;

Parameters​

Parameter Modifiers Type Description
request IRequest
pendingLocalState optional string

Returns​

Return type: Promise<IContainer>