Interface TestContext<R>

TestContext provides a complete test environment with mocked services.

interface TestContext<R extends Type> {
    clock: TestClock;
    context: Context<R>;
    run<E extends unknown, A extends unknown>(effect: IO<R, E, A>): Promise<A>;
    withService<S extends unknown>(tag: Tag<S>, service: S): TestContext<R & S>;
}

Type Parameters

R extends Type

Index

Properties

Methods

run withService

Properties

`Readonly`clock

clock: TestClock

The TestClock for controlling time

`Readonly`context

context: Context<R>

The context containing test services

Methods

run

run<E extends unknown, A extends unknown>(effect: IO<R, E, A>): Promise<A>
Provides the test context to an IO effect and runs it
Type Parameters
- E extends unknown
- A extends unknown
Parameters
- effect: IO<R, E, A>
Returns Promise<A>

withService

withService<S extends unknown>(tag: Tag<S>, service: S): TestContext<R & S>
Adds a service to the test context
Type Parameters
- S extends unknown
Parameters
- tag: Tag<S>
- service: S
Returns TestContext<R & S>