Skip to main content

IContainerDriverServices Interface

The driver-services pair — urlResolver plus documentServiceFactory — required to wire a container to a real driver at create or load time.

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 IContainerDriverServices

Remarks

Extracted as a reusable building block so the request field can be added on top for load-time props (see IContainerLoadDriverProps) while create-time props that don't carry a request can compose just this pair.

Properties

PropertyAlertsModifiersTypeDescription
documentServiceFactoryBetareadonlyIDocumentServiceFactoryThe 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.
urlResolverBetareadonlyIUrlResolverThe 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

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

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