Skip to main content

IFluidModuleWithDetails Interface

This API is deprecated and will be removed in a future release.

IFluidModuleWithDetails interface is moved to IFluidModuleWithDetails to have all the code loading modules in one package. #8193 Encapsulates a module entry point with corresponding code details.

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 IFluidModuleWithDetails

Properties​

Property Alerts Type Description
details Alpha IFluidCodeDetails Code details associated with the module. Represents a document schema this module supports. If the code loader implements the @fluidframework/core-interfaces#IFluidCodeDetailsComparer interface, it'll be called to determine whether the module code details satisfy the new code proposal in the quorum.
module Alpha IFluidModule Fluid code module that implements the runtime factory needed to instantiate the container runtime.

Property Details​

details​

Code details associated with the module. Represents a document schema this module supports. If the code loader implements the @fluidframework/core-interfaces#IFluidCodeDetailsComparer interface, it'll be called to determine whether the module code details satisfy the new code proposal in the quorum.

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​

details: IFluidCodeDetails;

Type: IFluidCodeDetails

module​

Fluid code module that implements the runtime factory needed to instantiate the container runtime.

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​

module: IFluidModule;

Type: IFluidModule