Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/thenoim/fastify-loader
The route loader for the cool kids!
https://github.com/thenoim/fastify-loader
fastify fastify-plugin hacktoberfest loader routes
Last synced: 2 months ago
JSON representation
The route loader for the cool kids!
- Host: GitHub
- URL: https://github.com/thenoim/fastify-loader
- Owner: TheNoim
- License: mit
- Created: 2018-09-09T15:55:48.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-01-06T01:43:26.000Z (about 2 years ago)
- Last Synced: 2024-04-25T18:41:32.266Z (9 months ago)
- Topics: fastify, fastify-plugin, hacktoberfest, loader, routes
- Language: JavaScript
- Homepage:
- Size: 1.45 MB
- Stars: 17
- Watchers: 4
- Forks: 0
- Open Issues: 20
-
Metadata Files:
- Readme: Readme.md
- License: LICENSE
Awesome Lists containing this project
README
# fastify-loader
_The route loader for the cool kids!_
[](https://www.npmjs.com/package/fastify-loader)
[](https://github.com/TheNoim/fastify-loader)
[](https://github.com/TheNoim/fastify-loader)
[](https://www.npmjs.com/package/fastify-loader) [](https://greenkeeper.io/)
Do you also want an easy way to load routes for fastify? YEAH me too! This is why I made this module.
`fastify-loader` makes it easy to load routes from a directory.
#### Features
- Looks cool
- No need to `module.export = (fastify) => { /* your code here */ }`
- No need to export the fastify instance itself
- No `module.export = { path: '/api/test', handler: (req, reply) => {} }`
#### Please, give me an example!
```javascript
// File: ./api/hello.js
// YES, really! You don't need to require anything here.
// The fastify instance gets injected in any file matched by the glob.
fastify.get('/api/hello', async () => {
// Complex code here
return { hello: true };
})
```
```javascript
// File: ./server.js
const fastify = require('fastify')();
// Just register the plugin and add glob array which files to loud
fastify.register(require('fastify-loader'), {
paths: ['./api/**/*.js'], // A glob array
name: "fastify" // [Optional] if you want to do something like this: YOURNAMEHERE.get('/api/test')
});
fastify.listen(1337, err => {
if (err) console.trace(err);
console.log('http://127.0.0.1:1337');
});
```
#### Installation
Like any other npm module.
```bash
yarn add fastify-loader
# or with npm
npm i fastify-loader --save
```
#### How does this work?
It uses [vm2](https://github.com/patriksimek/vm2) to inject the fastify instance and other vars into the scope of each file.
#### WebStorm/{INSERT OTHER IDE HERE} says that fastify is an unknown variable. What can I do?
If your IDE supports [JSDoc](http://usejsdoc.org/), you can append this to the file.
```diff
// File: ./api/hello.js
+ /**
+ * @var {fastify.FastifyInstance} fastify
+ */
// noinspection ES6ModulesDependencies
fastify.get('/api/hello', async () => {
// Complex code here
return { hello: true };
})
```
Or better if your IDE supports typescript typings, because then you can do this:
```typescript
// File: ./api/hello.js
+ ///
+ ///
// noinspection ES6ModulesDependencies
fastify.get('/api/hello', async () => {
// Complex code here
return { hello: true };
})
```
#### Do tests exist?
Yes. You can run `yarn test` or `npm run test` after you installed the dependencies.
#### Inject more than just fastify
```javascript
fastify.register(require('fastify-loader'), {
paths: ['./api/**/*.js'], // A glob array
inject: {
pi: 3.14 // pi is now available as var in each js file in ./api
}
});
```
#### License
The MIT License (MIT)
Copyright (c) 2018 Nils Bergmann
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.