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

Clarify max size of _.sampleSize. [ci skp] [closes #1802]

Browse Source
This commit is contained in:
John-David Dalton
2016-01-15 02:13:23 -08:00
parent 6b19ca1c11
commit e752b26f9e
1 changed files with 6 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
lodash.js
View File

@@ -7921,7 +7921,8 @@
} }
/** /**
* Gets `n` random elements from `collection`. * Gets `n` random elements at unique keys from `collection` up to the
* size of `collection`.
* *
* @static * @static
* @memberOf _ * @memberOf _
@@ -7931,8 +7932,11 @@
* @returns {Array} Returns the random elements. * @returns {Array} Returns the random elements.
* @example * @example
* *
* _.sampleSize([1, 2, 3, 4], 2); * _.sampleSize([1, 2, 3], 2);
* // => [3, 1] * // => [3, 1]
*
* _.sampleSize([1, 2, 3], 4);
* // => [2, 3, 1]
*/ */
function sampleSize(collection, n) { function sampleSize(collection, n) {
var index = -1, var index = -1,