djs-systems
Version:
The simplest way to build complex Discord bots.
21 lines (20 loc) • 772 B
TypeScript
/**
* **Documentation Url** of the options: https://simplyd.js.org/docs/general/connect#connectoptions
*/
export declare type connectOptions = {
strict?: boolean;
notify?: boolean;
};
/**
* Connect to a mongo database to access some of the simply-djs functions ! *Requires* [MongoDB](https://mongodb.com/)
*
* @param db - The MongoDB URI string that is used to connect to the database.
* @param options
*
* @returns A Promise that resolves to a boolean value indicating whether the database connection was
* successful or not.
*
* @link `Documentation:` https://simplyd.js.org/docs/general/connect
* @example simplydjs.connect('mongoURI')
*/
export declare function connect(db: string, options?: connectOptions): Promise<boolean>;