Document promise support for DAO::find

It was previously completely undocumented. There are additional methods that add promises but I figure accurately documenting some is better than none. :)
This commit is contained in:
Sequoia McDowell 2016-05-06 22:37:38 -04:00
parent 2189b9a746
commit ae7a5df47b
1 changed files with 2 additions and 1 deletions

View File

@ -1568,7 +1568,8 @@ DataAccessObject._coerce = function(where) {
* - `{foo: true}` - include only foo * - `{foo: true}` - include only foo
* - `{bat: false}` - include all properties, exclude bat * - `{bat: false}` - include all properties, exclude bat
* *
* @param {Function} cb Required callback function. Call this function with two arguments: `err` (null or Error) and an array of instances. * @param {Function} cb Optional callback function. Call this function with two arguments: `err` (null or Error) and an array of instances.
* @return {Promise} results If no callback function is provided, a promise (which resolves to an array of instances) is returned
*/ */
DataAccessObject.find = function find(query, options, cb) { DataAccessObject.find = function find(query, options, cb) {