From 8d93455076686eb97f6e2ee266854e3272ff5434 Mon Sep 17 00:00:00 2001 From: John-David Dalton Date: Tue, 22 Mar 2016 22:17:19 -0700 Subject: [PATCH] Add more `options` docs. [ci skip] --- lodash.js | 38 ++++++++++++++++---------------------- 1 file changed, 16 insertions(+), 22 deletions(-) diff --git a/lodash.js b/lodash.js index 0e5f58fd1..d5db75c2a 100644 --- a/lodash.js +++ b/lodash.js @@ -9041,13 +9041,10 @@ * @category Function * @param {Function} func The function to debounce. * @param {number} [wait=0] The number of milliseconds to delay. - * @param {Object} [options] The options object. - * @param {boolean} [options.leading=false] Specify invoking on the leading - * edge of the timeout. - * @param {number} [options.maxWait] The maximum time `func` is allowed to be - * delayed before it's invoked. - * @param {boolean} [options.trailing=true] Specify invoking on the trailing - * edge of the timeout. + * @param {Object} [options={}] The options object. + * @param {boolean} [options.leading=false] Specify invoking on the leading edge of the timeout. + * @param {number} [options.maxWait] The maximum time `func` is allowed to be delayed before it's invoked. + * @param {boolean} [options.trailing=true] Specify invoking on the trailing edge of the timeout. * @returns {Function} Returns the new debounced function. * @example * @@ -9641,11 +9638,9 @@ * @category Function * @param {Function} func The function to throttle. * @param {number} [wait=0] The number of milliseconds to throttle invocations to. - * @param {Object} [options] The options object. - * @param {boolean} [options.leading=true] Specify invoking on the leading - * edge of the timeout. - * @param {boolean} [options.trailing=true] Specify invoking on the trailing - * edge of the timeout. + * @param {Object} [options={}] The options object. + * @param {boolean} [options.leading=true] Specify invoking on the leading edge of the timeout. + * @param {boolean} [options.trailing=true] Specify invoking on the trailing edge of the timeout. * @returns {Function} Returns the new throttled function. * @example * @@ -13320,13 +13315,13 @@ * @memberOf _ * @category String * @param {string} [string=''] The template string. - * @param {Object} [options] The options object. - * @param {RegExp} [options.escape] The HTML "escape" delimiter. - * @param {RegExp} [options.evaluate] The "evaluate" delimiter. - * @param {Object} [options.imports] An object to import into the template as free variables. - * @param {RegExp} [options.interpolate] The "interpolate" delimiter. - * @param {string} [options.sourceURL] The sourceURL of the template's compiled source. - * @param {string} [options.variable] The data object variable name. + * @param {Object} [options={}] The options object. + * @param {RegExp} [options.escape=_.templateSettings.escape] The HTML "escape" delimiter. + * @param {RegExp} [options.evaluate=_.templateSettings.evaluate] The "evaluate" delimiter. + * @param {Object} [options.imports=_.templateSettings.imports] An object to import into the template as free variables. + * @param {RegExp} [options.interpolate=_.templateSettings.interpolate] The "interpolate" delimiter. + * @param {string} [options.sourceURL='lodash.templateSources[n]'] The sourceURL of the compiled template. + * @param {string} [options.variable='obj'] The data object variable name. * @param- {Object} [guard] Enables use as an iteratee for functions like `_.map`. * @returns {Function} Returns the compiled template function. * @example @@ -14252,9 +14247,8 @@ * @category Util * @param {Function|Object} [object=lodash] The destination object. * @param {Object} source The object of functions to add. - * @param {Object} [options] The options object. - * @param {boolean} [options.chain=true] Specify whether the functions added - * are chainable. + * @param {Object} [options={}] The options object. + * @param {boolean} [options.chain=true] Specify whether mixins are chainable. * @returns {Function|Object} Returns `object`. * @example *