Skip to main content
Version: v1

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

Signature

export interface IFluidPackage

Properties

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

Index Signatures

IndexSignature Description
[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.

Property Details

fluid

This object represents the Fluid specific properties of the package

Signature

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

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

name

The name of the package that this code represnets

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.

Signature

[key: string]: unknown;