ContainerAlpha Interface
IContainer interface that includes experimental features still under development.
To use, import via @fluidframework/container-loader/legacy.
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 ContainerAlpha extends IContainer
Extends: IContainer
Methods
| Method | Alerts | Return Type | Description |
|---|---|---|---|
| getPendingLocalState() | Alpha |
Promise<string> | Get pending state from container. WARNING: misuse of this API can result in duplicate op submission and potential document corruption. The blob returned MUST be deleted if and when this container emits a "connected" event. |
Method Details
getPendingLocalState
Get pending state from container. WARNING: misuse of this API can result in duplicate op submission and potential document corruption. The blob returned MUST be deleted if and when this container emits a "connected" event.
For more information about our API support guarantees, see here.
Signature
getPendingLocalState(): Promise<string>;
Returns
serialized blob that can be passed to Loader.resolve()
Return type: Promise<string>