Skip to content

mongoosejs/mongoose-lean-getters

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

mongoose-lean-getters

Apply getters on lean() documents: https://mongoosejs.com/docs/tutorials/lean.html

This package requires Mongoose >= 7.1.0. Do not use with Mongoose 7.0.x or 6.x.

Usage

const mongoose = require('mongoose'); const mongooseLeanGetters = require('mongoose-lean-getters'); const schema = mongoose.Schema({ name: { type: String, // Get the last 6 characters of the string get: v => v.slice(-6) } }); // Add this plugin to apply getters when using `lean()`. schema.plugin(mongooseLeanGetters); await Model.create({ name: 'Captain Jean-Luc Picard' }); const doc = await Model.findOne().lean({ getters: true }); doc.name; // 'Picard'

You may also set the default lean options to always use getters:

const mongoose = require('mongoose'); const mongooseLeanGetters = require('mongoose-lean-getters'); const schema = mongoose.Schema({ name: { type: String, // Get the last 6 characters of the string get: v => v.slice(-6) } }); // Set the default options for all lean queries schema.plugin(mongooseLeanGetters, { defaultLeanOptions: { getters: true }}); await Model.create({ name: 'Captain Jean-Luc Picard' }); const doc = await Model.findOne().lean(); doc.name; // 'Picard' // You may also set getters: false at call time const doc2 = await Model.findOne().lean({ getters: false }); doc2.name; // 'Captain Jean-Luc Picard'

About

Apply getters on lean() documents: https://mongoosejs.com/docs/tutorials/lean.html

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 12