francescov1 / mongoose-tsgen

A plug-n-play Typescript generator for Mongoose.
103 stars 24 forks source link

jsdocs #73

Closed francescov1 closed 2 years ago

francescov1 commented 3 years ago

Detects JSDocs in Mongoose schemas and adds them to the generated TS types. Currently this will parse comments up to a depth of 2 levels. If we find that this does not suffice all users then we can add a CLI option to let the user pass a custom value.

Tests currently failing due to a Mongoose bug which should be fixed in the next release (6.0.13) 6.0.13 was still missing one small type fix, a PR has been made here to address this. Once this is released, tests will pass on this PR and it can be merged.

Closes https://github.com/francescov1/mongoose-tsgen/issues/13