Skip to main content

FluidHandleBase Class

Base class which can be uses to assist implementing IFluidHandleInternal. \

This API is provided for existing users, but is not recommended for new users.

To use, import via @fluidframework/runtime-utils/legacy.

For more information about our API support guarantees, see here.

Signature

export declare abstract class FluidHandleBase<T> implements IFluidHandleInternal<T>

Implements: IFluidHandleInternal<T>

Type Parameters

Parameter Description
T

Properties

Property Alerts Modifiers Type Description
[fluidHandleSymbol] Beta readonly IFluidHandleErased<T>
absolutePath Beta string
IFluidHandle Beta readonly IFluidHandleInternal
isAttached Beta readonly boolean

Methods

Method Alerts Return Type Description
attachGraph() Beta void
get() Beta Promise<T>

Property Details

[fluidHandleSymbol]

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature
get [fluidHandleSymbol](): IFluidHandleErased<T>;

Type: IFluidHandleErased<T>

absolutePath

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature
abstract absolutePath: string;

Type: string

IFluidHandle

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature
get IFluidHandle(): IFluidHandleInternal;

Type: IFluidHandleInternal

isAttached

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature
abstract readonly isAttached: boolean;

Type: boolean

Method Details

attachGraph

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature
abstract attachGraph(): void;

get

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature
abstract get(): Promise<T>;

Returns

Return type: Promise<T>