how to declare mongoose static methods that will work with ESLint

Question

Using Mongoose ORM for MongoDB

I've declared a mongoose static method like:

ConvoDataSchema.statics.randomItem = async function () { ... }

and then create a model with that

const ConvoData = mongoose.model('ConvoData', ConvoDataSchema)

but later when I want to call the method:

let convoData = await ConvoData.randomItem()

My linter is not aware that ConvoData has had this magical method patched onto it by Mongoose.

How can I declare these methods such that a Linter (TSLint / VSCode Intellisense) can properly discover these methods?

it works on the line you're declaring it, but in other files does ESLint know about the `ConvoData.xx()` method declaration? I think ESLint can parse the inline syntax but not recognize the object it's attached to for exports. — dcsan, May 11 '19 at 07:07

score 0 · Answer 1 · answered May 13 '19 at 21:11

I would think that you could either tell ESLint to "ignore" lines like that, or you can get really weird and do something like:

let convoData = await ConvoDataSchema.statics.randomItem.call(ConvoData)

Sucks that neither solution is as elegant as I'm sure you were hoping for.

score 0 · Answer 2 · edited May 14 '19 at 10:19

0

Looking into the documentation I found this: https://mongoosejs.com/docs/guide.html#statics

Do not declare statics using ES6 arrow functions (=>). Arrow functions explicitly prevent binding this, so the above examples will not work because of the value of this."

Can be this your problem?

edited May 14 '19 at 10:19

geisterfurz007

5,292
5
33
54

answered May 14 '19 at 10:17

Schwarz54

964
1
9
18

that might be a runtime issue. But the linter at compile time and intellisense can't really figure out those kind of issues. Maybe a true AST anaylsis linter could but i dont think ESLint is in that category. – dcsan Aug 28 '19 at 17:17

score 0 · Answer 3 · answered Aug 28 '19 at 17:16

0

now I'm using typescript for most projects, and mongoose defeats getting decent intellisense because of some of the reasons above and more, my solution is not to use mongoose...

answered Aug 28 '19 at 17:16

dcsan

11,333
15
77
118

score -1 · Answer 4 · answered May 10 '19 at 08:21

-1

If declared exactly like this:

ConvoDataSchema.statics.randomItem = async function () {
const ConvoData = mongoose.model('ConvoData', ConvoDataSchema)

it won't work because the method wasn't closed. You should try closing the method. Further, what exactly is the method returning, that way, we can properly debug the method.

answered May 10 '19 at 08:21

toonday

501
4
13

this was just a snippet of the source. I've made it more clear above. – dcsan May 10 '19 at 18:06

how to declare mongoose static methods that will work with ESLint

4 Answers4