Skip to content

@joakimbugge/typeorm-seeder


@joakimbugge/typeorm-seeder / seed

Function: seed() ​

Call Signature ​

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

Defined in: packages/typeorm-seeder/src/seed/builder.ts:35

Returns a SingleSeed builder for the given entity class.

Type Parameters ​

T ​

T extends object

Parameters ​

EntityClass ​

EntityConstructor<T>

Returns ​

SingleSeed<T>

Examples ​

ts
// Create one Author in memory (no DB)
const author = await seed(Author).create()
ts
// Persist one Author with all its seeded relations
const author = await seed(Author).save({ dataSource })
ts
// Persist 10 Authors
const authors = await seed(Author).saveMany(10, { dataSource })

Call Signature ​

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

Defined in: packages/typeorm-seeder/src/seed/builder.ts:45

Returns a MultiSeed builder for the given entity classes. Relation seeding is disabled by default; pass relations: true in the context to enable it.

Type Parameters ​

T ​

T extends EntityConstructor[]

Parameters ​

EntityClasses ​

[...T[]]

Returns ​

MultiSeed<T>

Example ​

ts
// Create multiple entity classes at once (relations disabled by default)
const [user, post] = await seed([User, Post]).create()

Released under the MIT License.