FluidContainerWithService Interface
A Fluid container with an associated ServiceClient it can attach to.
To use, import via fluid-framework/alpha.
For more information about our API support guarantees, see here.
This type is "sealed," meaning that code outside of the library defining it should not implement or extend it. Future versions of this type may add members or make typing of readonly members more specific.
Signature
/** @sealed */
export interface FluidContainerWithService<TData = unknown> extends FluidContainer<TData>
Extends: FluidContainer<TData>
Type Parameters
| Parameter | Default | Description |
|---|---|---|
| TData | unknown | The type of the container's root data store. |
Methods
| Method | Alerts | Return Type | Description |
|---|---|---|---|
| attach() | Alpha | Promise<FluidContainerAttached<TData>> | Attaches this container to the associated service client. The returned promise resolves once the container is attached: the container from the promise is the same one passed in as the argument. |
Method Details
attach
Attaches this container to the associated service client.
The returned promise resolves once the container is attached: the container from the promise is the same one passed in as the argument.
For more information about our API support guarantees, see here.
Signature
attach(): Promise<FluidContainerAttached<TData>>;
Returns
Return type: Promise<FluidContainerAttached<TData>>