@joakimbugge/nest-typeorm-seeder

---

@joakimbugge/nest-typeorm-seeder / SeederModuleSeedersOptions

Interface: SeederModuleSeedersOptions

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

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?: string;

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

Name of the table used to track which seeders have run.

Default

'seeders'

---

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

---

onBefore?

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

Defined in: seeder/src/seeder/runner.ts:32

Called once before any seeder runs.

Returns

void | Promise<void>

Inherited from

SeederModuleBaseOptions.onBefore

---

onError?

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

Defined in: seeder/src/seeder/runner.ts:39

Called when a seeder throws, with the failing seeder and the error. The error is re-thrown after this returns.

Parameters

seeder

SeederCtor

error

unknown

Returns

void | Promise<void>

Inherited from

SeederModuleBaseOptions.onError

---

onFinally?

optional onFinally?: (durationMs) => void | Promise<void>;

Defined in: seeder/src/seeder/runner.ts:41

Always called once after all seeders finish — whether all succeeded or one threw.

Parameters

durationMs

number

Returns

void | Promise<void>

Inherited from

SeederModuleBaseOptions.onFinally

---

onSuccess?

optional onSuccess?: (seeders, durationMs) => void | Promise<void>;

Defined in: seeder/src/seeder/runner.ts:37

Called once after all seeders complete successfully. Receives the list of seeders that ran (excluding skipped ones) and the total duration.

Parameters

seeders

SeederCtor<unknown>[]

durationMs

number

Returns

void | Promise<void>

Inherited from

SeederModuleBaseOptions.onSuccess

---

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?

optional run?: RunCallback;

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

Inline callback executed after all seeders have run. Always executes on every boot — runOnce does not apply to it.

---

runOnce?

optional runOnce?: boolean;

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

Track executed seeders in a database table and skip them on subsequent boots. Set to false to always run every seeder regardless.

When TypeORM's dropSchema is true, the history table is dropped with the rest of the schema on every start, so all seeders run regardless of this setting.

Default

true

---

seeders

seeders: (string | SeederCtor)[];

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

Seeder classes or glob patterns resolving to seeder files. Transitive dependencies are resolved automatically.