mongoose-lean-defaults

Attach defaults to the results of mongoose queries when using .lean(). Highly inspired by mongoose-lean-virtuals.

Install

npm install --save mongoose-lean-defaults

or

yarn add mongoose-lean-defaults

Usage

import mongooseLeanDefaults from 'mongoose-lean-defaults';
// const mongooseLeanDefaults = require('mongoose-lean-defaults').default;

const userSchema = new mongoose.Schema({
  name: {
    type: String,
    default: 'Bob',
  },
});
// documents will only have `name` field on database

// Later
const updatedUserSchema = new mongoose.Schema({
  name: {
    type: String,
    default: 'Bob',
  },
  country: {
    type: String,
    default: 'USA',
  },
});
// `.find().lean()` will return documents without `country` field

updatedUserSchema.plugin(mongooseLeanDefaults);

// You must pass `defaults: true` to `.lean()`
const bob = await UserModel.findOne().lean({ defaults: true });
/**
 * bob = {
 *    _id: ...,
 *    name: 'Bob',
 *    country: 'USA'
 * }
 */

2.2.1 / 2022-06-24

• Fixed: Respect default value of undefined for subschemas #30
• Fixed: Do not run plugin logic if not using .lean() #29

2.2.0 / 2022-06-17

• Added: Option to provide global defaults when attaching plugin to schema #28

2.1.2 / 2022-06-17

• Fixed: Support mongoose 5 #27

2.1.1 / 2022-06-03

• Fixed: Make it work reliably with other lean plugins
• Refactored: Code refactored so it is simpler to maintain

2.1.0 / 2022-02-08

• Fixed: Fields using Map type receive an additional "$*" key in the result #24
• Fixed: Recursive schema on array field causes stack overflow #25
• Added: Attach plugin to findOneAndRemove and findOneAndDelete
• Added: Support mongoose v6 (>=5 in peerDependencies)

2.0.1 / 2021-06-09

• Fixed: should work with typed Schema #20

2.0.0 / 2021-05-12

• Fixed: should attach subdocument defaults when using projection #18 #16
• Chore: migrate codebase to typescript
• BREAKING CHANGE: if using require('mongoose-lean-defaults'), you should update it to require('mongoose-lean-defaults').default (should not be a problem if using import)

1.0.1 / 2020-12-18

• Chore: add .npmignore to not bundle unnecessary files

1.0.0 / 2020-12-18

• Refactor: use Array#forEach() instead of Array#map() to improve memory usage #14 Hafez
• Fixed: handle $slice and $elemMatch projections #12 Valeri Karpov
• Chore: bump version to 1.0.0, since there's no reason to keep it at 0.x, so future changes can be better represented by semver

0.4.1 / 2020-03-19

• Fixed: return defaults of fields which are nested inside projected object #8 Vladimir Enchev

0.4.0 / 2020-02-21

• Added: respect projection when attaching defaults

0.3.2 / 2020-01-02

• Fixed: old null values were breaking nested defaults

0.3.1 / 2019-09-28

• Added: support null value in SchemaType.default()

0.3.0 / 2019-09-28

• Added: support SchemaType.default() (Fixes: #3)
• Added: support nested objects without default values:

  new Schema({
    obj: {
      prop: String,
    },
  });

0.2.0 / 2019-07-25

• Added: support default functions #1 Valeri Karpov

0.1.1 / 2019-07-19

• Fixed: set default values in nested objects/schemas