IFluidHandle Interface
Handle to a shared FluidObject.
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.
Signature
readonly [fluidHandleSymbol]: IFluidHandleErased<T>;
Type: IFluidHandleErased<T>
isAttached
Flag indicating whether or not the entity has services attached.
Signature
readonly isAttached: boolean;
Type: boolean
Method Details
get
Returns a promise to the Fluid Object referenced by the handle.
Signature
get(): Promise<T>;
Returns
Return type: Promise<T>