Collect.js diff() Function

Last Updated : 15 Oct, 2024

The diff() function compares the main collection against the given collection and returns the values that are in the original collection but not in the given collection.

Syntax: 

data.diff(collection)

Parameters:

This function accepts a single parameter as mentioned above and described below:

  • collection: Hold the collection that will be compared with the main collection.

Return Value:

Returns a new collection with difference between collection items.

Example 1: Here in this example, we take a collection and then using the diff() function and return the value not in the new collection.

JavaScript
// It is used to import collect.js library
 const collect = require('collect.js');

const collection = collect([1, 2, 3, 4, 5 ,6]);
console.log(collection.diff([1, 2, 5]));

Output:

Collection { items: [ 3, 4, 6 ] }

Example 2: There is one thing to notice that this function holds a collection, compare with the main collection but only return only those items that are extra in the main collection.

JavaScript
// It is used to import collect.js library
const collect = require('collect.js');

const col1 = [1, 2, 3, 4];
const col2 = [3, 4, 5, 6];

const x = collect(col1);
const y = collect(col2);

const difference = x.diff(y); 
console.log(difference.all());

Output:

[ 1 , 2]
Comment