Skip to main content

IFluidPackage Interface

Fluid-specific properties expected on a package to be loaded by the code loader. While compatible with the npm package format it is not necessary that that package is an npm package: https://stackoverflow.com/questions/10065564/add-custom-metadata-or-config-to-package-json-is-it-valid

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 IFluidPackage

Properties​

Property Alerts Type Description
fluid Alpha { [environment: string]: undefined | IFluidPackageEnvironment; } This object represents the Fluid specific properties of the package
name Alpha string The name of the package that this code represnets

Index Signatures​

IndexSignature Alerts Description
[key: string]: unknown Alpha General access for extended fields as specific usages will likely have additional infornamation like a definition of compatible versions, or deployment information like rings or rollouts.

Property Details​

fluid​

This object represents the Fluid specific properties of the 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​

fluid: {
        [environment: string]: undefined | IFluidPackageEnvironment;
    };

Type: { [environment: string]: undefined | IFluidPackageEnvironment; }

name​

The name of the package that this code represnets

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​

name: string;

Type: string

Index Signature Details​

[key: string]: unknown​

General access for extended fields as specific usages will likely have additional infornamation like a definition of compatible versions, or deployment information like rings or rollouts.

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​

[key: string]: unknown;