UNPKG

1.95 kBTypeScriptView Raw
1import { SeederCollection, DeepPartial } from './common';
2import { SeederDatabaseConfig } from './database';
3import { CollectionInsertManyOptions, MongoClientOptions } from 'mongodb';
4import { EJSON } from 'bson';
5/**
6 * Defines configuration for database seeding.
7 */
8export interface SeederConfig {
9 database: SeederDatabaseConfig;
10 databaseReconnectTimeout: number;
11 dropDatabase: boolean;
12 dropCollections: boolean;
13 removeAllDocuments: boolean;
14 mongoClientOptions?: MongoClientOptions;
15 collectionInsertManyOptions?: CollectionInsertManyOptions;
16}
17/**
18 * Stores default configuration for database seeding.
19 */
20export declare const defaultSeederConfig: SeederConfig;
21/**
22 * Merges configuration for database seeding.
23 *
24 * @param partial Partial config object. If not specified, returns a default config object.
25 * @param previous Previous config object. If not specified, uses a default config object as a base.
26 */
27export declare const mergeSeederConfig: (partial?: DeepPartial<SeederConfig> | undefined, previous?: SeederConfig | undefined) => SeederConfig;
28/**
29 * Defines collection reading configuration.
30 */
31export interface SeederCollectionReadingOptions {
32 extensions: string[];
33 ejsonParseOptions?: EJSON.Options;
34 transformers: Array<(collection: SeederCollection) => SeederCollection>;
35}
36/**
37 * Stores default collection reading configuration values.
38 */
39export declare const defaultCollectionReadingOptions: SeederCollectionReadingOptions;
40/**
41 * Merges configuration for collection reading.
42 *
43 * @param partial Partial config object. If not specified, returns a default config object.
44 * @param previous Previous config object. If not specified, uses a default config object as a base.
45 */
46export declare const mergeCollectionReadingOptions: (partial?: DeepPartial<SeederCollectionReadingOptions> | undefined, previous?: SeederCollectionReadingOptions | undefined) => SeederCollectionReadingOptions;