Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gastonpereyra/get-unique-objects
Get unique objects from array of objects (can be normalize)
https://github.com/gastonpereyra/get-unique-objects
normalize objects set unique
Last synced: 8 days ago
JSON representation
Get unique objects from array of objects (can be normalize)
- Host: GitHub
- URL: https://github.com/gastonpereyra/get-unique-objects
- Owner: gastonpereyra
- License: mit
- Created: 2020-09-06T14:50:54.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2021-09-11T22:44:12.000Z (about 3 years ago)
- Last Synced: 2024-10-28T22:57:44.514Z (18 days ago)
- Topics: normalize, objects, set, unique
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/get-unique-objects
- Size: 101 KB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Get Unique Objects
## Code Quality Status
[](https://coveralls.io/r/gastonpereyra/get-unique-objects?branch=master)
## Description
Get unique objects from array of objects (can be normalize before compare them)
## Installation
```
npm i get-unique-objects
```
## Params
`getUniqueObjects(items, options)`
### items
* Items to be filter
* Type: `Array` of `Object`
* Required
Example
```js
// Example - 1
[]
// Example - 2
[
{ name: 'Buenos Aires', country: 'Argentina'}
]
// Example - 3
[
{ name: 'Buenos Aires', country: 'Argentina'},
{ name: 'Villa Carlos Paz', country: 'Argentina', province: 'Córdoba' },
]
```
### options
* Options to normalize the objects before compare
* Type: `Object`
* Optional
Example
```js
{
fieldsToKeep: ["name", "number"]
}
```
:link: See more in [Object Normalize](https://github.com/gastonpereyra/objects-normalizer#options)
## Return
`getUniqueObjects(items, options) : uniqueItems`
* Items not repeated after normalize them, unique Items
* Type: `Array` of `Object`
## Usage
### getUniqueObjects([items])
Filter unique objects from items
```js
const getUniqueObjects = require('get-unique-objects');
const playerSample1 = {
name: "Juan Román",
lastname: "Riquelme",
clubs: ["Boca", "Barcelona", "Villareal", "Argentinos"],
number: 10,
stillPlaying: false,
birthPlace: { country: "Argentina", province: "Buenos Aires", city: "Don Torcuato" }
};
const playerSample2 = {
name: "Juan Román",
lastname: "Riquelme",
clubs: ["Boca", "Barcelona", "Villareal", "Argentinos"],
number: 10
}
getUniqueObjects([playerSample1, playerSample2]);
/*
output: [
{
name: "Juan Román",
lastname: "Riquelme",
clubs: ["Boca", "Barcelona", "Villareal", "Argentinos"],
number: 10,
stillPlaying: false,
birthPlace: { country: "Argentina", province: "Buenos Aires", city: "Don Torcuato" }
},
{
name: "Juan Román",
lastname: "Riquelme",
clubs: ["Boca", "Barcelona", "Villareal", "Argentinos"],
number: 10
}
]
*/
getUniqueObjects([playerSample1, playerSample1]);
/*
output: [
{
name: "Juan Román",
lastname: "Riquelme",
clubs: ["Boca", "Barcelona", "Villareal", "Argentinos"],
number: 10,
stillPlaying: false,
birthPlace: { country: "Argentina", province: "Buenos Aires", city: "Don Torcuato" }
}
]
*/
getUniqueObjects([]);
/*
output: []
*/
```
### getUniqueObjects([items], options)
Filter unique objects from items after normalize them
```js
const getUniqueObjects = require('get-unique-objects');
const playerSample1 = {
name: "Juan Román",
lastname: "Riquelme",
clubs: ["Boca", "Barcelona", "Villareal", "Argentinos"],
number: 10,
stillPlaying: false,
birthPlace: { country: "Argentina", province: "Buenos Aires", city: "Don Torcuato" }
};
const playerSample2 = {
name: "Juan Román",
lastname: "Riquelme",
clubs: ["Boca", "Barcelona", "Villareal", "Argentinos"],
number: 10
}
getUniqueObjects([playerSample1, playerSample2], { fieldsToRemove: ["number", "stillPlaying", "birthPlace"] });
/*
output: [
{
name: "Juan Román",
lastname: "Riquelme",
clubs: ["Boca", "Barcelona", "Villareal", "Argentinos"]
}
]
*/
const playerSample3 = {
name: "Lionel",
lastname: "Messi",
clubs: ["Barcelona"],
number: 10,
stillPlaying: true
}
getUniqueObjects([playerSample1, playerSample2, playerSample3], { fieldsToKeep: ["name", "lastname"]});
/*
output: [
{
name: "Juan Román",
lastname: "Riquelme"
},
{
name: "Lionel",
lastname: "Messi"
}
]
*/
getUniqueObjects([playerSample1, playerSample2, playerSample3], { fieldsToKeep: ["number"]});
/*
output: [
{
number: 10
}
]
*/
```