Skip to main content
Version: v1

ILoaderProps Interface

Services and properties necessary for creating a loader

Signature

export interface ILoaderProps

Properties

PropertyModifiersTypeDescription
codeLoaderICodeDetailsLoaderThe code loader handles loading the necessary code for running a container once it is loaded.
configProvideroptionalIConfigProviderBaseThe configuration provider which may be used to control features.
detachedBlobStorageoptionalIDetachedBlobStorageBlobs storage for detached containers.
documentServiceFactoryIDocumentServiceFactoryThe document service factory take the Fluid url provided by the resolved url and constructs all the necessary services for communication with the container's server.
loggeroptionalITelemetryBaseLoggerThe logger that all telemetry should be pushed to.
optionsoptionalILoaderOptionsA property bag of options used by various layers to control features
scopeoptionalFluidObjectScope is provided to all container and is a set of shared services for container's to integrate with their host environment.
urlResolverIUrlResolverThe url resolver used by the loader for resolving external urls into Fluid urls such that the container specified by the external url can be loaded.

Property Details

codeLoader

The code loader handles loading the necessary code for running a container once it is loaded.

Signature

readonly codeLoader: ICodeDetailsLoader;

Type: ICodeDetailsLoader

configProvider

The configuration provider which may be used to control features.

Signature

readonly configProvider?: IConfigProviderBase;

Type: IConfigProviderBase

detachedBlobStorage

Blobs storage for detached containers.

Signature

readonly detachedBlobStorage?: IDetachedBlobStorage;

Type: IDetachedBlobStorage

documentServiceFactory

The document service factory take the Fluid url provided by the resolved url and constructs all the necessary services for communication with the container's server.

Signature

readonly documentServiceFactory: IDocumentServiceFactory;

Type: IDocumentServiceFactory

logger

The logger that all telemetry should be pushed to.

Signature

readonly logger?: ITelemetryBaseLogger;

Type: ITelemetryBaseLogger

options

A property bag of options used by various layers to control features

Signature

readonly options?: ILoaderOptions;

Type: ILoaderOptions

scope

Scope is provided to all container and is a set of shared services for container's to integrate with their host environment.

Signature

readonly scope?: FluidObject;

Type: FluidObject

urlResolver

The url resolver used by the loader for resolving external urls into Fluid urls such that the container specified by the external url can be loaded.

Signature

readonly urlResolver: IUrlResolver;

Type: IUrlResolver