mongoose-unique-array-objects

Mongoose plugin that ensures array objects are unique by the specified object key.

Purpose of this Mongoose plugin

With this Mongoose plugin you can filter out duplicate array objects in your model when saving documents. You can specify the object key by which object uniqueness is checked.

This Mongoose plugin is invoked with the save hook only.

How to use

Install the module:

yarn add mongoose-unique-array-objects

Import the plugin:

import uniqueArrayObjectsPlugin from 'mongoose-unique-array-objects'

Define your array of objects type in the Mongoose schema and configure the uniqueByKey option object with the keyName value in your schema type definition. The plugin will check the uniqueness of the objects based on this key name:

# schema type definition
const mySchema = new Schema({
  mySchemaArrayType: {
    type: [{
      lang: String
      value: String
    }],
    uniqueByKey: { keyName: 'lang' }
  }
})

In the example above only unique lang keys will be preserved. Other objects will be silently ignored and excluded from the save operation.

From version 1.0.0 upwards this plugin now also supports nested schemas, for example:

const mySchema = new Schema({
  myNestedSchemaArrayType: {
    nestedName: {
      type: [{
        lang: String
        value: String
      }],
      uniqueByKey: { keyName: 'lang' }
    }
  }

Finally, load the plugin:

mySchema.plugin(uniqueArrayObjectsPlugin)

From now on array objects will be unique by the given key and only unique objects will be stored in the save operation.

Our sponsor

This module is sponsored by https://travelem.com - travel the World with travelem.com