From 571ea964f8049f6eefd499120bc3f0586fd26d3c Mon Sep 17 00:00:00 2001 From: Benjamin Pannell Date: Fri, 16 Dec 2016 11:41:29 +0000 Subject: [PATCH] doc: Improve inline docs for some core methods --- lib/Core.ts | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/lib/Core.ts b/lib/Core.ts index 24becff..d072360 100644 --- a/lib/Core.ts +++ b/lib/Core.ts @@ -61,7 +61,7 @@ export class Core { /** * Gets the plugins registered with this Iridium Core - * @returns {[Iridium.Plugin]} + * @returns {Iridium.Plugin[]} */ get plugins(): Plugin[] { return this._plugins; @@ -158,7 +158,7 @@ export class Core { /** * Connects to the database server specified in the provided configuration - * @param {function(Error, Iridium.Core)} [callback] A callback to be triggered once the connection is established. + * @param {function} [callback] A callback to be triggered once the connection is established. * @returns {Promise} */ connect(callback?: (err: Error, core: Core) => any): Bluebird { @@ -208,7 +208,7 @@ export class Core { /** * A method which is called whenever a new connection is made to the database. * - * @param connection The underlying MongoDB connection which was created, you can modify or replace this if you wish. + * @param {MongoDB.Db} connection The underlying MongoDB connection which was created, you can modify or replace this if you wish. * @returns A promise for the connection, allowing you to perform any asynchronous initialization required by your application. * * In subclassed Iridium Cores this method can be overridden to manipulate the properties