@nestjs/typeorm/dist/interfaces/typeorm-options.interface.d.ts

Nest - modern, fast, powerful node.js web framework (@typeorm)

import { ModuleMetadata, Provider, Type } from '@nestjs/common';
import { DataSource, DataSourceOptions } from 'typeorm';
/**
 * @publicApi
 */
export type TypeOrmModuleOptions = {
    /**
     * NestJS-level datasource identifier.
     * In TypeORM 0.3.x this also existed on DataSourceOptions; in 1.0 it was removed.
     */
    name?: string;
    /**
     * Number of times to retry connecting
     * Default: 10
     */
    retryAttempts?: number;
    /**
     * Delay between connection retry attempts (ms)
     * Default: 3000
     */
    retryDelay?: number;
    /**
     * Function that determines whether the module should
     * attempt to connect upon failure.
     *
     * @param err error that was thrown
     * @returns whether to retry connection or not
     */
    toRetry?: (err: any) => boolean;
    /**
     * If `true`, entities will be loaded automatically.
     */
    autoLoadEntities?: boolean;
    /**
     * If `true`, will show verbose error messages on each connection retry.
     */
    verboseRetryLog?: boolean;
    /**
     * If `true` database initialization will not be performed during module initialization.
     * This means that database connection will not be established and migrations will not run.
     * Database initialization will have to be performed manually using `DataSource.initialize`
     * and it will have to implement own retry mechanism (if necessary).
     */
    manualInitialization?: boolean;
} & Partial<DataSourceOptions>;
/**
 * @publicApi
 */
export interface TypeOrmOptionsFactory {
    createTypeOrmOptions(connectionName?: string): Promise<TypeOrmModuleOptions> | TypeOrmModuleOptions;
}
/**
 * @publicApi
 */
export type TypeOrmDataSourceFactory = (options?: DataSourceOptions) => Promise<DataSource>;
/**
 * @publicApi
 */
export interface TypeOrmModuleAsyncOptions extends Pick<ModuleMetadata, 'imports'> {
    name?: string;
    useExisting?: Type<TypeOrmOptionsFactory>;
    useClass?: Type<TypeOrmOptionsFactory>;
    useFactory?: (...args: any[]) => Promise<TypeOrmModuleOptions> | TypeOrmModuleOptions;
    dataSourceFactory?: TypeOrmDataSourceFactory;
    inject?: any[];
    extraProviders?: Provider[];
}