IFluidCodeDetails Interface

Data structure used to describe the code to load on the Fluid document

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

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

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

Signature

export interface IFluidCodeDetails

Properties

Property	Alerts	Modifiers	Type	Description
config	Beta	optional, readonly	IFluidCodeDetailsConfig	Configuration details and additional information about the Fluid document.
package	Beta	readonly	string | Readonly<IFluidPackage>	The code package to be used on the Fluid document. This is either the package name which will be loaded from a package manager, or the expanded Fluid package.

Property Details

config

Configuration details and additional information about the Fluid document.

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 config?: IFluidCodeDetailsConfig;

Type: IFluidCodeDetailsConfig

Remarks

This is mainly consumer-defined data (e.g. links to a package manager and base CDNs). Its contents and semantics (including whether or not this data is present) are completely up to the consumer, _except_ for keys starting with "FluidFramework." (e.g. "FluidFramework.CustomSetting1") which are reserved by the framework and should not be used by consumers. Outside of those reserved keys, Fluid does not interpret this data in any way.

package

The code package to be used on the Fluid document. This is either the package name which will be loaded from a package manager, or the expanded Fluid package.

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 package: string | Readonly<IFluidPackage>;

Type: string | Readonly<IFluidPackage>