Join GitHub today
GitHub is home to over 50 million developers working together to host and review code, manage projects, and build software together.
Sign up`orderBy` documentation #4668
Open
`orderBy` documentation #4668
Comments
|
Agreed, none of the iteratee shorthand usages are documented in the jsdoc. Currently the values are Where it would make more sense to be something like. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
It works (currently) to pass a single string, function, or object as the iteratees, and a single string for 'asc' or 'desc' like so:
This is undocumented. Either this shortcut should be documented somehow, or it should fail. I vote documented.
Coincidentally, I'm unsure how using an object as an iteratee would work, but I'd love to learn (without having to read the source, which is what I'm about to do anyway). Adding top level documentation on the ways iteratees work would be nice...Actually, how having poked through the actual code I'm still unclear how that's legal.