Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/traum-ferienwohnungen/nuxt-advanced-healthcheck
Small library for integrating healthcheck routes into your existing Nuxt project
https://github.com/traum-ferienwohnungen/nuxt-advanced-healthcheck
healthcheck-route nuxt nuxt-module nuxtjs
Last synced: 28 days ago
JSON representation
Small library for integrating healthcheck routes into your existing Nuxt project
- Host: GitHub
- URL: https://github.com/traum-ferienwohnungen/nuxt-advanced-healthcheck
- Owner: traum-ferienwohnungen
- Created: 2019-11-07T15:43:53.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2022-02-12T17:32:40.000Z (almost 3 years ago)
- Last Synced: 2024-10-09T06:52:09.081Z (about 1 month ago)
- Topics: healthcheck-route, nuxt, nuxt-module, nuxtjs
- Language: JavaScript
- Homepage:
- Size: 1.07 MB
- Stars: 3
- Watchers: 8
- Forks: 1
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSEFILE
Awesome Lists containing this project
README
# Nuxt-Advanced-Healthcheck
Module for NuxtJS that adds the provides a healthcheck route.
## Install
*Installing with NPM*
`npm i @traum-ferienwohnungen/nuxt-advanced-healthcheck`
*Installing with Yarn*
`yarn add @traum-ferienwohnungen/nuxt-advanced-healthcheck`
## Setup
*Add `@traum-ferienwohnungen/nuxt-advanced-healthcheck` to your nuxt config*
```javascript
module.exports = {
modules: [
'@traum-ferienwohnungen/nuxt-advanced-healthcheck'
]
}
```
*The default route for checking the health of your application is now available under `/healthcheck`*
It will respond with the `Content-Type: text/plain` and `Ok` as response data.
## Advanced configuration
### Single Route
To configure a single healthcheck route and the response handler use this reference:
```javascript
healthcheck: {
path: '/alive',
handler: (req, res, next) => {
res.setHeader('application/json')
res.end(JSON.stringify('Hello World'))
}
}
```
### Multi Route
When you want to use multiple routes you can use an array - like so:
```javascript
healthcheck: [
{
path: '/alive',
handler: (req, res, next) => {
res.setHeader('content-type', 'application/json')
res.end(JSON.stringify('Hello World'))
}
},
{
// Only for local requests
path: '/status',
handler: (req, res, next) => {
if(req.headers['x-forwarded-for'] === '127.0.0.1') {
res.status(200)
res.setHeader('content-type', 'application/json')
res.end(JSON.stringify('Ok'))
} else {
res.status(404)
res.setHeader('content-type', 'application/json')
res.end(JSON.stringify('Not Found'))
}
}
}
]
```
## Options
`path`
- The URL of the healthcheck
- default: `/healthcheck`
`handler`
- Handler function for the request, must end with `res.end(...)` or `next()`
- default: Text response with Ok
- available params `request, response, next`
## Tests
To run test clone this repository.
```bash
git clone [email protected]:traum-ferienwohnungen/nuxt-advanced-healthcheck.git
```
Then install all dependencies with
```bash
npm install
```
Finally run the test with
```
npm run tests
```
## License
Published under GPL 3.0