IFluidHandleInternal Interface
Handle to a shared FluidObject.
WARNING: This API is provided as an alpha preview and may change without notice. Use at your own risk.
Signature
export interface IFluidHandleInternal<out T = unknown> extends IFluidHandle<T>, IProvideFluidHandle
Extends: IFluidHandle<T>, IProvideFluidHandle
Type Parameters
| Parameter | Default | Description |
|---|---|---|
| T | unknown |
Properties
| Property | Alerts | Modifiers | Type | Description |
|---|---|---|---|---|
| absolutePath | Alpha |
readonly |
string | The absolute path to the handle context from the root. |
Methods
| Method | Alerts | Return Type | Description |
|---|---|---|---|
| attachGraph() | Alpha |
void | Runs through the graph and attach the bounded handles. |
| bind(handle) | Alpha |
void | Binds the given handle to this one or attach the given handle if this handle is attached. A bound handle will also be attached once this handle is attached. |
Property Details
absolutePath
The absolute path to the handle context from the root.
WARNING: This API is provided as an alpha preview and may change without notice. Use at your own risk.
Signature
readonly absolutePath: string;
Type: string
Method Details
attachGraph
Runs through the graph and attach the bounded handles.
WARNING: This API is provided as an alpha preview and may change without notice. Use at your own risk.
Signature
attachGraph(): void;
bind
Binds the given handle to this one or attach the given handle if this handle is attached. A bound handle will also be attached once this handle is attached.
WARNING: This API is provided as an alpha preview and may change without notice. Use at your own risk.
Signature
bind(handle: IFluidHandleInternal): void;
Parameters
| Parameter | Type | Description |
|---|---|---|
| handle | IFluidHandleInternal |