Skip to content
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.

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

Already on GitHub? Sign in to your account

docs(util): added jsdoc annotations for ArrayHelpers.js #15279

Merged
merged 1 commit into from Jan 31, 2022
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
22 changes: 18 additions & 4 deletions lib/util/ArrayHelpers.js
Expand Up @@ -5,6 +5,14 @@

"use strict";

/**
* Compare two arrays or strings by performing strict equality check for each value.
* @template T [T=any]
* @param {ArrayLike<T>} a Array of values to be compared
* @param {ArrayLike<T>} b Array of values to be compared
* @returns {boolean} returns true if all the elements of passed arrays are strictly equal.
*/

exports.equals = (a, b) => {
if (a.length !== b.length) return false;
for (let i = 0; i < a.length; i++) {
Expand All @@ -14,13 +22,19 @@ exports.equals = (a, b) => {
};

/**
*
* @param {Array} arr Array of values to be partitioned
* @param {(value: any) => boolean} fn Partition function which partitions based on truthiness of result.
* @returns {[Array, Array]} returns the values of `arr` partitioned into two new arrays based on fn predicate.
* Partition an array by calling a predicate function on each value.
* @template T [T=any]
* @param {Array<T>} arr Array of values to be partitioned
* @param {(value: T) => boolean} fn Partition function which partitions based on truthiness of result.
* @returns {[Array<T>, Array<T>]} returns the values of `arr` partitioned into two new arrays based on fn predicate.
*/
exports.groupBy = (arr = [], fn) => {
return arr.reduce(
/**
* @param {[Array<T>, Array<T>]} groups An accumulator storing already partitioned values returned from previous call.
* @param {T} value The value of the current element
* @returns {[Array<T>, Array<T>]} returns an array of partitioned groups accumulator resulting from calling a predicate on the current value.
*/
(groups, value) => {
groups[fn(value) ? 0 : 1].push(value);
return groups;
Expand Down