Packages > @fluidframework/synthesize
@fluidframework/synthesize Package
Interfaces
| Interface | Alerts | Description |
|---|---|---|
| IFluidDependencySynthesizer |
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 |
ALPHA
|
Types
| TypeAlias | Alerts | Description |
|---|---|---|
| AsyncFluidObjectProvider |
ALPHA
|
Combined type for Optional and Required Async Fluid object Providers |
| AsyncOptionalFluidObjectProvider |
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 |
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. |
| FluidObjectSymbolProvider |
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 | Description |
|---|---|---|---|
| IFluidDependencySynthesizer |
ALPHA
|
readonly
|
Type Details
AsyncFluidObjectProvider (ALPHA)
Combined type for Optional and Required Async Fluid object Providers
WARNING: This API is provided as an alpha preview and may change without notice. Use at your own risk.
Signature
export type AsyncFluidObjectProvider<O, R = undefined> = AsyncOptionalFluidObjectProvider<O> & AsyncRequiredFluidObjectProvider<R>;
AsyncOptionalFluidObjectProvider (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.
WARNING: This API is provided as an alpha preview and may change without notice. Use at your own risk.
Signature
export type AsyncOptionalFluidObjectProvider<T> = T extends undefined ? Record<string, never> : {
[P in keyof T]?: Promise<T[P] | undefined>;
};
AsyncRequiredFluidObjectProvider (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.
WARNING: This API is provided as an alpha preview and may change without notice. Use at your own risk.
Signature
export type AsyncRequiredFluidObjectProvider<T> = T extends undefined ? Record<string, never> : {
[P in keyof T]: Promise<NonNullable<Exclude<T[P], undefined | null>>>;
};
FluidObjectSymbolProvider (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.
WARNING: This API is provided as an alpha preview and may change without notice. Use at your own risk.
Signature
export type FluidObjectSymbolProvider<T> = {
[P in keyof T]?: P;
};
Example
{ IFoo: "IFoo" }
Variable Details
IFluidDependencySynthesizer (ALPHA)
WARNING: This API is provided as an alpha preview and may change without notice. Use at your own risk.
Signature
IFluidDependencySynthesizer: keyof IProvideFluidDependencySynthesizer