Mirrors/lodash
1
0
Fork 0
mirror of https://github.com/whoisclebs/lodash.git synced 2026-02-02 08:07:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add more options docs. [ci skip]

Browse Source
This commit is contained in:
John-David Dalton
2016-03-22 22:17:19 -07:00
parent cfe5ea264d
commit 8d93455076
1 changed files with 16 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

38
lodash.js
View File

@@ -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
*