ITestObjectProvider Interface

Packages > @fluidframework/test-utils > ITestObjectProvider

Signature:

export interface ITestObjectProvider 

Properties

List of properties of this interface
Property Type Description
defaultCodeDetails IFluidCodeDetails
documentId string
documentServiceFactory IDocumentServiceFactory
driver ITestDriver
opProcessingController IOpProcessingController
urlResolver IUrlResolver

Methods

List of methods of this class
Method Description
createContainer(entryPoint, options)
createLoader(packageEntries, options)
ensureSynchronized()
loadContainer(entryPoint, options, requestHeader)
loadTestContainer(testContainerConfig)
makeTestContainer(testContainerConfig)
makeTestLoader(testContainerConfig) Used to create a test Container. The Loader/ContainerRuntime/DataRuntime might be different versioned. In generateLocalCompatTest(), this Container and its runtime will be arbitrarily-versioned.
reset()

Events

defaultCodeDetails

Signature:

defaultCodeDetails: IFluidCodeDetails;

documentId

Signature:

documentId: string;

documentServiceFactory

Signature:

documentServiceFactory: IDocumentServiceFactory;

driver

Signature:

driver: ITestDriver;

opProcessingController

Signature:

opProcessingController: IOpProcessingController;

urlResolver

Signature:

urlResolver: IUrlResolver;

Methods

createContainer

Signature:

createContainer(entryPoint: fluidEntryPoint, options?: ILoaderOptions): Promise<IContainer>;

Parameters

List of parameters
Parameter Type Description
entryPoint fluidEntryPoint
options ILoaderOptions

Returns:

Promise<IContainer>

createLoader

Signature:

createLoader(packageEntries: Iterable<[IFluidCodeDetails, fluidEntryPoint]>, options?: ILoaderOptions): IHostLoader;

Parameters

List of parameters
Parameter Type Description
packageEntries Iterable<[IFluidCodeDetails, fluidEntryPoint]>
options ILoaderOptions

Returns:

IHostLoader

ensureSynchronized

Signature:

ensureSynchronized(): Promise<void>;

Returns:

Promise<void>

loadContainer

Signature:

loadContainer(entryPoint: fluidEntryPoint, options?: ILoaderOptions, requestHeader?: IRequestHeader): Promise<IContainer>;

Parameters

List of parameters
Parameter Type Description
entryPoint fluidEntryPoint
options ILoaderOptions
requestHeader IRequestHeader

Returns:

Promise<IContainer>

loadTestContainer

Signature:

loadTestContainer(testContainerConfig?: ITestContainerConfig): Promise<IContainer>;

Parameters

List of parameters
Parameter Type Description
testContainerConfig ITestContainerConfig

Returns:

Promise<IContainer>

makeTestContainer

Signature:

makeTestContainer(testContainerConfig?: ITestContainerConfig): Promise<IContainer>;

Parameters

List of parameters
Parameter Type Description
testContainerConfig ITestContainerConfig

Returns:

Promise<IContainer>

makeTestLoader

Used to create a test Container. The Loader/ContainerRuntime/DataRuntime might be different versioned. In generateLocalCompatTest(), this Container and its runtime will be arbitrarily-versioned.

Signature:

makeTestLoader(testContainerConfig?: ITestContainerConfig): IHostLoader;

Parameters

List of parameters
Parameter Type Description
testContainerConfig ITestContainerConfig

Returns:

IHostLoader

reset

Signature:

reset(): void;

Returns:

void