Skip to main content

@fluidframework/synthesize Package

Interfaces​

InterfaceAlertsDescription
IFluidDependencySynthesizerLegacyIFluidDependencySynthesizer 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.
IProvideFluidDependencySynthesizerLegacy

Classes​

ClassAlertsDescription
DependencyContainerLegacyDependencyContainer is similar to a IoC Container. It takes providers and will synthesize an object based on them when requested.

Types​

TypeAliasAlertsDescription
AsyncFluidObjectProviderLegacyCombined type for Optional and Required Async Fluid object Providers
AsyncOptionalFluidObjectProviderLegacyThis 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.
AsyncRequiredFluidObjectProviderLegacyThis 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.
FluidObjectProviderLegacyMultiple ways to provide a Fluid object.
FluidObjectSymbolProviderLegacyThis 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​

VariableAlertsModifiersTypeDescription
IFluidDependencySynthesizerLegacyreadonlykeyof 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