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	Alpha	optional, readonly	IFluidCodeDetailsConfig	Configuration details. This includes links to the package manager and base CDNs.
package	Alpha	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. This includes links to the package manager and base CDNs.

This API is provided as an alpha preview and may change without notice.

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

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

Signature

readonly config?: IFluidCodeDetailsConfig;

Type: IFluidCodeDetailsConfig

Remarks

This is strictly consumer-defined data. Its contents and semantics (including whether or not this data is present) are completely up to the consumer.

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 as an alpha preview and may change without notice.

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

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

Signature

readonly package: string | Readonly<IFluidPackage>;

Type: string | Readonly<IFluidPackage>