Skip to content

@joakimbugge/nest-mikroorm-seeder


@joakimbugge/nest-mikroorm-seeder / SeederModuleRunOptions

Interface: SeederModuleRunOptions

Defined in: nest-mikroorm-seeder/src/SeederModule.ts:66

Extends

  • SeederModuleBaseOptions

Properties

em?

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

Defined in: nest-mikroorm-seeder/src/SeederModule.ts:25

Explicit EntityManager. When omitted, the module resolves MikroORM from the NestJS container and forks a fresh EntityManager.

Inherited from

ts
SeederModuleBaseOptions.em

enabled?

ts
optional enabled?: boolean;

Defined in: nest-mikroorm-seeder/src/SeederModule.ts:33

When false, seeding is skipped entirely. Useful for gating on an env var.

Default

ts
true

Inherited from

ts
SeederModuleBaseOptions.enabled

historyTableName?

ts
optional historyTableName?: undefined;

Defined in: nest-mikroorm-seeder/src/SeederModule.ts:73


logging?

ts
optional logging?: boolean;

Defined in: nest-mikroorm-seeder/src/SeederModule.ts:40

When false, suppresses all seeder progress output. When true (default), logs via NestJS's own Logger — output follows NestJS's logging configuration.

Default

ts
true

Inherited from

ts
SeederModuleBaseOptions.logging

onAfter?

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

Defined in: mikroorm-seeder/src/seeder/runner.ts:29

Parameters

seeder

SeederCtor

durationMs

number

Returns

void | Promise<void>

Inherited from

ts
SeederModuleBaseOptions.onAfter

onBefore?

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

Defined in: mikroorm-seeder/src/seeder/runner.ts:28

Parameters

seeder

SeederCtor

Returns

void | Promise<void>

Inherited from

ts
SeederModuleBaseOptions.onBefore

onError?

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

Defined in: mikroorm-seeder/src/seeder/runner.ts:30

Parameters

seeder

SeederCtor

error

unknown

Returns

void | Promise<void>

Inherited from

ts
SeederModuleBaseOptions.onError

relations?

ts
optional relations?: boolean;

Defined in: nest-mikroorm-seeder/src/SeederModule.ts:27

Passed through to runSeeders. Set to false to skip relation seeding.

Inherited from

ts
SeederModuleBaseOptions.relations

run

ts
run: RunCallback;

Defined in: nest-mikroorm-seeder/src/SeederModule.ts:71

Inline callback executed on every boot. runOnce is false.


runOnce?

ts
optional runOnce?: false;

Defined in: nest-mikroorm-seeder/src/SeederModule.ts:72


seeders?

ts
optional seeders?: undefined;

Defined in: nest-mikroorm-seeder/src/SeederModule.ts:67

Released under the MIT License.