@joakimbugge/mikroorm-seeder

---

@joakimbugge/mikroorm-seeder / RunSeedersOptions

Interface: RunSeedersOptions

Defined in: seeder/runner.ts:10

Context passed through a seed operation. Available inside factory callbacks and SeederInterface.run.

Extends

• SeedContext

Properties

em?

optional em?: EntityManager<IDatabaseDriver<Connection>>;

Defined in: seed/registry.ts:15

The MikroORM EntityManager. Automatically set by save/saveMany calls. Also available in factory callbacks — useful for looking up existing entities.

Inherited from

SeedContext.em

---

logger?

optional logger?: SeederLogger;

Defined in: seeder/runner.ts:27

Custom logger used when logging is true. Ignored for other logging values. Defaults to ConsoleLogger when omitted.

---

logging?

optional logging?: boolean | "mikroorm";

Defined in: seeder/runner.ts:22

Controls seeder progress output.

• false (default) — no output.
• true — logs via ConsoleLogger (or a custom SeederLogger if logger is provided).
• 'mikroorm' — delegates to the MikroORM logger on the provided em. Output follows MikroORM's own debug configuration: if MikroORM logging is disabled, seeder output is suppressed too. Silently no-ops when no em is available.

Default

false

---

onAfter?

optional onAfter?: (seeder, durationMs) => void | Promise<void>;

Defined in: seeder/runner.ts:29

Parameters

seeder

SeederCtor

durationMs

number

Returns

void | Promise<void>

---

onBefore?

optional onBefore?: (seeder) => void | Promise<void>;

Defined in: seeder/runner.ts:28

Parameters

seeder

SeederCtor

Returns

void | Promise<void>

---

onError?

optional onError?: (seeder, error) => void | Promise<void>;

Defined in: seeder/runner.ts:30

Parameters

seeder

SeederCtor

error

unknown

Returns

void | Promise<void>

---

relations?

optional relations?: boolean;

Defined in: seed/registry.ts:20

Set to false to skip automatic relation seeding.

Default

true

Inherited from

SeedContext.relations

---

skip?

optional skip?: (seeder) => boolean | Promise<boolean>;

Defined in: seeder/runner.ts:31

Parameters

seeder

SeederCtor

Returns

boolean | Promise<boolean>