data-object-base.api.md

API Report File for "@fluidframework/data-object-base"

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

import { ContainerRuntime } from '@fluidframework/container-runtime';
import { EventForwarder } from '@fluidframework/common-utils';
import { FluidDataStoreRuntime } from '@fluidframework/datastore';
import { FluidObject } from '@fluidframework/core-interfaces';
import { IChannelFactory } from '@fluidframework/datastore-definitions';
import { IContainerContext } from '@fluidframework/container-definitions';
import { IEvent } from '@fluidframework/common-definitions';
import { IFluidDataStoreContext } from '@fluidframework/runtime-definitions';
import { IFluidDataStoreFactory } from '@fluidframework/runtime-definitions';
import { IFluidDataStoreRegistry } from '@fluidframework/runtime-definitions';
import { IFluidDataStoreRuntime } from '@fluidframework/datastore-definitions';
import { IFluidHandle } from '@fluidframework/core-interfaces';
import { IFluidLoadable } from '@fluidframework/core-interfaces';
import { IFluidRouter } from '@fluidframework/core-interfaces';
import { IProvideFluidHandle } from '@fluidframework/core-interfaces';
import { IRequest } from '@fluidframework/core-interfaces';
import { IResponse } from '@fluidframework/core-interfaces';
import { ISharedObject } from '@fluidframework/shared-object-base';
import { ISharedObjectRegistry } from '@fluidframework/datastore';
import { RuntimeFactoryHelper } from '@fluidframework/runtime-utils';
import { RuntimeRequestHandler } from '@fluidframework/request-handler';

// @public (undocumented)
export abstract class LazyLoadedDataObject<TRoot extends ISharedObject = ISharedObject, TEvents extends IEvent = IEvent> extends EventForwarder<TEvents> implements IFluidLoadable, IProvideFluidHandle, IFluidRouter {
    constructor(context: IFluidDataStoreContext, runtime: IFluidDataStoreRuntime, root: ISharedObject);
    // (undocumented)
    protected readonly context: IFluidDataStoreContext;
    // (undocumented)
    abstract create(props?: any): any;
    // (undocumented)
    get handle(): IFluidHandle<this>;
    // (undocumented)
    get IFluidHandle(): IFluidHandle<this>;
    // (undocumented)
    get IFluidLoadable(): this;
    // (undocumented)
    get IFluidRouter(): this;
    // (undocumented)
    get IProvideFluidHandle(): this;
    // (undocumented)
    abstract load(context: IFluidDataStoreContext, runtime: IFluidDataStoreRuntime, existing: boolean): Promise<void>;
    // (undocumented)
    request(r: IRequest): Promise<IResponse>;
    // (undocumented)
    protected readonly root: TRoot;
    // (undocumented)
    protected readonly runtime: IFluidDataStoreRuntime;
}

// @public (undocumented)
export class LazyLoadedDataObjectFactory<T extends LazyLoadedDataObject> implements IFluidDataStoreFactory {
    constructor(type: string, ctor: new (context: IFluidDataStoreContext, runtime: IFluidDataStoreRuntime, root: ISharedObject) => T, root: IChannelFactory, sharedObjects?: readonly IChannelFactory[], storeFactories?: readonly IFluidDataStoreFactory[]);
    // (undocumented)
    create(parentContext: IFluidDataStoreContext, props?: any): Promise<FluidObject>;
    // (undocumented)
    get IFluidDataStoreFactory(): this;
    // (undocumented)
    readonly IFluidDataStoreRegistry: IFluidDataStoreRegistry | undefined;
    // (undocumented)
    instantiateDataStore(context: IFluidDataStoreContext, existing: boolean): Promise<FluidDataStoreRuntime>;
    // (undocumented)
    readonly ISharedObjectRegistry: ISharedObjectRegistry;
    // (undocumented)
    readonly root: IChannelFactory;
    // (undocumented)
    readonly type: string;
}

// @public (undocumented)
export class RuntimeFactory extends RuntimeFactoryHelper {
    constructor(defaultStoreFactory: IFluidDataStoreFactory, storeFactories?: IFluidDataStoreFactory[], requestHandlers?: RuntimeRequestHandler[]);
    // (undocumented)
    instantiateFirstTime(runtime: ContainerRuntime): Promise<void>;
    // (undocumented)
    preInitialize(context: IContainerContext, existing: boolean): Promise<ContainerRuntime>;
    }