Awesome
fastify-traps
<!-- toc --> <!-- tocstop -->A fastify plugin to close the server gracefully on SIGINT and SIGTERM signals.
Install
$ npm i @dnlup/fastify-traps
Usage
Default
const fastify = require('fastify')()
const traps = require('@dnlup/fastify-traps')
fastify.register(traps)
fastify.get('/', (request, reply) => {
reply.send({ ok: true })
})
fastify.listen(3000)
The plugin will use the instance logger to print out some pieces of information like the signal received and if it could close the fastify instance successfully.
Custom close timeout
By default, the plugin will wait 30 seconds for the server to close. After that, it will exit the process with code 1
.
You can change the value of the timeout.
const fastify = require('fastify')()
const traps = require('@dnlup/fastify-traps')
fastify.register(traps, {
timeout: 1000 // wait 1 second before forcing exiting
})
fastify.listen(3000)
Custom hooks
The plugin allows registering custom, synchronous functions to override the default hooks.
The context of a hook is bound to the fastify
instance, so you can use this
to refer to it.
const fastify = require('fastify')()
const traps = require('@dnlup/fastify-traps')
fastify.register(traps, {
onSignal(signal) {
this.log.debug(`Received signal ${signal}`)
},
onClose() {
this.log.info('Server closed')
},
onTimeout(timeout) {
this.log.error(`Forcing close after ${timeout} ms`)
},
onError(error) {
this.log.error(`Uh oh: ${error.message}`)
}
})
fastify.listen(3000)
Plugin options
timeout
<number>
: number of milliseconds to wait for the server to closeonSignal
<function>
: on signal custom hookonClose
<function>
: on signal custom hookonTimeout
<function>
: on signal custom hookonError
<function>
: on signal custom hookstrict
<boolean>
: error if aSIGINT
orSIGTERM
handler is already registered. Default:true
.
As said previously, the hooks' context is bound to the fastify
instance, so you can use this
to refer to it.
onSignal(signal)
signal
<string>
: the signal received
The plugin will call this hook when it received a SIGINT
or SIGTERM
signal.
onClose()
The plugin will call this hook when the server is closed.
onTimeout(timeout)
timeout
<number>
: the number of milliseconds of the timeout
The plugin will call this hook when the timeout for waiting for the server to close has expired.
onError(error)
error
<Error|*>
: the error that occurred while closing the server
The plugin will call this hook when there is an error when closing the server.