Syntax, Parameter, and Return Value
The _.differenceBy() method's syntax introduces the concept of an iteratee for comparison:
Syntax
_.differenceBy(array, [values], [iteratee=_.identity])
Parameters
-
array (Array): The array to inspect.
-
[values] (Array): The array(s) of values to exclude from the first array.
- [iteratee=_.identity] (Function|String): The iteratee invoked per element for comparison. This can be a function or a property name.
Return Value
Array: Returns a new array filtered based on the iteratee.
This method provides a nuanced approach to array comparison, accommodating more complex scenarios.
Examples of Lodash _.differenceBy() Method
Example 1: Using Property Name for Comparison
JavaScript
const _ = require('lodash');
const array1 = [{ 'x': 1 }, { 'x': 2 }];
const array2 = [{ 'x': 1 }];
const differenceByProperty = _.differenceBy(array1, array2, 'x');
console.log(differenceByProperty);
You can also try this code with Online Javascript Compiler
Output:
[{ 'x': 2 }]
Here, the method compares elements based on the x property, resulting in an array of objects where x is unique to array1.
Example 2: Using Custom Function
JavaScript
const array3 = [2.1, 1.2];
const array4 = [2.3, 3.4];
const differenceByFunction = _.differenceBy(array3, array4, Math.floor);
console.log(differenceByFunction);
You can also try this code with Online Javascript Compiler
Output:
[1.2]
A custom function (Math.floor) is used for comparison, focusing on the integer part of the numbers.
Example 3: Comparison with Multiple Arrays
JavaScript
const array5 = [2.5, 3.1];
const multipleDifferenceBy = _.differenceBy(array3, array4, array5, Math.floor);
console.log(multipleDifferenceBy);
You can also try this code with Online Javascript Compiler
Output:
[1.2]
Comparing with multiple arrays using a custom iteratee further showcases the method's versatility.
Example 4: Difference by with Empty Array
JavaScript
const emptyArray = [];
const differenceByEmpty = _.differenceBy(array1, emptyArray, 'x');
console.log(differenceByEmpty);
You can also try this code with Online Javascript Compiler
Output:
[{ 'x': 1 }, { 'x': 2 }]
Even with an empty array, the method behaves consistently, focusing on the specified criterion for comparison.
Frequently Asked Questions
How does _.differenceBy() handle arrays of objects?
_.differenceBy() excels in handling arrays of objects, allowing comparisons based on specific object properties.
Can the iteratee be a complex function in _.differenceBy()?
Yes, the iteratee can be any function that returns a value used for comparison, offering great flexibility in defining comparison criteria.
What happens if the iteratee is not provided in _.differenceBy()?
If no iteratee is provided, _.differenceBy() behaves like the standard _.difference() method, comparing array elements directly.
Conclusion
The _.differenceBy() method in Lodash is a highly customizable and powerful tool for array comparison in JavaScript. Its ability to compare based on specific criteria or properties makes it invaluable for sophisticated data processing and manipulation. This method significantly enhances the precision and flexibility of array operations, catering to a wide range of programming needs.
You can refer to our guided paths on the Coding Ninjas. You can check our course to learn more about DSA, DBMS, Competitive Programming, Python, Java, JavaScript, etc.
Also, check out some of the Guided Paths on topics such as Data Structure and Algorithms, Competitive Programming, Operating Systems, Computer Networks, DBMS, System Design, etc., as well as some Contests, Test Series, and Interview Experiences curated by top Industry Experts.
85+ registered