FluidFramework/api-report/request-handler.api.md

1.8 KiB

API Report File for "@fluidframework/request-handler"

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


import { FluidObject } from '@fluidframework/core-interfaces';
import { IContainerRuntime } from '@fluidframework/container-runtime-definitions';
import { IContainerRuntimeBase } from '@fluidframework/runtime-definitions';
import { IFluidHandle } from '@fluidframework/core-interfaces';
import { IFluidLoadable } from '@fluidframework/core-interfaces';
import { IRequest } from '@fluidframework/core-interfaces';
import { IResponse } from '@fluidframework/core-interfaces';
import { RequestParser } from '@fluidframework/runtime-utils';

// @public (undocumented)
export function buildRuntimeRequestHandler(...handlers: RuntimeRequestHandler[]): (request: IRequest, runtime: IContainerRuntime) => Promise<IResponse>;

// @public (undocumented)
export const createFluidObjectResponse: (fluidObject: FluidObject) => {
    status: 200;
    mimeType: "fluid/object";
    value: FluidObject;
};

// @public (undocumented)
export function handleFromLegacyUri<T = FluidObject & IFluidLoadable>(uri: string, runtime: IContainerRuntimeBase): IFluidHandle<T>;

// @public
export const rootDataStoreRequestHandler: (request: IRequest, runtime: IContainerRuntime) => Promise<IResponse | undefined>;

// @public
export type RuntimeRequestHandler = (request: RequestParser, runtime: IContainerRuntime) => Promise<IResponse | undefined>;

// @public
export class RuntimeRequestHandlerBuilder {
    // (undocumented)
    handleRequest(request: IRequest, runtime: IContainerRuntime): Promise<IResponse>;
    // (undocumented)
    pushHandler(...handlers: RuntimeRequestHandler[]): void;
}


// (No @packageDocumentation comment for this package)