Skip to main content
Version: v2

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​

ParameterDescription
T

Properties​

PropertyAlertsModifiersTypeDescription
[fluidHandleSymbol]BetareadonlyIFluidHandleErased<T>
absolutePathBetastring
IFluidHandleBetareadonlyIFluidHandleInternal
isAttachedBetareadonlyboolean

Methods​

MethodAlertsReturn TypeDescription
attachGraph()Betavoid
get()BetaPromise<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>