Fix JSDoc's optional params. Thanks @mirao

Author: thiagodp

index.d.ts

@@ -7,92 +7,92 @@ export = DbHelper;
  */
 declare class DbHelper {
 
-    /**
-     * Constructor
-     *
-     * @param {object} config CodeceptJS configuration.
-     */
-    constructor(config: object);
+	/**
+	 * Constructor
+	 *
+	 * @param {object} config CodeceptJS configuration.
+	 */
+	constructor(config: object);
 
-    /**
-     * Connects to the database described by the given connection string.
-     *
-     * @param {string|number}    key    Identification for using in other commands.
-     * @param {string|object}    conn   JDBC-like connection string or a connection object accepted by `database-js`.
-     * @param {object|undefined} driver [OPTIONAL] Driver object, used by `database-js`.
+	/**
+	 * Connects to the database described by the given connection string.
 	 *
-	 * @returns {Connection} DatabaseJS' connection
-     */
-	connect( key: string | number, conn: string | object, driver?: object ): any;
+	 * @param {string|number}    key         Identification for using in other commands.
+	 * @param {string|object}    conn        JDBC-like connection string or a connection object accepted by `database-js`.
+	 * @param {object|undefined} [driver]    [OPTIONAL] Driver object, used by `database-js`.
+	*
+	* @returns {Connection} DatabaseJS' connection
+	 */
+	connect(key: string | number, conn: string | object, driver?: object): any;
 
 
-    /**
-     * Disconnects and removes the database connection identified by the given key.
-     *
-     * @param {string|number} key Database identification key set in connect().
+	/**
+	 * Disconnects and removes the database connection identified by the given key.
 	 *
-	 * @returns {Promise<boolean>} If it was successful.
-     */
-	disconnect( key: string | number ): Promise< boolean >;
+	 * @param {string|number} key Database identification key set in connect().
+	*
+	* @returns {Promise<boolean>} If it was successful.
+	 */
+	disconnect(key: string | number): Promise<boolean>;
 
-    /**
-     * Disconnects and removes the database connection identified by the given key.
-     *
-     * @param {string|number} key Database identification key set in connect().
+	/**
+	 * Disconnects and removes the database connection identified by the given key.
+	 *
+	 * @param {string|number} key Database identification key set in connect().
 	 *
 	 * @returns {Promise<boolean>} If it was successful.
-     */
-	removeConnection( key: string | number ): Promise< boolean >;
-
-    /**
-     * Performs a query.
-     *
-     * @param {string|number}      key     Database identification key set in connect().
-     * @param {string}             command Query to run.
-     * @param {...any[]|undefined} params  [OPTIONAL] Query parameters.
-     *
-     * @returns {Promise<any[]>} Query results.
-     */
-	query( key: string | number, command: string, ...params: any[] ): Promise< any[] >;
+	 */
+	removeConnection(key: string | number): Promise<boolean>;
 
+	/**
+	 * Performs a query.
+	 *
+	 * @param {string|number}      key       Database identification key set in connect().
+	 * @param {string}             command   Query to run.
+	 * @param {...any[]|undefined} [params]  [OPTIONAL] Query parameters.
+	 *
+	 * @returns {Promise<any[]>} Query results.
+	 */
+	query(key: string | number, command: string, ...params: any[]): Promise<any[]>;
 
-    /**
-     * Executes a command.
-     *
-     * @param {string|number} key     Database identification key set in connect().
-     * @param {string}        command Command to run.
-     * @param {any[]}         params  [OPTIONAL] Command parameters.
-     *
-     * @returns {Promise<any[]>} Command results.
-     */
-	run( key: string | number, command: string, ...params: any[] ): Promise< any[] >;
 
-    /**
-     * Creates a database connection.
-     *
-     * @param {string|object}       conn    JDBC-like connection string or a connection object accepted by `database-js`.
-     * @param {object|undefined}    driver  [OPTIONAL] Driver object, used by `database-js`.
+	/**
+	 * Executes a command.
+	 *
+	 * @param {string|number} key       Database identification key set in connect().
+	 * @param {string}        command   Command to run.
+	 * @param {any[]}         [params]  [OPTIONAL] Command parameters.
 	 *
-	 * @returns {Connection} DatabaseJS' connection
-     */
-	createConnection( conn: string | object, driver?: object ): any;
+	 * @returns {Promise<any[]>} Command results.
+	 */
+	run(key: string | number, command: string, ...params: any[]): Promise<any[]>;
 
 	/**
-     * Checks if there is a database connection with the given key.
-     *
-     * @param {string|number} key Database identification key set in connect().
+	 * Creates a database connection.
 	 *
-	 * @returns {boolean}
-     */
-	hasConnection( key: string | number ): boolean;
+	 * @param {string|object}       conn     JDBC-like connection string or a connection object accepted by `database-js`.
+	 * @param {object|undefined}    [driver] [OPTIONAL] Driver object, used by `database-js`.
+	*
+	* @returns {Connection} DatabaseJS' connection
+	 */
+	createConnection(conn: string | object, driver?: object): any;
 
-    /**
-     * Gets the database connection with the given key.
-     *
-     * @param {string|number} key Database identification key set in connect().
+	/**
+	  * Checks if there is a database connection with the given key.
+	  *
+	  * @param {string|number} key Database identification key set in connect().
+	  *
+	  * @returns {boolean}
+	  */
+	hasConnection(key: string | number): boolean;
+
+	/**
+	 * Gets the database connection with the given key.
+	 *
+	 * @param {string|number} key Database identification key set in connect().
 	 *
 	 * @returns {Connection} DatabaseJS' connection.
-     */
-	getConnection( key: string | number ): any;
+	 */
+	getConnection(key: string | number): any;
 
 }