FluidFramework/api-report/test-driver-definitions.api.md

API Report File for "@fluidframework/test-driver-definitions"

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

import { IDocumentServiceFactory } from '@fluidframework/driver-definitions';
import { IRequest } from '@fluidframework/core-interfaces';
import { IResolvedUrl } from '@fluidframework/driver-definitions';
import { ITelemetryBaseLogger } from '@fluidframework/common-definitions';
import { IUrlResolver } from '@fluidframework/driver-definitions';

// @public (undocumented)
export type DriverEndpoint = RouterliciousEndpoint | OdspEndpoint;

// @public
export interface ITelemetryBufferedLogger extends ITelemetryBaseLogger {
    flush(): Promise<void>;
}

// @public (undocumented)
export interface ITestDriver {
    createContainerUrl(testId: string, containerUrl?: IResolvedUrl): Promise<string>;
    createCreateNewRequest(testId?: string): IRequest;
    createDocumentServiceFactory(): IDocumentServiceFactory;
    createUrlResolver(): IUrlResolver;
    readonly endpointName?: string;
    readonly tenantName?: string;
    readonly type: TestDriverTypes;
    readonly userIndex?: number;
    readonly version: string;
}

// @public (undocumented)
export type OdspEndpoint = "odsp" | "odsp-df";

// @public (undocumented)
export type RouterliciousEndpoint = "frs" | "r11s" | "docker";

// @public (undocumented)
export type TestDriverTypes = "tinylicious" | "t9s" | "routerlicious" | "r11s" | "odsp" | "local";

// (No @packageDocumentation comment for this package)