@tsed/components-scan

@tsed/components-scan

Website   •   Getting started   •   Slack   •   Twitter

---

A package of Ts.ED framework. See website: https://tsed.io/

Introduction

⚠️⚠️⚠️ DON'T USE THIS PLUGIN in PRODUCTION MODE ⚠️⚠️⚠️

ComponentsScan is an option to import services using a glob pattern. It's pretty useful when you start new application.

But this option can cause some issues or misunderstood:

• When you change a location for a Controller/Service/Modules, the code isn't discovered as expected. It's normal, the server have default configuration like **/services/**/*.ts. if the code is outside of this pattern, they won't be loaded.
• Performance issue. The global pattern have a huge impact on the server bootstrap!
• Isn't compatible with Webpack or any bundler because the code imported dynamically.
• Importing dynamically code using glob pattern in production may be a breach exploitable by hackers to inject code.

When I can use this package

For development purpose (mock server, test server, dev server, etc...)

Installation

npm install --save @tsed/components-scan

Backers

Thank you to all our backers! 🙏 [Become a backer]

Sponsors

Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [Become a sponsor]

License

The MIT License (MIT)

Copyright (c) 2016 - 2022 Romain Lenzotti

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.