IFluidHandle Interface
Handle to a shared FluidObject.
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 IFluidHandle<out T = unknown>
Type Parameters
| Parameter | Default | Description |
|---|---|---|
| T | unknown |
Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| [fluidHandleSymbol] | readonly |
IFluidHandleErased<T> | Symbol used to mark an object as a IFluidHandle and to recover the underlying handle implementation. |
| isAttached | readonly |
boolean | Flag indicating whether or not the entity has services attached. |
Methods
| Method | Return Type | Description |
|---|---|---|
| get() | Promise<T> | Returns a promise to the Fluid Object referenced by the handle. |
Property Details
[fluidHandleSymbol]
Symbol used to mark an object as a IFluidHandle and to recover the underlying handle implementation.
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
readonly [fluidHandleSymbol]: IFluidHandleErased<T>;
Type: IFluidHandleErased<T>
isAttached
Flag indicating whether or not the entity has services attached.
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
readonly isAttached: boolean;
Type: boolean
Method Details
get
Returns a promise to the Fluid Object referenced by the handle.
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
get(): Promise<T>;
Returns
Return type: Promise<T>