Class ServiceFactoryTester<TService, TScope, TInstances>

A utility to help test service factories in isolation.

Type Parameters

TService
TScope extends "root" | "plugin"
TInstances extends "singleton" | "multiton" = "singleton"

Index

Methods

getService getSubject from

Methods

getService

getService<
    TGetService,
    TGetScope extends "plugin" | "root",
    TGetInstances extends "singleton" | "multiton" = "singleton",
>(
    service: ServiceRef<TGetService, TGetScope, TGetInstances>,
    ...args: "root" extends TGetScope ? [] : [pluginId?: string],
): Promise<TGetInstances extends "multiton" ? TGetService[] : TGetService>
Return the service instance for any of the provided dependencies or built-in services.
Type Parameters
- TGetService
- TGetScope extends "plugin" | "root"
- TGetInstances extends "singleton" | "multiton" = "singleton"
Parameters
- service: ServiceRef<TGetService, TGetScope, TGetInstances>
- ...args: "root" extends TGetScope ? [] : [pluginId?: string]
Returns Promise<TGetInstances extends "multiton" ? TGetService[] : TGetService>
Remarks
A plugin ID can optionally be provided for plugin scoped services, otherwise the plugin ID 'test' is used.
- Defined in packages/backend-test-utils/src/wiring/ServiceFactoryTester.ts:110

getSubject

getSubject(
...args: "root" extends TScope ? [] : [pluginId?: string],
): Promise<TInstances extends "multiton" ? TService[] : TService>
Returns the service instance for the subject.
Parameters
- ...args: "root" extends TScope ? [] : [pluginId?: string]
Returns Promise<TInstances extends "multiton" ? TService[] : TService>
Remarks
If the subject is a plugin scoped service factory a plugin ID can be provided to instantiate the service for a specific plugin.

By default the plugin ID 'test' is used.
- Defined in packages/backend-test-utils/src/wiring/ServiceFactoryTester.ts:95

`Static`from

from<
    TService,
    TScope extends "plugin" | "root",
    TInstances extends "singleton" | "multiton" = "singleton",
>(
    subject: ServiceFactory<TService, TScope, TInstances>,
    options?: ServiceFactoryTesterOptions,
): ServiceFactoryTester<TService, TScope, TInstances>
Creates a new ServiceFactoryTester used to test the provided subject.
Type Parameters
- TService
- TScope extends "plugin" | "root"
- TInstances extends "singleton" | "multiton" = "singleton"
Parameters
- subject: ServiceFactory<TService, TScope, TInstances>
  The service factory to test.
- Optionaloptions: ServiceFactoryTesterOptions
  Additional options
Returns ServiceFactoryTester<TService, TScope, TInstances>
A new tester instance for the provided subject.
- Defined in packages/backend-test-utils/src/wiring/ServiceFactoryTester.ts:61

Class ServiceFactoryTester<TService, TScope, TInstances>

Type Parameters

Index

Methods

Methods

getService

Type Parameters

Parameters

Returns Promise<TGetInstances extends "multiton" ? TGetService[] : TGetService>

Remarks

getSubject

Parameters

Returns Promise<TInstances extends "multiton" ? TService[] : TService>

Remarks

`Static`from

Type Parameters

Parameters

Returns ServiceFactoryTester<TService, TScope, TInstances>

Settings

On This Page

Class ServiceFactoryTester<TService, TScope, TInstances>

Type Parameters

Index

Methods

Methods

getService

Type Parameters

Parameters

Returns Promise<TGetInstances extends "multiton" ? TGetService[] : TGetService>

Remarks

getSubject

Parameters

Returns Promise<TInstances extends "multiton" ? TService[] : TService>

Remarks

Staticfrom

Type Parameters

Parameters

Returns ServiceFactoryTester<TService, TScope, TInstances>

Settings

On This Page

`Static`from