Interface CreateDatabaseTestHarnessOptions<Database, Ctx>

Options for creating a database test harness.

interface CreateDatabaseTestHarnessOptions<Database, Ctx> {
    factories?: readonly Pick<
        FactoryDef<string, object, unknown, object>,
        "resetSequence",
    >[];
    seeds?: readonly SeedDef<Ctx, string>[];
    close?(database: Database): MaybePromise<void>;
    create(): MaybePromise<Database>;
    ctx(database: Database): Ctx;
    reset?(database: Database): MaybePromise<void>;
}

Type Parameters

Database
Ctx

Index

Properties

factories? seeds?

Methods

close? create ctx reset?

Properties

`Optional`factories

factories?: readonly Pick<
FactoryDef<string, object, unknown, object>,
"resetSequence",
>[]

Factories whose sequences should reset before each setup and reset.

`Optional`seeds

seeds?: readonly SeedDef<Ctx, string>[]

Default seeds available to setup({ seed: true }) and session.runSeeds().

Methods

`Optional`close

close?(database: Database): MaybePromise<void>
Close and dispose the database fixture.
Parameters
- database: Database
Returns MaybePromise<void>
- Defined in packages/core/src/testing/index.ts:1284

create

create(): MaybePromise<Database>
Create an isolated app-owned database fixture.

Returns MaybePromise<Database>
- Defined in packages/core/src/testing/index.ts:1272

ctx

ctx(database: Database): Ctx
Build the context passed to factories and seeds from the database fixture.
Parameters
- database: Database
Returns Ctx
- Defined in packages/core/src/testing/index.ts:1276

`Optional`reset

reset?(database: Database): MaybePromise<void>
Reset the database fixture, when supported by the app.
Parameters
- database: Database
Returns MaybePromise<void>
- Defined in packages/core/src/testing/index.ts:1280