Interface TestContextType<R>

TestContext provides a complete test environment with mocked services.

interface TestContextType<R extends Type> {
    clock: TestClockType;
    context: ContextType<R>;
    run<E extends unknown, A extends unknown>(
        effect: IOType<R, E, A>,
    ): Promise<A>;
    withService<S extends unknown>(
        tag: TagType<S>,
        service: S,
    ): TestContextType<R & S>;
}

Type Parameters

R extends Type

Index

Properties

Methods

run withService

Properties

`Readonly`clock

clock: TestClockType

The TestClock for controlling time

`Readonly`context

context: ContextType<R>

The context containing test services

Methods

run

run<E extends unknown, A extends unknown>(effect: IOType<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: IOType<R, E, A>
Returns Promise<A>

withService

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