datastore.api.md

API Report File for "@fluidframework/datastore"

Do not edit this file. It is a report generated by API Extractor.

import { AttachState } from '@fluidframework/container-definitions';
import { FluidObject } from '@fluidframework/core-interfaces';
import { IAudience } from '@fluidframework/container-definitions';
import { IChannel } from '@fluidframework/datastore-definitions';
import { IChannelFactory } from '@fluidframework/datastore-definitions';
import { IClientDetails } from '@fluidframework/protocol-definitions';
import { IDeltaManager } from '@fluidframework/container-definitions';
import { IDocumentMessage } from '@fluidframework/protocol-definitions';
import { IFluidDataStoreChannel } from '@fluidframework/runtime-definitions';
import { IFluidDataStoreContext } from '@fluidframework/runtime-definitions';
import { IFluidDataStoreRuntime } from '@fluidframework/datastore-definitions';
import { IFluidDataStoreRuntimeEvents } from '@fluidframework/datastore-definitions';
import { IFluidHandle } from '@fluidframework/core-interfaces';
import { IFluidHandleContext } from '@fluidframework/core-interfaces';
import { IGarbageCollectionData } from '@fluidframework/runtime-definitions';
import { IInboundSignalMessage } from '@fluidframework/runtime-definitions';
import { ILoaderOptions } from '@fluidframework/container-definitions';
import { IQuorumClients } from '@fluidframework/protocol-definitions';
import { IRequest } from '@fluidframework/core-interfaces';
import { IResponse } from '@fluidframework/core-interfaces';
import { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
import { ISummaryTreeWithStats } from '@fluidframework/runtime-definitions';
import { ITelemetryContext } from '@fluidframework/runtime-definitions';
import { ITelemetryLogger } from '@fluidframework/common-definitions';
import { TypedEventEmitter } from '@fluidframework/common-utils';
import { VisibilityState as VisibilityState_2 } from '@fluidframework/runtime-definitions';

// @public (undocumented)
export enum DataStoreMessageType {
    // (undocumented)
    Attach = "attach",
    // (undocumented)
    ChannelOp = "op"
}

// @public
export class FluidDataStoreRuntime extends TypedEventEmitter<IFluidDataStoreRuntimeEvents> implements IFluidDataStoreChannel, IFluidDataStoreRuntime, IFluidHandleContext {
    constructor(dataStoreContext: IFluidDataStoreContext, sharedObjectRegistry: ISharedObjectRegistry, existing: boolean, initializeEntryPoint?: (runtime: IFluidDataStoreRuntime) => Promise<FluidObject>);
    // (undocumented)
    get absolutePath(): string;
    // (undocumented)
    applyStashedOp(content: any): Promise<unknown>;
    attachGraph(): void;
    // (undocumented)
    get attachState(): AttachState;
    // (undocumented)
    bind(handle: IFluidHandle): void;
    bindChannel(channel: IChannel): void;
    // @deprecated (undocumented)
    bindToContext(): void;
    // (undocumented)
    get channelsRoutingContext(): this;
    // (undocumented)
    get clientDetails(): IClientDetails;
    // (undocumented)
    get clientId(): string | undefined;
    // (undocumented)
    get connected(): boolean;
    // (undocumented)
    createChannel(id: string | undefined, type: string): IChannel;
    // (undocumented)
    readonly deltaManager: IDeltaManager<ISequencedDocumentMessage, IDocumentMessage>;
    // (undocumented)
    dispose(): void;
    // (undocumented)
    get disposed(): boolean;
    ensureNoDataModelChanges<T>(callback: () => T): T;
    // (undocumented)
    readonly entryPoint?: IFluidHandle<FluidObject>;
    // (undocumented)
    getAttachSummary(telemetryContext?: ITelemetryContext): ISummaryTreeWithStats;
    // (undocumented)
    getAudience(): IAudience;
    // (undocumented)
    getChannel(id: string): Promise<IChannel>;
    getGCData(fullGC?: boolean): Promise<IGarbageCollectionData>;
    // (undocumented)
    getQuorum(): IQuorumClients;
    // (undocumented)
    readonly id: string;
    // (undocumented)
    get IFluidHandleContext(): this;
    // (undocumented)
    get IFluidRouter(): this;
    // (undocumented)
    get isAttached(): boolean;
    // @deprecated (undocumented)
    static load(context: IFluidDataStoreContext, sharedObjectRegistry: ISharedObjectRegistry, existing: boolean): FluidDataStoreRuntime;
    // (undocumented)
    get logger(): ITelemetryLogger;
    makeVisibleAndAttachGraph(): void;
    // (undocumented)
    get objectsRoutingContext(): this;
    // (undocumented)
    readonly options: ILoaderOptions;
    // (undocumented)
    process(message: ISequencedDocumentMessage, local: boolean, localOpMetadata: unknown): void;
    // (undocumented)
    processSignal(message: IInboundSignalMessage, local: boolean): void;
    // (undocumented)
    request(request: IRequest): Promise<IResponse>;
    // (undocumented)
    resolveHandle(request: IRequest): Promise<IResponse>;
    reSubmit(type: DataStoreMessageType, content: any, localOpMetadata: unknown): void;
    rollback?(type: DataStoreMessageType, content: any, localOpMetadata: unknown): void;
    // (undocumented)
    get rootRoutingContext(): this;
    // (undocumented)
    get routeContext(): IFluidHandleContext;
    // (undocumented)
    setConnectionState(connected: boolean, clientId?: string): void;
    // (undocumented)
    submitMessage(type: DataStoreMessageType, content: any, localOpMetadata: unknown): void;
    // (undocumented)
    submitSignal(type: string, content: any): void;
    summarize(fullTree?: boolean, trackState?: boolean, telemetryContext?: ITelemetryContext): Promise<ISummaryTreeWithStats>;
    updateUsedRoutes(usedRoutes: string[]): void;
    // (undocumented)
    uploadBlob(blob: ArrayBufferLike): Promise<IFluidHandle<ArrayBufferLike>>;
    // (undocumented)
    visibilityState: VisibilityState_2;
    waitAttached(): Promise<void>;
}

// @public
export class FluidObjectHandle<T extends FluidObject = FluidObject> implements IFluidHandle {
    constructor(value: T | Promise<T>, path: string, routeContext: IFluidHandleContext);
    // (undocumented)
    readonly absolutePath: string;
    // (undocumented)
    attachGraph(): void;
    // (undocumented)
    bind(handle: IFluidHandle): void;
    // (undocumented)
    get(): Promise<any>;
    // (undocumented)
    get IFluidHandle(): IFluidHandle;
    // (undocumented)
    get isAttached(): boolean;
    // (undocumented)
    readonly path: string;
    // (undocumented)
    readonly routeContext: IFluidHandleContext;
    // (undocumented)
    protected readonly value: T | Promise<T>;
}

// @public (undocumented)
export interface ISharedObjectRegistry {
    // (undocumented)
    get(name: string): IChannelFactory | undefined;
}

// @public
export const mixinRequestHandler: (requestHandler: (request: IRequest, runtime: FluidDataStoreRuntime) => Promise<IResponse>, Base?: typeof FluidDataStoreRuntime) => typeof FluidDataStoreRuntime;

// @public
export const mixinSummaryHandler: (handler: (runtime: FluidDataStoreRuntime) => Promise<{
    path: string[];
    content: string;
} | undefined>, Base?: typeof FluidDataStoreRuntime) => typeof FluidDataStoreRuntime;

// (No @packageDocumentation comment for this package)