Function terminus

lib/terminus.js:164–231

(server, options = {})

}

function terminus (server, options = {}) {
  // Supporting case insensitive routes by lowering case all routes.
  if (options.caseInsensitive && options.healthChecks) {
    const healthChecks = {}

    for (const key in options.healthChecks) {
      healthChecks[key.toLowerCase()] = options.healthChecks[key]
    }

    options.healthChecks = healthChecks
  }

  const {
    signal = 'SIGTERM',
    signals = [],
    useExit0 = false,
    timeout = 1000,
    healthChecks = {},
    sendFailuresDuringShutdown = true,
    onSendFailureDuringShutdown,
    onShutdown = noopResolves,
    beforeShutdown = noopResolves,
    logger = noop,
    caseInsensitive = false,
    statusOk = 200,
    statusOkResponse = { status: 'ok' },
    statusError = 503,
    statusErrorResponse = { status: 'error' },
    headers = options.headers || {}
  } = options
  const onSignal = options.onSignal || options.onSigterm || noopResolves
  const state = Object.assign({}, intialState)

  SUCCESS_RESPONSE = JSON.stringify(statusOkResponse)

  FAILURE_RESPONSE = JSON.stringify(statusErrorResponse)

  if (Object.keys(healthChecks).length > 0) {
    decorateWithHealthCheck(server, state, {
      healthChecks,
      logger,
      sendFailuresDuringShutdown,
      onSendFailureDuringShutdown,
      caseInsensitive,
      statusOk,
      statusOkResponse,
      statusError,
      statusErrorResponse,
      headers
    })
  }

  // push the signal into the array
  // for backwards compatability
  if (!signals.includes(signal)) signals.push(signal)
  decorateWithSignalHandler(server, state, {
    signals,
    useExit0,