Skip to main content
Version: v1

Loader Class

Manages Fluid resource loading

Signature

export declare class Loader implements IHostLoader

Implements: IHostLoader

Constructors

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

Properties

PropertyTypeDescription
IFluidRouterIFluidRouter
servicesILoaderServices

Methods

MethodReturn TypeDescription
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

ParameterTypeDescription
loaderPropsILoaderProps

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

ParameterTypeDescription
codeDetailsIFluidCodeDetails

Returns

Return type: Promise<IContainer>

rehydrateDetachedContainerFromSnapshot

Signature

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

Parameters

ParameterTypeDescription
snapshotstring

Returns

Return type: Promise<IContainer>

request

Signature

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

Parameters

ParameterTypeDescription
requestIRequest

Returns

Return type: Promise<IResponse>

resolve

Signature

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

Parameters

ParameterModifiersTypeDescription
requestIRequest
pendingLocalStateoptionalstring

Returns

Return type: Promise<IContainer>