@joakimbugge/nest-typeorm-seeder

---

@joakimbugge/nest-typeorm-seeder / SeederModuleRunOptions

Interface: SeederModuleRunOptions

Defined in: nest-typeorm-seeder/src/SeederModule.ts:70

Extends

• SeederModuleBaseOptions

Properties

dataSource?

optional dataSource?: DataSource;

Defined in: nest-typeorm-seeder/src/SeederModule.ts:26

Explicit DataSource. When omitted, the module resolves the DataSource registered by TypeOrmModule.

Inherited from

SeederModuleBaseOptions.dataSource

---

enabled?

optional enabled?: boolean;

Defined in: nest-typeorm-seeder/src/SeederModule.ts:34

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

Default

true

Inherited from

SeederModuleBaseOptions.enabled

---

historyTableName?

optional historyTableName?: undefined;

Defined in: nest-typeorm-seeder/src/SeederModule.ts:77

---

logging?

optional logging?: boolean;

Defined in: nest-typeorm-seeder/src/SeederModule.ts:41

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

Default

true

Inherited from

SeederModuleBaseOptions.logging

---

onAfter?

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

Defined in: typeorm-seeder/src/seeder/runner.ts:33

Called after each seeder completes successfully, with the time it took in milliseconds.

Parameters

seeder

SeederCtor

durationMs

number

Returns

void | Promise<void>

Inherited from

SeederModuleBaseOptions.onAfter

---

onBefore?

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

Defined in: typeorm-seeder/src/seeder/runner.ts:31

Called before each seeder runs, in execution order.

Parameters

seeder

SeederCtor

Returns

void | Promise<void>

Inherited from

SeederModuleBaseOptions.onBefore

---

onError?

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

Defined in: typeorm-seeder/src/seeder/runner.ts:35

Called when a seeder throws. The error is re-thrown after this callback returns.

Parameters

seeder

SeederCtor

error

unknown

Returns

void | Promise<void>

Inherited from

SeederModuleBaseOptions.onError

---

relations?

optional relations?: boolean;

Defined in: nest-typeorm-seeder/src/SeederModule.ts:28

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

Inherited from

SeederModuleBaseOptions.relations

---

run

run: RunCallback;

Defined in: nest-typeorm-seeder/src/SeederModule.ts:75

Inline callback executed on every boot. runOnce is false.

---

runOnce?

optional runOnce?: false;

Defined in: nest-typeorm-seeder/src/SeederModule.ts:76

---

seeders?

optional seeders?: undefined;

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