@sigiljs-community/mongo-plugin
Version:
Plugin for SigilJS framework that provides MongoDB interactions
26 lines (25 loc) • 857 B
TypeScript
import { SigilPlugin } from '@sigiljs/sigil';
import { MongoClientOptions } from 'mongodb';
import { default as MongoController } from './mongo-controller';
export interface MongoPluginConfig {
/** MongoDB connection URI */
connectUri: string;
/** MongoDB client options */
clientOptions?: MongoClientOptions;
}
/**
* Plugin for SigilJS framework that provides MongoDB interactions
*/
export default class MongoPlugin extends SigilPlugin<MongoPluginConfig> {
#private;
static name: string;
constructor();
onInitialize(): Promise<void>;
/**
* Create new instance of the MongoDB controller for specific database
*
* @param {string} databaseName name of the database
* @returns {MongoController} instance of the MongoDB controller
*/
createController(databaseName: string): MongoController;
}