Interface SeedDef<Ctx, Name>

Declared seed that can be run with runSeeds(...).

interface SeedDef<Ctx = unknown, Name extends string = string> {
    description?: string;
    kind: "seed";
    name: Name;
    run(ctx: Ctx): MaybePromise<void>;
}

Type Parameters

Ctx = unknown
Name extends string = string

Index

Properties

description? kind name

Methods

Properties

`Optional` `Readonly`description

description?: string

Optional human-readable seed description.

`Readonly`kind

kind: "seed"

Discriminator for seed definitions.

`Readonly`name

name: Name

Seed name.

Methods

run

run(ctx: Ctx): MaybePromise<void>
Execute the seed.
Parameters
- ctx: Ctx
Returns MaybePromise<void>
- Defined in packages/core/src/testing/index.ts:161