Skip to content

Commit

Permalink
feat(): add comments to the typeorm module options
Browse files Browse the repository at this point in the history
  • Loading branch information
kamilmysliwiec committed Feb 11, 2020
1 parent 3b9fa8f commit eeb51c1
Showing 1 changed file with 15 additions and 1 deletion.
16 changes: 15 additions & 1 deletion lib/interfaces/typeorm-options.interface.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,24 @@ import { ModuleMetadata } from '@nestjs/common/interfaces';
import { ConnectionOptions } from 'typeorm';

export type TypeOrmModuleOptions = {
/**
* Number of times to retry connecting
* Default: `0`
*/
retryAttempts?: number;
/**
* Delay between connection retry attempts (ms)
* Default: `0`
*/
retryDelay?: number;
keepConnectionAlive?: boolean;
/**
* If `true`, entities will be loaded automatically.
*/
autoLoadEntities?: boolean;
/**
* If `true`, connection will not be closed on application shutdown.
*/
keepConnectionAlive?: boolean;
} & Partial<ConnectionOptions>;

export interface TypeOrmOptionsFactory {
Expand Down

0 comments on commit eeb51c1

Please sign in to comment.