Support mongoose.SchemaType.get() : custom getters across all instances of a schematype

[vkarpov15]

Re discussion on #6849

Example:

mongoose.Schema.Date.set(v => v === '' ? Date.now() : v); // Convert '' to `new Date()` for all date paths

[Lanfei]

@vkarpov15 What if I want to get the original object in some cases?

[vkarpov15]

@Lanfei can you provide an example case? You can do something like toObject({ getters: false }) to get the raw doc without any getters applied.

[Lanfei]

@vkarpov15 Actually I don't have any example case now, just wanted to know the solution if I met this situation in the future :)

Maybe we can also have something like .get(key, { getter: false })?

[vkarpov15]

Love it, great idea 👍

[vkarpov15]

The syntax will be .get(key, null, { getters: false }) in 5.5.0. The 2nd arg to .get() is for adhoc type casting.

[GlennyDC]

Hi

This does not seem to work in v5.10.3:

mongoose.Schema.ObjectId.get(v => v.toString());

And neither does this:

mongoose.ObjectId.get(v => v.toString());

Full code:

import mongoose from 'mongoose';

export const installDatabaseConnection = async (): Promise<void> => {
  try {
    await mongoose.connect('mongodb://db:27017', {
      useNewUrlParser: true,
      useFindAndModify: false,
      useUnifiedTopology: true,
    });

    mongoose.Schema.ObjectId.get((v) => v.toString());
  } catch (err) {
    console.log(err);
  }
};

Kind regards

Glenny

[vkarpov15]

@GlennyDC can you please define what you mean by "does not seem to work"? What is the behavior you're seeing and what is the behavior you expect?

[GlennyDC]

@vkarpov15 I am referring to this functionality: https://mongoosejs.com/docs/api/schematype.html#schematype_SchemaType-get

Also described / mentioned in:

• http://thecodebarbarian.com/whats-new-in-mongoose-54-global-schematype-configuration.html#schematype-getters
• I want to auto convert ObjectId to string #6996 (comment)

mongoose.Schema.ObjectId.get((v) => v.toString());

Expected behaviour:
When querying, the Schema should convert any ObjectId type to type String for the returned Documents.
Much like setting a getter for every ObjectId for every Schema:

ownerId: {
      type: mongoose.Schema.Types.ObjectId,
      get: (v) => v.toString(),
      required: true,
},

Actual behaviour:
The returned Documents do not contain the converted values. Every property with type ObjectId is still type ObjectId and not type String.

[vkarpov15]

I opened up a separate issue for this #9509 @GlennyDC