ILoaderServices Interface

Services and properties used by and exposed by the loader

This API is provided for existing users, but is not recommended for new users.

To use, import via @fluidframework/container-loader/legacy.

For more information about our API support guarantees, see here.

Signature

export interface ILoaderServices

Properties

Property	Alerts	Modifiers	Type	Description
codeLoader	Beta	readonly	ICodeDetailsLoader	The code loader handles loading the necessary code for running a container once it is loaded.
documentServiceFactory	Beta	readonly	IDocumentServiceFactory	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.
options	Beta	readonly	ILoaderOptions	A property bag of options used by various layers to control features
protocolHandlerBuilder	Beta	optional, readonly	ProtocolHandlerBuilder	Optional property for allowing the container to use a custom protocol implementation for handling the quorum and/or the audience.
scope	Beta	readonly	FluidObject	Scope is provided to all container and is a set of shared services for container's to integrate with their host environment.
subLogger	Beta	readonly	ITelemetryLoggerExt	The logger downstream consumers should construct their loggers from
urlResolver	Beta	readonly	IUrlResolver	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.

Property Details

codeLoader

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

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature

readonly codeLoader: ICodeDetailsLoader;

Type: ICodeDetailsLoader

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.

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature

readonly documentServiceFactory: IDocumentServiceFactory;

Type: IDocumentServiceFactory

options

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

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature

readonly options: ILoaderOptions;

Type: ILoaderOptions

protocolHandlerBuilder

Optional property for allowing the container to use a custom protocol implementation for handling the quorum and/or the audience.

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature

readonly protocolHandlerBuilder?: ProtocolHandlerBuilder;

Type: ProtocolHandlerBuilder

scope

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

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature

readonly scope: FluidObject;

Type: FluidObject

subLogger

The logger downstream consumers should construct their loggers from

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature

readonly subLogger: ITelemetryLoggerExt;

Type: ITelemetryLoggerExt

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.

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature

readonly urlResolver: IUrlResolver;

Type: IUrlResolver