FluidFramework/api-report/container-runtime-definitions.api.md

API Report File for "@fluidframework/container-runtime-definitions"

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 { FlushMode } from '@fluidframework/runtime-definitions';
import { IClientDetails } from '@fluidframework/protocol-definitions';
import { IContainerRuntimeBase } from '@fluidframework/runtime-definitions';
import { IContainerRuntimeBaseEvents } from '@fluidframework/runtime-definitions';
import { IDataStore } from '@fluidframework/runtime-definitions';
import { IDeltaManager } from '@fluidframework/container-definitions';
import { IDocumentMessage } from '@fluidframework/protocol-definitions';
import { IDocumentStorageService } from '@fluidframework/driver-definitions';
import { IEventProvider } from '@fluidframework/common-definitions';
import { IFluidDataStoreContextDetached } from '@fluidframework/runtime-definitions';
import { IFluidRouter } from '@fluidframework/core-interfaces';
import { IHelpMessage } from '@fluidframework/protocol-definitions';
import { ILoaderOptions } from '@fluidframework/container-definitions';
import { IProvideFluidDataStoreRegistry } from '@fluidframework/runtime-definitions';
import { IRequest } from '@fluidframework/core-interfaces';
import { IResponse } from '@fluidframework/core-interfaces';
import { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';

// @public @deprecated (undocumented)
export const IContainerRuntime: keyof IProvideContainerRuntime;

// @public (undocumented)
export interface IContainerRuntime extends IProvideContainerRuntime, IProvideFluidDataStoreRegistry, IContainerRuntimeBaseWithCombinedEvents {
    readonly attachState: AttachState;
    // (undocumented)
    readonly clientDetails: IClientDetails;
    // (undocumented)
    readonly clientId: string | undefined;
    // (undocumented)
    readonly connected: boolean;
    createDetachedRootDataStore(pkg: Readonly<string[]>, rootDataStoreId: string): IFluidDataStoreContextDetached;
    // (undocumented)
    readonly deltaManager: IDeltaManager<ISequencedDocumentMessage, IDocumentMessage>;
    // (undocumented)
    readonly flushMode: FlushMode;
    getAbsoluteUrl(relativeUrl: string): Promise<string | undefined>;
    getRootDataStore(id: string, wait?: boolean): Promise<IFluidRouter>;
    readonly isDirty: boolean;
    // (undocumented)
    readonly options: ILoaderOptions;
    resolveHandle(request: IRequest): Promise<IResponse>;
    // (undocumented)
    readonly scope: FluidObject;
    // (undocumented)
    readonly storage: IDocumentStorageService;
}

// @public (undocumented)
export type IContainerRuntimeBaseWithCombinedEvents = IContainerRuntimeBase & IEventProvider<IContainerRuntimeEvents>;

// @public (undocumented)
export interface IContainerRuntimeEvents extends IContainerRuntimeBaseEvents {
    // (undocumented)
    (event: "dirty" | "disconnected" | "dispose" | "saved" | "attached", listener: () => void): any;
    // (undocumented)
    (event: "connected", listener: (clientId: string) => void): any;
    // (undocumented)
    (event: "localHelp", listener: (message: IHelpMessage) => void): any;
}

// @public @deprecated (undocumented)
export interface IDataStoreWithBindToContext_Deprecated extends IDataStore {
    // (undocumented)
    fluidDataStoreChannel?: {
        bindToContext?(): void;
    };
}

// @public @deprecated (undocumented)
export interface IProvideContainerRuntime {
    // @deprecated (undocumented)
    IContainerRuntime: IContainerRuntime;
}

// (No @packageDocumentation comment for this package)