ICodeDetailsLoader Interface
Packages > @fluidframework/container-loader > ICodeDetailsLoader
This API is deprecated and will be removed in a future release.
ICodeDetailsLoader interface is moved to ICodeDetailsLoader to have code loading modules in one package. #8193 Fluid code loader resolves a code module matching the document schema, i.e. code details, such as a package name and package version range.
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 ICodeDetailsLoader extends Partial<IProvideFluidCodeDetailsComparer>
Extends: Partial<IProvideFluidCodeDetailsComparer >
Methods
| Method | Alerts | Return Type | Description |
|---|---|---|---|
| load(source) |
Alpha
|
Promise<IFluidModuleWithDetails> | Load the code module (package) that is capable to interact with the document. |
Method Details
load
Load the code module (package) that is capable to interact with the document.
This API is provided as an alpha preview and may change without notice.
To use, import via @fluidframework/container-loader/alpha.
For more information about our API support guarantees, see here .
Signature
load(source: IFluidCodeDetails): Promise<IFluidModuleWithDetails>;
Parameters
| Parameter | Type | Description |
|---|---|---|
| source | IFluidCodeDetails | Code proposal that articulates the current schema the document is written in. |
Returns
Code module entry point along with the code details associated with it.
Return type: Promise<IFluidModuleWithDetails >