FluidObjectHandle Class
Signature
export declare class FluidObjectHandle<T extends FluidObject = FluidObject> implements IFluidHandle
Implements: IFluidHandle
Type Parameters
| Parameter | Constraint | Default | Description |
|---|---|---|---|
| T | FluidObject | FluidObject |
Constructors
| Constructor | Description |
|---|---|
| (constructor)(value, path, routeContext) | Creates a new FluidObjectHandle. |
Properties
| Property | Type | Description |
|---|---|---|
| absolutePath | string | |
| IFluidHandle | IFluidHandle | |
| isAttached | boolean | |
| path | string | |
| routeContext | IFluidHandleContext | |
| value | T |
Methods
| Method | Return Type | Description |
|---|---|---|
| attachGraph() | void | |
| bind(handle) | void | |
| get() | Promise<any> |
Constructor Details
(constructor)
Creates a new FluidObjectHandle.
Signature
constructor(value: T, path: string, routeContext: IFluidHandleContext);
Parameters
| Parameter | Type | Description |
|---|---|---|
| value | T | The FluidObject object this handle is for. |
| path | string | The path to this handle relative to the routeContext. |
| routeContext | IFluidHandleContext | The parent IFluidHandleContext that has a route to this handle. |
Property Details
absolutePath
Signature
readonly absolutePath: string;
Type: string
IFluidHandle
Signature
get IFluidHandle(): IFluidHandle;
Type: IFluidHandle
isAttached
Signature
get isAttached(): boolean;
Type: boolean
path
Signature
readonly path: string;
Type: string
routeContext
Signature
readonly routeContext: IFluidHandleContext;
Type: IFluidHandleContext
value
Signature
protected readonly value: T;
Type: T
Method Details
attachGraph
Signature
attachGraph(): void;
bind
Signature
bind(handle: IFluidHandle): void;
Parameters
| Parameter | Type | Description |
|---|---|---|
| handle | IFluidHandle |
get
Signature
get(): Promise<any>;
Returns
Return type: Promise<any>