Schema options as a function, return type help

[skiv71]

Prerequisites

• I have written a descriptive issue title

Mongoose version

8.19

Node.js version

24

MongoDB version

8

Operating system

None

Operating system version (i.e. 20.04, 11.3, 10)

No response

Issue

Since I'd like to override the default schema options on all my schema models, I thought it would be a good idea to create an object (const or function call) and since these are done in abstraction, I have to Type the const / function return type.

Thought I could get away with mongoose.SchemaOptions... but then intellisense spits it's dummy out.

I look at the source and the warning and I'm still none the wiser on how to Type this...

On the face of it, these typings in the source look very complex... and I can't see it documented.

Any pointers? Or is there a factory fn to help?

[vkarpov15]

Without code samples I can't be sure exactly what you're trying to do, but if you want default schema options, you can try something like this:

or just a `const defaultSchemaOptions = { toJSON: { virtuals: true } } as const;

[skiv71]

Having used mongodb's nativate TS support, I have to say that issues like this are a pain.

I've just discovered another scenario and have uploaded an image to show the issue.

I create a Typed schema.... retrieve a document via .findById... then have another function, where I'd like to pass in this document for whatever reason "function test".

As you can see from the screen capture, with the variable defined from the previous find request, the Typed parameters are hideous.

For me to correctly Type the "test" function, I need to annotate it, but as you can see... that's gonna be messy

[skiv71]

The equivalent return type from a mongodb driver request would be much easier to Type. In my opinion, this needs sorting.

[vkarpov15]

"Having used mongodb's nativate TS support, I have to say that issues like this are a pain." <-- what is "this" referring to here?

You can type CandleDocument like this:

type CandleDocument = mongoose.HydratedDocumentFromSchema<typeof candleSchema>; // Presuming `candleSchema` is the schema used to define the Candle model

// or
type CandleDocument = ReturnType<(typeof Candle)['hydrate']>; // `hydrate()` is the function Mongoose uses to transform raw data from the db into a Mongoose document

// or
type CandleDocument = mongoose.HydratedDocument<CandleData>; // presuming `CandleData` is the raw document type and there's no methods, virtuals, etc.