Skip to content

Add documentation for the startIndex argument of restArguments #3003

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jgonggrijp merged 2 commits into from
Mar 26, 2026
+31 −0
Merged

Add documentation for the startIndex argument of restArguments #3003

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
540b075
Add documentation for the startIndex argument of restArguments
jgonggrijp Feb 20, 2025
6939a44
Decorate _.restArguments code examples with output
jgonggrijp Mar 25, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 31 additions & 0 deletions index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1819,6 +1819,37 @@ <h2 id="functions">Function (uh, ahem) Functions</h2>
});

raceResults("Dopey", "Grumpy", "Happy", "Sneezy", "Bashful", "Sleepy", "Doc");
// Sorry Sneezy, better next time!
// Sorry Bashful, better next time!
// Sorry Sleepy, better next time!
// Sorry Doc, better next time!
</pre>
<p id="restArguments-startIndex">
The <b>startIndex</b> is mainly useful if the number of arguments cannot be reliably determined from the <b>function</b> itself, for example because <b>function</b> was output by another function.
</p>
<pre>
// The inner function from before.
function consoleNonWinners(gold, silver, bronze, everyoneElse) {
_.each(everyoneElse, sendConsolations);
}

// This time, we transform it through another metafunction first.
// Snow White always wins gold!
var withSnowWhite = _.partial(consoleNonWinners, "Snow White");

// withSnowWhite.length is zero because _.partial does not remember the
// number of parameters for us. We fix this by passing an explicit
// startIndex.
var raceResults = _.restArguments(withSnowWhite, 2);

// Dopey degraded to silver, Grumpy degraded to bronze and Happy fell
// out of the prizes altogether. We will console him as well.
raceResults("Dopey", "Grumpy", "Happy", "Sneezy", "Bashful", "Sleepy", "Doc");
// Sorry Happy, better next time!
// Sorry Sneezy, better next time!
// Sorry Bashful, better next time!
// Sorry Sleepy, better next time!
// Sorry Doc, better next time!
</pre>

<h2 id="objects">Object Functions</h2>
Expand Down
Loading