@fluidframework/synthesize Package

Packages > @fluidframework/synthesize

Interfaces

Interface Alerts Description
IFluidDependencySynthesizer Legacy, Alpha IFluidDependencySynthesizer can generate FluidObjects based on the IProvideFluidObject pattern. It allow for registering providers and uses synthesize to generate a new object with the optional and required types.
IProvideFluidDependencySynthesizer Legacy, Alpha

Classes

Class Alerts Description
DependencyContainer Legacy, Alpha DependencyContainer is similar to a IoC Container. It takes providers and will synthesize an object based on them when requested.

Types

TypeAlias Alerts Description
AsyncFluidObjectProvider Legacy, Alpha Combined type for Optional and Required Async Fluid object Providers
AsyncOptionalFluidObjectProvider Legacy, Alpha This is a condensed version of Record that requires the object has all the FluidObject properties as its type, mapped to an object that implements the property or undefined.
AsyncRequiredFluidObjectProvider Legacy, Alpha This is a condensed version of Record that requires the object has all the FluidObject properties as its type mapped to an object that implements the property.
FluidObjectProvider Legacy, Alpha Multiple ways to provide a Fluid object.
FluidObjectSymbolProvider Legacy, Alpha This is a condensed version of Record that requires the object has all the FluidObject properties as its type mapped to a string representation of that property.

Variables

Variable Alerts Modifiers Type Description
IFluidDependencySynthesizer Legacy, Alpha readonly keyof IProvideFluidDependencySynthesizer

Variable Details

IFluidDependencySynthesizer

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

To use, import via @fluidframework/synthesize/legacy.

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

Signature

IFluidDependencySynthesizer: keyof IProvideFluidDependencySynthesizer

Type: keyof IProvideFluidDependencySynthesizer