How to call mongoose method in the select method

Question

I have a mongoose model that represents a player and want to be able to fetch the player and when selecting the player, want to call isReady like a getter.

The model looks like so:

const PlayerSchema = new Schema({
  user: { type: Schema.Types.ObjectId, ref: "User" },
  famousPerson: { type: String }
})

PlayerSchema.methods.isReady = function (cb) {
  return Boolean(this.famousPerson)
}

And I want to be able to call it like so:

const player = await PlayerModel
      .findOne({_id: playerId})
      .select(["_id", "username", "isReady"])

Am I able to set the method on the class as a getter?

Answer 1

You can use mongoose virtuals for this, but to work as expected you need to configure your schema so that it can return virtuals, because by default virtuals will not be included.

const PlayerSchema = new Schema(
  {
    famousPerson: { type: String },
  },
  {
    toJSON: { virtuals: true },
    toObject: { virtuals: true },
  }
);

PlayerSchema.virtual("isReady").get(function () {
  return Boolean(this.famousPerson);
});

Answer 2

You Can Follow This Code

const player = await PlayerModel
      .findOne({_id: playerId})
      .select(" +_id +username +isReady)