Seeding

runSeeder

declare function runSeeder(
    dataSource: DataSource, 
    seeder: SeederConstructor, 
    options: SeederOptions
) : Promise<vod>;

Populate the database with a specific seeder.

Example: Simple

import { DataSource } from 'typeorm';
import { runSeeder, Seeder, SeederFactoryManager } from 'typeorm-extension';

class SimpleSeeder implements Seeder {
    public async run(
        dataSource: DataSource,
        factoryManager: SeederFactoryManager
    ): Promise<void> {
        // ...
    }
}

(async () => {
    const dataSource = new DataSource({
        // ...
    });
    await dataSource.initialize();

    await runSeeder(dataSource, SimpleSeeder);
})();

Example: SeederOptions

import { DataSource } from 'typeorm';
import { runSeeder, Seeder, SeederFactoryManager } from 'typeorm-extension';

class SimpleSeeder implements Seeder {
    public async run(
        dataSource: DataSource,
        factoryManager: SeederFactoryManager
    ): Promise<void> {
        // ...
    }
}

(async () => {
    const dataSource = new DataSource({
        // ...
    });
    await dataSource.initialize();

    await runSeeder(dataSource, SimpleSeeder, {
        factories: ['src/database/factories/*{.ts,.js}']
    });
})();

Parameters

Name	Type	Description
dataSource	DataSource	Typeorm DataSource Object
seeder	SeederConstructor	A class which implements the Seeder Interface.
options	SeederOptions	Seeding options to provide or overwrite the default ones. Details

Returns

Promise<void>

References

• SeederConstructor
• SeederOptions

runSeeders

declare function runSeeders(
    dataSource: DataSource, 
    options: SeederOptions
) : Promise<void>;

Populate the database.

Example: Simple

import { DataSource } from 'typeorm';
import { runSeeders } from 'typeorm-extension';

(async () => {
    const dataSource = new DataSource({
        // ...
    });
    await dataSource.initialize();

    await runSeeders(dataSource);
})();

Example: SeederOptions

import { DataSource } from 'typeorm';
import { runSeeders } from 'typeorm-extension';

(async () => {
    const dataSource = new DataSource({
        // ...
    });
    await dataSource.initialize();

    await runSeeders(dataSource, {
        seeds: ['src/database/seeds/*{.ts,.js}'],
        factories: ['src/database/factories/*{.ts,.js}']
    });
})();

Parameters

Name	Type	Description
dataSource	DataSource	Typeorm DataSource Object
options	SeederOptions	Seeding options to provide or overwrite the default ones. Details

Returns

Promise<void>

References

• SeederOptions

Seeder

import { DataSource } from 'typeorm';
import { SeederFactoryManager } from 'typeorm-extension';

interface Seeder {
    run(dataSource: DataSource, factoryManager: SeederFactoryManager) : Promise<void>;
}

SeederConstructor

import { Seeder } from 'typeorm-extension';

type SeederConstructor = new () => Seeder;

SeederOptions

import { SeederConstructor, SeederFactoryConfig } from 'typeorm-extension';

export type SeederOptions = {
    seeds?: SeederConstructor[] | string[],
    seedName?: string,

    factories?: SeederFactoryConfig[] | string[],
    factoriesLoad?: boolean
};