Skip to content

@joakimbugge/mikroorm-seeder


@joakimbugge/mikroorm-seeder / seed

Function: seed()

Call Signature

ts
function seed<T>(EntityClass): SingleSeed<T>;

Defined in: seed/builder.ts:65

Entry point for creating and persisting seed data.

Pass a single entity class to get a SingleSeed builder, or an array of classes to get a MultiSeed builder that operates on all of them at once.

Type Parameters

T

T extends object

Parameters

EntityClass

EntityConstructor<T>

Returns

SingleSeed<T>

Examples

ts
// Create one Director in memory (no DB)
const director = await seed(Director).create()
ts
// Persist one Director with all its seeded relations
const director = await seed(Director).save({ em })
ts
// Persist 10 Directors
const directors = await seed(Director).saveMany(10, { em })
ts
// Create multiple entity classes at once (relations disabled by default)
const [user, post] = await seed([User, Post]).create()

Call Signature

ts
function seed<T>(EntityClasses): MultiSeed<T>;

Defined in: seed/builder.ts:66

Entry point for creating and persisting seed data.

Pass a single entity class to get a SingleSeed builder, or an array of classes to get a MultiSeed builder that operates on all of them at once.

Type Parameters

T

T extends readonly EntityConstructor[]

Parameters

EntityClasses

[...T[]]

Returns

MultiSeed<T>

Examples

ts
// Create one Director in memory (no DB)
const director = await seed(Director).create()
ts
// Persist one Director with all its seeded relations
const director = await seed(Director).save({ em })
ts
// Persist 10 Directors
const directors = await seed(Director).saveMany(10, { em })
ts
// Create multiple entity classes at once (relations disabled by default)
const [user, post] = await seed([User, Post]).create()

Released under the MIT License.