(docs) Add example of using a Class with typescript support

mongodb-js / mongoose-autopopulate

Always populate() certain fields in your mongoose schemas

Apache License 2.0

221 stars 36 forks source link

(docs) Add example of using a Class with typescript support #33

Closed santiq closed 6 years ago

santiq commented 6 years ago

Hello! I've been using this plugin with in my Typescript project, and I found that there is no documentation on where to include the plugin. So, here is an example

Thanks!

coveralls commented 6 years ago

Changes Unknown when pulling dc7c618e5728de0389a93a9f6d6742b59cde8159 on santiq:patch-1 into on mongodb-js:master.

vkarpov15 commented 6 years ago

Thanks but README.md is a compiled file so your changes will get overwritten immediately. Part of the reason why we can maintain all these plugins is that our docs are compiled from our tests so we don't have to think about keeping examples up to date. This file gets compiled to produce README.md. Plugging in typescript support into our docs build pipeline is going to be more trouble than its worth IMO, but you're more than welcome to try if you want :+1: