Skip to content

@joakimbugge/seeder


@joakimbugge/seeder / SingleSeed

Interface: SingleSeed<T, TContext>

Defined in: packages/seeder/src/seed/builder/makeSeedBuilder.ts:16

Seed builder for a single entity class. Returned by ORM seed() functions when passed one class.

TContext is the ORM-specific context type that carries the connection required for persistence (e.g. { dataSource: DataSource } for TypeORM).

Type Parameters

T

T extends EntityInstance

TContext

TContext extends SeedContext = SeedContext

Methods

create()

ts
create(options?): Promise<T>;

Defined in: packages/seeder/src/seed/builder/makeSeedBuilder.ts:18

Creates a single instance in memory without persisting.

Parameters

options?

CreateOptions<T>

Returns

Promise<T>


createMany()

ts
createMany(count, options?): Promise<T[]>;

Defined in: packages/seeder/src/seed/builder/makeSeedBuilder.ts:20

Creates multiple instances in memory without persisting.

Parameters

count

number

options?

CreateOptions<T>

Returns

Promise<T[]>


save()

ts
save(options): Promise<T>;

Defined in: packages/seeder/src/seed/builder/makeSeedBuilder.ts:22

Creates and persists a single instance.

Parameters

options

TContext & object

Returns

Promise<T>


saveMany()

ts
saveMany(count, options): Promise<T[]>;

Defined in: packages/seeder/src/seed/builder/makeSeedBuilder.ts:24

Creates and persists multiple instances.

Parameters

count

number

options

TContext & object

Returns

Promise<T[]>

Released under the MIT License.